Module @sp-api-sdk/fulfillment-inbound-api-v0 - v3.1.1

fulfillment-inbound-api-v0

npm version XO code style

The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.

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/fulfillment-inbound-api-v0
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {FulfillmentInboundApiClient} from '@sp-api-sdk/fulfillment-inbound-api-v0'

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

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

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

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

BarcodeInstruction
BoxContentsSource
CurrencyCode
ErrorReason
LabelPrepType
PrepGuidance
PrepInstruction
PrepOwner
ShipmentStatus

Classes

FbaInboundApi
FulfillmentInboundApiClient

Interfaces

Address
AmazonPrepFeesDetails
Amount
ASINPrepInstructions
BillOfLadingDownloadURL
BoxContentsFeeDetails
FbaInboundApiGetBillOfLadingRequest
FbaInboundApiGetLabelsRequest
FbaInboundApiGetPrepInstructionsRequest
FbaInboundApiGetShipmentItemsByShipmentIdRequest
FbaInboundApiGetShipmentItemsRequest
FbaInboundApiGetShipmentsRequest
GetBillOfLadingResponse
GetLabelsResponse
GetPrepInstructionsResponse
GetPrepInstructionsResult
GetShipmentItemsResponse
GetShipmentItemsResult
GetShipmentsResponse
GetShipmentsResult
InboundShipmentInfo
InboundShipmentItem
InvalidASIN
InvalidSKU
LabelDownloadURL
ModelError
PrepDetails
SKUPrepInstructions

Type Aliases

GetLabelsLabelTypeEnum
GetLabelsPageTypeEnum
GetShipmentItemsQueryTypeEnum
GetShipmentsQueryTypeEnum
GetShipmentsShipmentStatusListEnum

Variables

clientRateLimits
GetLabelsLabelTypeEnum
GetLabelsPageTypeEnum
GetShipmentItemsQueryTypeEnum
GetShipmentsQueryTypeEnum
GetShipmentsShipmentStatusListEnum

Functions

FbaInboundApiAxiosParamCreator
FbaInboundApiFactory
FbaInboundApiFp
MMNEPVFCICPMFPCPTTAAATR