Module @sp-api-sdk/fulfillment-outbound-api-2020-07-01 - v2.8.3

fulfillment-outbound-api-2020-07-01

The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.

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-outbound-api-2020-07-01
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {FulfillmentOutboundApiClient} from '@sp-api-sdk/fulfillment-outbound-api-2020-07-01'

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

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

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

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

AdditionalLocationInfo
CurrentStatus
EventCode
FulfillmentAction
FulfillmentOrderStatus
FulfillmentPolicy
FulfillmentReturnItemStatus
InvalidItemReasonCode
ReturnItemDisposition
ShippingSpeedCategory

Classes

FbaOutboundApi
FulfillmentOutboundApiClient

Interfaces

Address
Amount
CancelFulfillmentOrderResponse
CODSettings
CreateFulfillmentOrderItem
CreateFulfillmentOrderRequest
CreateFulfillmentOrderResponse
CreateFulfillmentReturnRequest
CreateFulfillmentReturnResponse
CreateFulfillmentReturnResult
CreateReturnItem
DateRange
DeliveryDocument
DeliveryInformation
DeliveryMessage
DeliveryOffer
DeliveryPolicy
DeliveryPreferences
DeliveryWindow
Destination
DropOffLocation
FbaOutboundApiCancelFulfillmentOrderRequest
FbaOutboundApiCreateFulfillmentOrderRequest
FbaOutboundApiCreateFulfillmentReturnRequest
FbaOutboundApiDeliveryOffersRequest
FbaOutboundApiGetFeatureInventoryRequest
FbaOutboundApiGetFeatureSKURequest
FbaOutboundApiGetFeaturesRequest
FbaOutboundApiGetFulfillmentOrderRequest
FbaOutboundApiGetFulfillmentPreviewRequest
FbaOutboundApiGetPackageTrackingDetailsRequest
FbaOutboundApiListAllFulfillmentOrdersRequest
FbaOutboundApiListReturnReasonCodesRequest
FbaOutboundApiSubmitFulfillmentOrderStatusUpdateRequest
FbaOutboundApiUpdateFulfillmentOrderRequest
Feature
FeatureSettings
FeatureSku
Fee
FulfillmentOrder
FulfillmentOrderItem
FulfillmentPreview
FulfillmentPreviewItem
FulfillmentPreviewShipment
FulfillmentShipment
FulfillmentShipmentItem
FulfillmentShipmentPackage
GetDeliveryOffersProduct
GetDeliveryOffersRequest
GetDeliveryOffersResponse
GetDeliveryOffersResult
GetDeliveryOffersTerms
GetFeatureInventoryResponse
GetFeatureInventoryResult
GetFeatureSkuResponse
GetFeatureSkuResult
GetFeaturesResponse
GetFeaturesResult
GetFulfillmentOrderResponse
GetFulfillmentOrderResult
GetFulfillmentPreviewItem
GetFulfillmentPreviewRequest
GetFulfillmentPreviewResponse
GetFulfillmentPreviewResult
GetPackageTrackingDetailsResponse
InvalidItemReason
InvalidReturnItem
ListAllFulfillmentOrdersResponse
ListAllFulfillmentOrdersResult
ListReturnReasonCodesResponse
ListReturnReasonCodesResult
LockerDetails
ModelError
Money
Origin
PackageTrackingDetails
PaymentInformation
ProductIdentifier
ReasonCodeDetails
ReturnAuthorization
ReturnItem
ScheduledDeliveryInfo
SubmitFulfillmentOrderStatusUpdateRequest
SubmitFulfillmentOrderStatusUpdateResponse
TrackingAddress
TrackingEvent
UnfulfillablePreviewItem
UpdateFulfillmentOrderItem
UpdateFulfillmentOrderRequest
UpdateFulfillmentOrderResponse
VariablePrecisionAddress
Weight

Type Aliases

AmountUnitOfMeasureEnum
DropOffLocationTypeEnum
FeatureSettingsFeatureFulfillmentPolicyEnum
FeeNameEnum
FulfillmentPreviewItemShippingWeightCalculationMethodEnum
FulfillmentShipmentFulfillmentShipmentStatusEnum
WeightUnitEnum

Variables

AmountUnitOfMeasureEnum
clientRateLimits
DropOffLocationTypeEnum
FeatureSettingsFeatureFulfillmentPolicyEnum
FeeNameEnum
FulfillmentPreviewItemShippingWeightCalculationMethodEnum
FulfillmentShipmentFulfillmentShipmentStatusEnum
WeightUnitEnum

Functions

FbaOutboundApiAxiosParamCreator
FbaOutboundApiFactory
FbaOutboundApiFp