Module @sp-api-sdk/vendor-orders-api-v1 - v2.5.3

vendor-orders-api-v1

The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.

npm version XO code style

Learn more about this Selling Partner API by visiting the official documentation.

Also, see the generated documentation for this API client.

npm install @sp-api-sdk/vendor-orders-api-v1
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {VendorOrdersApiClient} from '@sp-api-sdk/vendor-orders-api-v1'

const auth = new SellingPartnerApiAuth({
clientId: process.env.LWA_CLIENT_ID,
clientSecret: process.env.LWA_CLIENT_SECRET,
refreshToken: 'Atzr|…',
})

const client = new VendorOrdersApiClient({
auth,
region: 'eu',
})

In order to retry rate limited requests (HTTP 429), you can configure the API client as such:

const client = new VendorOrdersApiClient({
auth,
region: 'eu',
rateLimiting: {
retry: true,
// Optionally specify a callback that will be called on every retry.
onRetry: (retryInfo) => {
console.log(retryInfo)
},
},
})

The rate limits used for each route are specified in the API documentation.

You can enable logging for both SP-API requests and responses by configuring the logging.request and logging.response properties.

const client = new VendorOrdersApiClient({
auth,
region: 'eu',
logging: {
request: {
logger: console.debug
},
response: {
logger: console.debug
},
error: true,
},
})

Specifying true will use the default options, specifying an object will allow you to override the default options.
This uses axios-logger under the hood.
By default, if enabled, the request and response loggers will use console.info and the error logger will use console.error.

MIT

    ╚⊙ ⊙╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝

Classes

VendorOrdersApi
VendorOrdersApiClient

Interfaces

AcknowledgementStatusDetails
Address
GetPurchaseOrderResponse
GetPurchaseOrdersResponse
GetPurchaseOrdersStatusResponse
ImportDetails
ItemQuantity
ModelError
Money
Order
OrderAcknowledgement
OrderAcknowledgementItem
OrderDetails
OrderedQuantityDetails
OrderItem
OrderItemAcknowledgement
OrderItemStatus
OrderItemStatusAcknowledgementStatus
OrderItemStatusOrderedQuantity
OrderItemStatusReceivingStatus
OrderList
OrderListStatus
OrderStatus
Pagination
PartyIdentification
SubmitAcknowledgementRequest
SubmitAcknowledgementResponse
TaxRegistrationDetails
TransactionId
VendorOrdersApiGetPurchaseOrderRequest
VendorOrdersApiGetPurchaseOrdersRequest
VendorOrdersApiGetPurchaseOrdersStatusRequest
VendorOrdersApiSubmitAcknowledgementRequest

Type Aliases

GetPurchaseOrdersPoItemStateEnum
GetPurchaseOrdersPurchaseOrderStateEnum
GetPurchaseOrdersSortOrderEnum
GetPurchaseOrdersStatusItemConfirmationStatusEnum
GetPurchaseOrdersStatusItemReceiveStatusEnum
GetPurchaseOrdersStatusPurchaseOrderStatusEnum
GetPurchaseOrdersStatusSortOrderEnum
ImportDetailsInternationalCommercialTermsEnum
ImportDetailsMethodOfPaymentEnum
ItemQuantityUnitOfMeasureEnum
MoneyUnitOfMeasureEnum
OrderDetailsPaymentMethodEnum
OrderDetailsPurchaseOrderTypeEnum
OrderItemAcknowledgementAcknowledgementCodeEnum
OrderItemAcknowledgementRejectionReasonEnum
OrderItemStatusAcknowledgementStatusConfirmationStatusEnum
OrderItemStatusReceivingStatusReceiveStatusEnum
OrderPurchaseOrderStateEnum
OrderStatusPurchaseOrderStatusEnum
TaxRegistrationDetailsTaxRegistrationTypeEnum

Variables

clientRateLimits
GetPurchaseOrdersPoItemStateEnum
GetPurchaseOrdersPurchaseOrderStateEnum
GetPurchaseOrdersSortOrderEnum
GetPurchaseOrdersStatusItemConfirmationStatusEnum
GetPurchaseOrdersStatusItemReceiveStatusEnum
GetPurchaseOrdersStatusPurchaseOrderStatusEnum
GetPurchaseOrdersStatusSortOrderEnum
ImportDetailsInternationalCommercialTermsEnum
ImportDetailsMethodOfPaymentEnum
ItemQuantityUnitOfMeasureEnum
MoneyUnitOfMeasureEnum
OrderDetailsPaymentMethodEnum
OrderDetailsPurchaseOrderTypeEnum
OrderItemAcknowledgementAcknowledgementCodeEnum
OrderItemAcknowledgementRejectionReasonEnum
OrderItemStatusAcknowledgementStatusConfirmationStatusEnum
OrderItemStatusReceivingStatusReceiveStatusEnum
OrderPurchaseOrderStateEnum
OrderStatusPurchaseOrderStatusEnum
TaxRegistrationDetailsTaxRegistrationTypeEnum

Functions

VendorOrdersApiAxiosParamCreator
VendorOrdersApiFactory
VendorOrdersApiFp