Module @sp-api-sdk/fulfillment-inbound-api-v0 - v2.6.3

fulfillment-inbound-api-v0

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

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/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
Condition
CurrencyCode
ErrorReason
GuidanceReason
InboundGuidance
IntendedBoxContentsSource
LabelPrepPreference
LabelPrepType
PackageStatus
PrepGuidance
PrepInstruction
PrepOwner
SellerFreightClass
ShipmentStatus
ShipmentType
TransportStatus
UnitOfMeasurement
UnitOfWeight

Classes

FbaInboundApi
FulfillmentInboundApiClient

Interfaces

Address
AmazonPrepFeesDetails
Amount
ASINInboundGuidance
ASINPrepInstructions
BillOfLadingDownloadURL
BoxContentsFeeDetails
CommonTransportResult
ConfirmPreorderResponse
ConfirmPreorderResult
ConfirmTransportResponse
Contact
CreateInboundShipmentPlanRequest
CreateInboundShipmentPlanResponse
CreateInboundShipmentPlanResult
Dimensions
EstimateTransportResponse
FbaInboundApiConfirmPreorderRequest
FbaInboundApiConfirmTransportRequest
FbaInboundApiCreateInboundShipmentPlanRequest
FbaInboundApiCreateInboundShipmentRequest
FbaInboundApiEstimateTransportRequest
FbaInboundApiGetBillOfLadingRequest
FbaInboundApiGetLabelsRequest
FbaInboundApiGetPreorderInfoRequest
FbaInboundApiGetPrepInstructionsRequest
FbaInboundApiGetShipmentItemsByShipmentIdRequest
FbaInboundApiGetShipmentItemsRequest
FbaInboundApiGetShipmentsRequest
FbaInboundApiGetTransportDetailsRequest
FbaInboundApiPutTransportDetailsRequest
FbaInboundApiUpdateInboundShipmentRequest
FbaInboundApiVoidTransportRequest
GetBillOfLadingResponse
GetInboundGuidanceResult
GetLabelsResponse
GetPreorderInfoResponse
GetPreorderInfoResult
GetPrepInstructionsResponse
GetPrepInstructionsResult
GetShipmentItemsResponse
GetShipmentItemsResult
GetShipmentsResponse
GetShipmentsResult
GetTransportDetailsResponse
GetTransportDetailsResult
InboundShipmentHeader
InboundShipmentInfo
InboundShipmentItem
InboundShipmentPlan
InboundShipmentPlanItem
InboundShipmentPlanRequestItem
InboundShipmentRequest
InboundShipmentResponse
InboundShipmentResult
InvalidASIN
InvalidSKU
LabelDownloadURL
ModelError
NonPartneredLtlDataInput
NonPartneredLtlDataOutput
NonPartneredSmallParcelDataInput
NonPartneredSmallParcelDataOutput
NonPartneredSmallParcelPackageInput
NonPartneredSmallParcelPackageOutput
Pallet
PartneredEstimate
PartneredLtlDataInput
PartneredLtlDataOutput
PartneredSmallParcelDataInput
PartneredSmallParcelDataOutput
PartneredSmallParcelPackageInput
PartneredSmallParcelPackageOutput
PrepDetails
PutTransportDetailsRequest
PutTransportDetailsResponse
SKUInboundGuidance
SKUPrepInstructions
TransportContent
TransportDetailInput
TransportDetailOutput
TransportHeader
TransportResult
VoidTransportResponse
Weight

Type Aliases

GetLabelsLabelTypeEnum
GetLabelsPageTypeEnum
GetShipmentItemsQueryTypeEnum
GetShipmentsQueryTypeEnum
GetShipmentsShipmentStatusListEnum

Variables

clientRateLimits
GetLabelsLabelTypeEnum
GetLabelsPageTypeEnum
GetShipmentItemsQueryTypeEnum
GetShipmentsQueryTypeEnum
GetShipmentsShipmentStatusListEnum

Functions

FbaInboundApiAxiosParamCreator
FbaInboundApiFactory
FbaInboundApiFp