Module @sp-api-sdk/amazon-warehousing-and-distribution-2024-05-09 - v1.5.5

amazon-warehousing-and-distribution-2024-05-09

The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.

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/amazon-warehousing-and-distribution-2024-05-09
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {AmazonWarehousingAndDistributionClient} from '@sp-api-sdk/amazon-warehousing-and-distribution-2024-05-09'

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

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

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

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

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

Enumerations

CarrierCodeType
DimensionUnitOfMeasurement
DistributionPackageType
InboundShipmentStatus
InventoryDetailsVisibility
InventoryUnitOfMeasurement
ShipmentSortableField
SkuQuantitiesVisibility
SortOrder
VolumeUnitOfMeasurement
WeightUnitOfMeasurement

Classes

AmazonWarehousingAndDistributionClient
AwdApi

Interfaces

Address
AwdApiGetInboundShipmentRequest
AwdApiListInboundShipmentsRequest
AwdApiListInventoryRequest
CarrierCode
DistributionPackage
DistributionPackageContents
DistributionPackageQuantity
ErrorList
InboundShipment
InboundShipmentSummary
InventoryDetails
InventoryListing
InventoryQuantity
InventorySummary
MeasurementData
ModelError
PackageDimensions
PackageVolume
PackageWeight
ProductAttribute
ProductQuantity
ShipmentListing
SkuQuantity

Type Aliases

GetInboundShipmentSkuQuantitiesEnum
ListInboundShipmentsShipmentStatusEnum
ListInboundShipmentsSortByEnum
ListInboundShipmentsSortOrderEnum
ListInventoryDetailsEnum
ListInventorySortOrderEnum

Variables

clientRateLimits
GetInboundShipmentSkuQuantitiesEnum
ListInboundShipmentsShipmentStatusEnum
ListInboundShipmentsSortByEnum
ListInboundShipmentsSortOrderEnum
ListInventoryDetailsEnum
ListInventorySortOrderEnum

Functions

AwdApiAxiosParamCreator
AwdApiFactory
AwdApiFp