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

    Module @sp-api-sdk/vendor-direct-fulfillment-shipping-api-2021-12-28 - v5.0.6

    vendor-direct-fulfillment-shipping-api-2021-12-28

    npm version XO code style

    Use the Selling Partner API for Direct Fulfillment Shipping to access a direct fulfillment vendor's shipping data.

    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/vendor-direct-fulfillment-shipping-api-2021-12-28
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {VendorDirectFulfillmentShippingApiClient} from '@sp-api-sdk/vendor-direct-fulfillment-shipping-api-2021-12-28'

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

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

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

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

    VendorDirectFulfillmentShippingApi
    VendorDirectFulfillmentShippingApiClient

    Interfaces

    Address
    Container
    ContainerLabel
    CreateContainerLabelRequest
    CreateContainerLabelResponse
    CreateShippingLabelsRequest
    CustomerInvoice
    CustomerInvoiceList
    Dimensions
    ErrorList
    Item
    ItemQuantity
    LabelData
    ModelError
    Package
    PackedItem
    PackingSlip
    PackingSlipList
    Pagination
    PartyIdentification
    ShipmentConfirmation
    ShipmentDetails
    ShipmentSchedule
    ShipmentStatusUpdate
    ShippingLabel
    ShippingLabelList
    ShippingLabelRequest
    StatusUpdateDetails
    SubmitShipmentConfirmationsRequest
    SubmitShipmentStatusUpdatesRequest
    SubmitShippingLabelsRequest
    TaxRegistrationDetails
    TransactionReference
    VendorDirectFulfillmentShippingApiCreateContainerLabelRequest
    VendorDirectFulfillmentShippingApiCreateShippingLabelsRequest
    VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest
    VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest
    VendorDirectFulfillmentShippingApiGetPackingSlipRequest
    VendorDirectFulfillmentShippingApiGetPackingSlipsRequest
    VendorDirectFulfillmentShippingApiGetShippingLabelRequest
    VendorDirectFulfillmentShippingApiGetShippingLabelsRequest
    VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest
    VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest
    VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest
    Weight

    Type Aliases

    CarrierId
    ContainerContainerTypeEnum
    ContainerLabelFormat
    DimensionsUnitOfMeasureEnum
    GetCustomerInvoicesSortOrderEnum
    GetPackingSlipsSortOrderEnum
    GetShippingLabelsSortOrderEnum
    PackingSlipContentTypeEnum
    ShipmentDetailsShipmentStatusEnum
    ShippingLabelLabelFormatEnum
    TaxRegistrationDetailsTaxRegistrationTypeEnum
    WeightUnitOfMeasureEnum

    Variables

    CarrierId
    clientRateLimits
    ContainerContainerTypeEnum
    ContainerLabelFormat
    DimensionsUnitOfMeasureEnum
    GetCustomerInvoicesSortOrderEnum
    GetPackingSlipsSortOrderEnum
    GetShippingLabelsSortOrderEnum
    PackingSlipContentTypeEnum
    ShipmentDetailsShipmentStatusEnum
    ShippingLabelLabelFormatEnum
    TaxRegistrationDetailsTaxRegistrationTypeEnum
    WeightUnitOfMeasureEnum

    Functions

    VendorDirectFulfillmentShippingApiAxiosParamCreator
    VendorDirectFulfillmentShippingApiFactory
    VendorDirectFulfillmentShippingApiFp