Selling Partner API SDK for JavaScript
    Preparing search index...

    Module @sp-api-sdk/amazon-warehousing-and-distribution-api-2024-05-09 - v4.0.6

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

    npm version XO code style

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

    Bizon

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

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

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

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

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

    AmazonWarehousingAndDistributionApi
    AmazonWarehousingAndDistributionApiClient

    Interfaces

    Address
    AmazonWarehousingAndDistributionApiCancelInboundRequest
    AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest
    AmazonWarehousingAndDistributionApiConfirmInboundRequest
    AmazonWarehousingAndDistributionApiCreateInboundRequest
    AmazonWarehousingAndDistributionApiGetInboundRequest
    AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest
    AmazonWarehousingAndDistributionApiGetInboundShipmentRequest
    AmazonWarehousingAndDistributionApiListInboundShipmentsRequest
    AmazonWarehousingAndDistributionApiListInventoryRequest
    AmazonWarehousingAndDistributionApiUpdateInboundRequest
    AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest
    CarrierCode
    DestinationDetails
    DistributionPackage
    DistributionPackageContents
    DistributionPackageQuantity
    ErrorList
    ExpirationDetails
    InboundEligibility
    InboundOrder
    InboundOrderCreationData
    InboundOrderReference
    InboundPackages
    InboundPreferences
    InboundShipment
    InboundShipmentSummary
    InventoryDetails
    InventoryListing
    InventoryQuantity
    InventorySummary
    MeasurementData
    ModelError
    OrderIneligibilityReason
    PackageDimensions
    PackageVolume
    PackageWeight
    PrepDetails
    PrepInstruction
    ProductAttribute
    ProductQuantity
    ShipmentLabels
    ShipmentListing
    SkuEligibility
    SkuIneligibilityReason
    SkuQuantity
    TrackingDetails
    TransportationDetails

    Type Aliases

    CarrierCodeType
    DimensionUnitOfMeasurement
    DistributionPackageType
    GetInboundShipmentLabelsFormatTypeEnum
    GetInboundShipmentLabelsPageTypeEnum
    GetInboundShipmentSkuQuantitiesEnum
    InboundEligibilityStatus
    InboundShipmentStatus
    InboundStatus
    InventoryUnitOfMeasurement
    LabelOwner
    LabelStatus
    ListInboundShipmentsShipmentStatusEnum
    ListInboundShipmentsSortByEnum
    ListInboundShipmentsSortOrderEnum
    ListInventoryDetailsEnum
    ListInventorySortOrderEnum
    PrepCategory
    PrepOwner
    VolumeUnitOfMeasurement
    WeightUnitOfMeasurement

    Variables

    CarrierCodeType
    clientRateLimits
    DimensionUnitOfMeasurement
    DistributionPackageType
    GetInboundShipmentLabelsFormatTypeEnum
    GetInboundShipmentLabelsPageTypeEnum
    GetInboundShipmentSkuQuantitiesEnum
    InboundEligibilityStatus
    InboundShipmentStatus
    InboundStatus
    InventoryUnitOfMeasurement
    LabelOwner
    LabelStatus
    ListInboundShipmentsShipmentStatusEnum
    ListInboundShipmentsSortByEnum
    ListInboundShipmentsSortOrderEnum
    ListInventoryDetailsEnum
    ListInventorySortOrderEnum
    PrepCategory
    PrepOwner
    VolumeUnitOfMeasurement
    WeightUnitOfMeasurement

    Functions

    AmazonWarehousingAndDistributionApiAxiosParamCreator
    AmazonWarehousingAndDistributionApiFactory
    AmazonWarehousingAndDistributionApiFp