@sp-api-sdk/fulfillment-outbound-api-2020-07-01
Version:
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 fulfill
101 lines (75 loc) • 3.39 kB
Markdown
# `@sp-api-sdk/fulfillment-outbound-api-2020-07-01`
[](https://www.npmjs.com/package/@sp-api-sdk/fulfillment-outbound-api-2020-07-01)
[](https://github.com/xojs/xo)
> **Note:** Sandbox-only operations, unavailable in production: `submitFulfillmentOrderStatusUpdate`. Refer to the [Selling Partner API sandbox](https://developer-docs.amazon/sp-api/docs/sp-api-sandbox) documentation for more information.
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.
[<img src="https://files.bizon.solutions/images/logo/bizon-horizontal.png" alt="Bizon" width="250"/>](https://www.bizon.solutions?utm_source=github&utm_medium=readme&utm_campaign=selling-partner-api-sdk)
## Documentation
Learn more about this Selling Partner API by visiting the [official documentation](https://developer-docs.amazon/sp-api/docs/welcome).
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp-api-sdk_fulfillment-outbound-api-2020-07-01.html) for this API client.
## Installing
```sh
npm install @sp-api-sdk/fulfillment-outbound-api-2020-07-01
```
## Getting Started
```javascript
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
import {FulfillmentOutboundApiClient} from '@sp-api-sdk/fulfillment-outbound-api-2020-07-01'
// `clientId` and `clientSecret` default to the `LWA_CLIENT_ID` and
// `LWA_CLIENT_SECRET` environment variables.
const auth = new SellingPartnerApiAuth({
refreshToken: await getRefreshTokenForSeller(sellerId),
})
const client = new FulfillmentOutboundApiClient({
auth,
region: 'eu',
})
```
## Rate Limiting
In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
```javascript
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](https://developer-docs.amazon/sp-api/docs/welcome).
## Logging
You can enable logging for both SP-API requests and responses by configuring the `logging.request` and `logging.response` properties.
```javascript
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](https://github.com/hg-pyun/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`.
## License
MIT
## Miscellaneous
```text
╚⊙ ⊙╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
```