Module @sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 - v2.7.3

vendor-direct-fulfillment-orders-api-v1

The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order 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-direct-fulfillment-orders-api-v1
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {VendorDirectFulfillmentOrdersApiClient} from '@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1'

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

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

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

const client = new VendorDirectFulfillmentOrdersApiClient({
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 VendorDirectFulfillmentOrdersApiClient({
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

VendorDirectFulfillmentOrdersApiClient
VendorOrdersApi

Interfaces

AcknowledgementStatus
Address
GetOrderResponse
GetOrdersResponse
GiftDetails
ItemQuantity
ModelError
Money
Order
OrderAcknowledgementItem
OrderDetails
OrderDetailsTaxTotal
OrderItem
OrderItemAcknowledgement
OrderItemTaxDetails
OrderList
Pagination
PartyIdentification
ScheduledDeliveryShipment
ShipmentDates
ShipmentDetails
SubmitAcknowledgementRequest
SubmitAcknowledgementResponse
TaxDetails
TaxRegistrationDetails
TransactionId
VendorOrdersApiGetOrderRequest
VendorOrdersApiGetOrdersRequest
VendorOrdersApiSubmitAcknowledgementRequest

Type Aliases

GetOrdersSortOrderEnum
GetOrdersStatusEnum
ItemQuantityUnitOfMeasureEnum
OrderDetailsOrderStatusEnum
TaxDetailsTypeEnum
TaxRegistrationDetailsTaxRegistrationTypeEnum

Variables

clientRateLimits
GetOrdersSortOrderEnum
GetOrdersStatusEnum
ItemQuantityUnitOfMeasureEnum
OrderDetailsOrderStatusEnum
TaxDetailsTypeEnum
TaxRegistrationDetailsTaxRegistrationTypeEnum

Functions

VendorOrdersApiAxiosParamCreator
VendorOrdersApiFactory
VendorOrdersApiFp