Module @sp-api-sdk/merchant-fulfillment-api-v0 - v2.7.3

merchant-fulfillment-api-v0

With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon's Buy Shipping Services.

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

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

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

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

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

CarrierWillPickUpOption
DeliveryExperienceOption
DeliveryExperienceType
FileType
HazmatType
InputTargetType
LabelFormat
PredefinedPackageDimensions
ShipmentStatus
StandardIdForLabel
UnitOfLength
UnitOfWeight

Classes

MerchantFulfillmentApi
MerchantFulfillmentApiClient

Interfaces

AdditionalInputs
AdditionalSellerInput
AdditionalSellerInputs
Address
AvailableCarrierWillPickUpOption
AvailableDeliveryExperienceOption
AvailableShippingServiceOptions
Benefits
CancelShipmentResponse
Constraint
CreateShipmentRequest
CreateShipmentResponse
CurrencyAmount
DangerousGoodsDetails
ExcludedBenefit
FileContents
GetAdditionalSellerInputsRequest
GetAdditionalSellerInputsResponse
GetAdditionalSellerInputsResult
GetEligibleShipmentServicesRequest
GetEligibleShipmentServicesResponse
GetEligibleShipmentServicesResult
GetShipmentResponse
Item
ItemLevelFields
Label
LabelCustomization
LabelDimensions
LabelFormatOption
LabelFormatOptionRequest
Length
LiquidVolume
MerchantFulfillmentApiCancelShipmentRequest
MerchantFulfillmentApiCreateShipmentRequest
MerchantFulfillmentApiGetAdditionalSellerInputsRequest
MerchantFulfillmentApiGetEligibleShipmentServicesRequest
MerchantFulfillmentApiGetShipmentRequest
ModelError
PackageDimensions
RejectedShippingService
SellerInputDefinition
Shipment
ShipmentRequestDetails
ShippingOfferingFilter
ShippingService
ShippingServiceOptions
TemporarilyUnavailableCarrier
TermsAndConditionsNotAcceptedCarrier
Weight

Type Aliases

DangerousGoodsDetailsPackingGroupEnum
DangerousGoodsDetailsPackingInstructionEnum
LiquidVolumeUnitEnum

Variables

clientRateLimits
DangerousGoodsDetailsPackingGroupEnum
DangerousGoodsDetailsPackingInstructionEnum
LiquidVolumeUnitEnum

Functions

MerchantFulfillmentApiAxiosParamCreator
MerchantFulfillmentApiFactory
MerchantFulfillmentApiFp