@sp-api-sdk/fulfillment-outbound-api-2020-07-01 3.1.1 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/{fba-outbound-api.js → fulfillment-outbound-api.js} +86 -86
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{fba-outbound-api.js → fulfillment-outbound-api.js} +81 -81
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{fba-outbound-api.d.ts → fulfillment-outbound-api.d.ts} +147 -147
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +4 -4
|
@@ -34,10 +34,10 @@ import type { SubmitFulfillmentOrderStatusUpdateResponse } from '../models';
|
|
|
34
34
|
import type { UpdateFulfillmentOrderRequest } from '../models';
|
|
35
35
|
import type { UpdateFulfillmentOrderResponse } from '../models';
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* FulfillmentOutboundApi - axios parameter creator
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
|
-
export declare const
|
|
40
|
+
export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
41
41
|
/**
|
|
42
42
|
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
43
43
|
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
@@ -150,10 +150,10 @@ export declare const FbaOutboundApiAxiosParamCreator: (configuration?: Configura
|
|
|
150
150
|
updateFulfillmentOrder: (sellerFulfillmentOrderId: string, body: UpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
151
151
|
};
|
|
152
152
|
/**
|
|
153
|
-
*
|
|
153
|
+
* FulfillmentOutboundApi - functional programming interface
|
|
154
154
|
* @export
|
|
155
155
|
*/
|
|
156
|
-
export declare const
|
|
156
|
+
export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) => {
|
|
157
157
|
/**
|
|
158
158
|
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
159
159
|
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
@@ -266,480 +266,480 @@ export declare const FbaOutboundApiFp: (configuration?: Configuration) => {
|
|
|
266
266
|
updateFulfillmentOrder(sellerFulfillmentOrderId: string, body: UpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFulfillmentOrderResponse>>;
|
|
267
267
|
};
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* FulfillmentOutboundApi - factory interface
|
|
270
270
|
* @export
|
|
271
271
|
*/
|
|
272
|
-
export declare const
|
|
272
|
+
export declare const FulfillmentOutboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
273
273
|
/**
|
|
274
274
|
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
275
|
-
* @param {
|
|
275
|
+
* @param {FulfillmentOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters.
|
|
276
276
|
* @param {*} [options] Override http request option.
|
|
277
277
|
* @throws {RequiredError}
|
|
278
278
|
*/
|
|
279
|
-
cancelFulfillmentOrder(requestParameters:
|
|
279
|
+
cancelFulfillmentOrder(requestParameters: FulfillmentOutboundApiCancelFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelFulfillmentOrderResponse>;
|
|
280
280
|
/**
|
|
281
281
|
* Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
282
|
-
* @param {
|
|
282
|
+
* @param {FulfillmentOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
283
283
|
* @param {*} [options] Override http request option.
|
|
284
284
|
* @throws {RequiredError}
|
|
285
285
|
*/
|
|
286
|
-
createFulfillmentOrder(requestParameters:
|
|
286
|
+
createFulfillmentOrder(requestParameters: FulfillmentOutboundApiCreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFulfillmentOrderResponse>;
|
|
287
287
|
/**
|
|
288
288
|
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
289
|
-
* @param {
|
|
289
|
+
* @param {FulfillmentOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
|
|
290
290
|
* @param {*} [options] Override http request option.
|
|
291
291
|
* @throws {RequiredError}
|
|
292
292
|
*/
|
|
293
|
-
createFulfillmentReturn(requestParameters:
|
|
293
|
+
createFulfillmentReturn(requestParameters: FulfillmentOutboundApiCreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFulfillmentReturnResponse>;
|
|
294
294
|
/**
|
|
295
295
|
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
296
|
-
* @param {
|
|
296
|
+
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
|
|
297
297
|
* @param {*} [options] Override http request option.
|
|
298
298
|
* @throws {RequiredError}
|
|
299
299
|
*/
|
|
300
|
-
deliveryOffers(requestParameters:
|
|
300
|
+
deliveryOffers(requestParameters: FulfillmentOutboundApiDeliveryOffersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryOffersResponse>;
|
|
301
301
|
/**
|
|
302
302
|
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
|
|
303
|
-
* @param {
|
|
303
|
+
* @param {FulfillmentOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
|
|
304
304
|
* @param {*} [options] Override http request option.
|
|
305
305
|
* @throws {RequiredError}
|
|
306
306
|
*/
|
|
307
|
-
getFeatureInventory(requestParameters:
|
|
307
|
+
getFeatureInventory(requestParameters: FulfillmentOutboundApiGetFeatureInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeatureInventoryResponse>;
|
|
308
308
|
/**
|
|
309
309
|
* Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
310
|
-
* @param {
|
|
310
|
+
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
|
|
311
311
|
* @param {*} [options] Override http request option.
|
|
312
312
|
* @throws {RequiredError}
|
|
313
313
|
*/
|
|
314
|
-
getFeatureSKU(requestParameters:
|
|
314
|
+
getFeatureSKU(requestParameters: FulfillmentOutboundApiGetFeatureSKURequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeatureSkuResponse>;
|
|
315
315
|
/**
|
|
316
316
|
* Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
317
|
-
* @param {
|
|
317
|
+
* @param {FulfillmentOutboundApiGetFeaturesRequest} requestParameters Request parameters.
|
|
318
318
|
* @param {*} [options] Override http request option.
|
|
319
319
|
* @throws {RequiredError}
|
|
320
320
|
*/
|
|
321
|
-
getFeatures(requestParameters:
|
|
321
|
+
getFeatures(requestParameters: FulfillmentOutboundApiGetFeaturesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeaturesResponse>;
|
|
322
322
|
/**
|
|
323
323
|
* Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
324
|
-
* @param {
|
|
324
|
+
* @param {FulfillmentOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
|
|
325
325
|
* @param {*} [options] Override http request option.
|
|
326
326
|
* @throws {RequiredError}
|
|
327
327
|
*/
|
|
328
|
-
getFulfillmentOrder(requestParameters:
|
|
328
|
+
getFulfillmentOrder(requestParameters: FulfillmentOutboundApiGetFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFulfillmentOrderResponse>;
|
|
329
329
|
/**
|
|
330
330
|
* Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
331
|
-
* @param {
|
|
331
|
+
* @param {FulfillmentOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
|
|
332
332
|
* @param {*} [options] Override http request option.
|
|
333
333
|
* @throws {RequiredError}
|
|
334
334
|
*/
|
|
335
|
-
getFulfillmentPreview(requestParameters:
|
|
335
|
+
getFulfillmentPreview(requestParameters: FulfillmentOutboundApiGetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFulfillmentPreviewResponse>;
|
|
336
336
|
/**
|
|
337
337
|
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
338
|
-
* @param {
|
|
338
|
+
* @param {FulfillmentOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
|
|
339
339
|
* @param {*} [options] Override http request option.
|
|
340
340
|
* @throws {RequiredError}
|
|
341
341
|
*/
|
|
342
|
-
getPackageTrackingDetails(requestParameters:
|
|
342
|
+
getPackageTrackingDetails(requestParameters: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackageTrackingDetailsResponse>;
|
|
343
343
|
/**
|
|
344
344
|
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
345
|
-
* @param {
|
|
345
|
+
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
|
|
346
346
|
* @param {*} [options] Override http request option.
|
|
347
347
|
* @throws {RequiredError}
|
|
348
348
|
*/
|
|
349
|
-
listAllFulfillmentOrders(requestParameters?:
|
|
349
|
+
listAllFulfillmentOrders(requestParameters?: FulfillmentOutboundApiListAllFulfillmentOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListAllFulfillmentOrdersResponse>;
|
|
350
350
|
/**
|
|
351
351
|
* Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
352
|
-
* @param {
|
|
352
|
+
* @param {FulfillmentOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
|
|
353
353
|
* @param {*} [options] Override http request option.
|
|
354
354
|
* @throws {RequiredError}
|
|
355
355
|
*/
|
|
356
|
-
listReturnReasonCodes(requestParameters:
|
|
356
|
+
listReturnReasonCodes(requestParameters: FulfillmentOutboundApiListReturnReasonCodesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListReturnReasonCodesResponse>;
|
|
357
357
|
/**
|
|
358
358
|
* Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
|
|
359
|
-
* @param {
|
|
359
|
+
* @param {FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest} requestParameters Request parameters.
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
362
362
|
*/
|
|
363
|
-
submitFulfillmentOrderStatusUpdate(requestParameters:
|
|
363
|
+
submitFulfillmentOrderStatusUpdate(requestParameters: FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>;
|
|
364
364
|
/**
|
|
365
365
|
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
366
|
-
* @param {
|
|
366
|
+
* @param {FulfillmentOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
367
367
|
* @param {*} [options] Override http request option.
|
|
368
368
|
* @throws {RequiredError}
|
|
369
369
|
*/
|
|
370
|
-
updateFulfillmentOrder(requestParameters:
|
|
370
|
+
updateFulfillmentOrder(requestParameters: FulfillmentOutboundApiUpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateFulfillmentOrderResponse>;
|
|
371
371
|
};
|
|
372
372
|
/**
|
|
373
|
-
* Request parameters for cancelFulfillmentOrder operation in
|
|
373
|
+
* Request parameters for cancelFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
374
374
|
* @export
|
|
375
|
-
* @interface
|
|
375
|
+
* @interface FulfillmentOutboundApiCancelFulfillmentOrderRequest
|
|
376
376
|
*/
|
|
377
|
-
export interface
|
|
377
|
+
export interface FulfillmentOutboundApiCancelFulfillmentOrderRequest {
|
|
378
378
|
/**
|
|
379
379
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
380
380
|
* @type {string}
|
|
381
|
-
* @memberof
|
|
381
|
+
* @memberof FulfillmentOutboundApiCancelFulfillmentOrder
|
|
382
382
|
*/
|
|
383
383
|
readonly sellerFulfillmentOrderId: string;
|
|
384
384
|
}
|
|
385
385
|
/**
|
|
386
|
-
* Request parameters for createFulfillmentOrder operation in
|
|
386
|
+
* Request parameters for createFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
387
387
|
* @export
|
|
388
|
-
* @interface
|
|
388
|
+
* @interface FulfillmentOutboundApiCreateFulfillmentOrderRequest
|
|
389
389
|
*/
|
|
390
|
-
export interface
|
|
390
|
+
export interface FulfillmentOutboundApiCreateFulfillmentOrderRequest {
|
|
391
391
|
/**
|
|
392
392
|
* CreateFulfillmentOrderRequest parameter
|
|
393
393
|
* @type {CreateFulfillmentOrderRequest}
|
|
394
|
-
* @memberof
|
|
394
|
+
* @memberof FulfillmentOutboundApiCreateFulfillmentOrder
|
|
395
395
|
*/
|
|
396
396
|
readonly body: CreateFulfillmentOrderRequest;
|
|
397
397
|
}
|
|
398
398
|
/**
|
|
399
|
-
* Request parameters for createFulfillmentReturn operation in
|
|
399
|
+
* Request parameters for createFulfillmentReturn operation in FulfillmentOutboundApi.
|
|
400
400
|
* @export
|
|
401
|
-
* @interface
|
|
401
|
+
* @interface FulfillmentOutboundApiCreateFulfillmentReturnRequest
|
|
402
402
|
*/
|
|
403
|
-
export interface
|
|
403
|
+
export interface FulfillmentOutboundApiCreateFulfillmentReturnRequest {
|
|
404
404
|
/**
|
|
405
405
|
* An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items.
|
|
406
406
|
* @type {string}
|
|
407
|
-
* @memberof
|
|
407
|
+
* @memberof FulfillmentOutboundApiCreateFulfillmentReturn
|
|
408
408
|
*/
|
|
409
409
|
readonly sellerFulfillmentOrderId: string;
|
|
410
410
|
/**
|
|
411
411
|
* CreateFulfillmentReturnRequest parameter
|
|
412
412
|
* @type {CreateFulfillmentReturnRequest}
|
|
413
|
-
* @memberof
|
|
413
|
+
* @memberof FulfillmentOutboundApiCreateFulfillmentReturn
|
|
414
414
|
*/
|
|
415
415
|
readonly body: CreateFulfillmentReturnRequest;
|
|
416
416
|
}
|
|
417
417
|
/**
|
|
418
|
-
* Request parameters for deliveryOffers operation in
|
|
418
|
+
* Request parameters for deliveryOffers operation in FulfillmentOutboundApi.
|
|
419
419
|
* @export
|
|
420
|
-
* @interface
|
|
420
|
+
* @interface FulfillmentOutboundApiDeliveryOffersRequest
|
|
421
421
|
*/
|
|
422
|
-
export interface
|
|
422
|
+
export interface FulfillmentOutboundApiDeliveryOffersRequest {
|
|
423
423
|
/**
|
|
424
424
|
* GetDeliveryOffersRequest parameter
|
|
425
425
|
* @type {GetDeliveryOffersRequest}
|
|
426
|
-
* @memberof
|
|
426
|
+
* @memberof FulfillmentOutboundApiDeliveryOffers
|
|
427
427
|
*/
|
|
428
428
|
readonly body: GetDeliveryOffersRequest;
|
|
429
429
|
}
|
|
430
430
|
/**
|
|
431
|
-
* Request parameters for getFeatureInventory operation in
|
|
431
|
+
* Request parameters for getFeatureInventory operation in FulfillmentOutboundApi.
|
|
432
432
|
* @export
|
|
433
|
-
* @interface
|
|
433
|
+
* @interface FulfillmentOutboundApiGetFeatureInventoryRequest
|
|
434
434
|
*/
|
|
435
|
-
export interface
|
|
435
|
+
export interface FulfillmentOutboundApiGetFeatureInventoryRequest {
|
|
436
436
|
/**
|
|
437
437
|
* The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
438
438
|
* @type {string}
|
|
439
|
-
* @memberof
|
|
439
|
+
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
440
440
|
*/
|
|
441
441
|
readonly marketplaceId: string;
|
|
442
442
|
/**
|
|
443
443
|
* The name of the feature for which to return a list of eligible inventory.
|
|
444
444
|
* @type {string}
|
|
445
|
-
* @memberof
|
|
445
|
+
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
446
446
|
*/
|
|
447
447
|
readonly featureName: string;
|
|
448
448
|
/**
|
|
449
449
|
* A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
|
|
450
450
|
* @type {string}
|
|
451
|
-
* @memberof
|
|
451
|
+
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
452
452
|
*/
|
|
453
453
|
readonly nextToken?: string;
|
|
454
454
|
/**
|
|
455
455
|
* A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
|
|
456
456
|
* @type {string}
|
|
457
|
-
* @memberof
|
|
457
|
+
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
458
458
|
*/
|
|
459
459
|
readonly queryStartDate?: string;
|
|
460
460
|
}
|
|
461
461
|
/**
|
|
462
|
-
* Request parameters for getFeatureSKU operation in
|
|
462
|
+
* Request parameters for getFeatureSKU operation in FulfillmentOutboundApi.
|
|
463
463
|
* @export
|
|
464
|
-
* @interface
|
|
464
|
+
* @interface FulfillmentOutboundApiGetFeatureSKURequest
|
|
465
465
|
*/
|
|
466
|
-
export interface
|
|
466
|
+
export interface FulfillmentOutboundApiGetFeatureSKURequest {
|
|
467
467
|
/**
|
|
468
468
|
* The marketplace for which to return the count.
|
|
469
469
|
* @type {string}
|
|
470
|
-
* @memberof
|
|
470
|
+
* @memberof FulfillmentOutboundApiGetFeatureSKU
|
|
471
471
|
*/
|
|
472
472
|
readonly marketplaceId: string;
|
|
473
473
|
/**
|
|
474
474
|
* The name of the feature.
|
|
475
475
|
* @type {string}
|
|
476
|
-
* @memberof
|
|
476
|
+
* @memberof FulfillmentOutboundApiGetFeatureSKU
|
|
477
477
|
*/
|
|
478
478
|
readonly featureName: string;
|
|
479
479
|
/**
|
|
480
480
|
* Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit.
|
|
481
481
|
* @type {string}
|
|
482
|
-
* @memberof
|
|
482
|
+
* @memberof FulfillmentOutboundApiGetFeatureSKU
|
|
483
483
|
*/
|
|
484
484
|
readonly sellerSku: string;
|
|
485
485
|
}
|
|
486
486
|
/**
|
|
487
|
-
* Request parameters for getFeatures operation in
|
|
487
|
+
* Request parameters for getFeatures operation in FulfillmentOutboundApi.
|
|
488
488
|
* @export
|
|
489
|
-
* @interface
|
|
489
|
+
* @interface FulfillmentOutboundApiGetFeaturesRequest
|
|
490
490
|
*/
|
|
491
|
-
export interface
|
|
491
|
+
export interface FulfillmentOutboundApiGetFeaturesRequest {
|
|
492
492
|
/**
|
|
493
493
|
* The marketplace for which to return the list of features.
|
|
494
494
|
* @type {string}
|
|
495
|
-
* @memberof
|
|
495
|
+
* @memberof FulfillmentOutboundApiGetFeatures
|
|
496
496
|
*/
|
|
497
497
|
readonly marketplaceId: string;
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
|
-
* Request parameters for getFulfillmentOrder operation in
|
|
500
|
+
* Request parameters for getFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
501
501
|
* @export
|
|
502
|
-
* @interface
|
|
502
|
+
* @interface FulfillmentOutboundApiGetFulfillmentOrderRequest
|
|
503
503
|
*/
|
|
504
|
-
export interface
|
|
504
|
+
export interface FulfillmentOutboundApiGetFulfillmentOrderRequest {
|
|
505
505
|
/**
|
|
506
506
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
507
507
|
* @type {string}
|
|
508
|
-
* @memberof
|
|
508
|
+
* @memberof FulfillmentOutboundApiGetFulfillmentOrder
|
|
509
509
|
*/
|
|
510
510
|
readonly sellerFulfillmentOrderId: string;
|
|
511
511
|
}
|
|
512
512
|
/**
|
|
513
|
-
* Request parameters for getFulfillmentPreview operation in
|
|
513
|
+
* Request parameters for getFulfillmentPreview operation in FulfillmentOutboundApi.
|
|
514
514
|
* @export
|
|
515
|
-
* @interface
|
|
515
|
+
* @interface FulfillmentOutboundApiGetFulfillmentPreviewRequest
|
|
516
516
|
*/
|
|
517
|
-
export interface
|
|
517
|
+
export interface FulfillmentOutboundApiGetFulfillmentPreviewRequest {
|
|
518
518
|
/**
|
|
519
519
|
* GetFulfillmentPreviewRequest parameter
|
|
520
520
|
* @type {GetFulfillmentPreviewRequest}
|
|
521
|
-
* @memberof
|
|
521
|
+
* @memberof FulfillmentOutboundApiGetFulfillmentPreview
|
|
522
522
|
*/
|
|
523
523
|
readonly body: GetFulfillmentPreviewRequest;
|
|
524
524
|
}
|
|
525
525
|
/**
|
|
526
|
-
* Request parameters for getPackageTrackingDetails operation in
|
|
526
|
+
* Request parameters for getPackageTrackingDetails operation in FulfillmentOutboundApi.
|
|
527
527
|
* @export
|
|
528
|
-
* @interface
|
|
528
|
+
* @interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest
|
|
529
529
|
*/
|
|
530
|
-
export interface
|
|
530
|
+
export interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest {
|
|
531
531
|
/**
|
|
532
532
|
* The unencrypted package identifier returned by the `getFulfillmentOrder` operation.
|
|
533
533
|
* @type {number}
|
|
534
|
-
* @memberof
|
|
534
|
+
* @memberof FulfillmentOutboundApiGetPackageTrackingDetails
|
|
535
535
|
*/
|
|
536
536
|
readonly packageNumber: number;
|
|
537
537
|
}
|
|
538
538
|
/**
|
|
539
|
-
* Request parameters for listAllFulfillmentOrders operation in
|
|
539
|
+
* Request parameters for listAllFulfillmentOrders operation in FulfillmentOutboundApi.
|
|
540
540
|
* @export
|
|
541
|
-
* @interface
|
|
541
|
+
* @interface FulfillmentOutboundApiListAllFulfillmentOrdersRequest
|
|
542
542
|
*/
|
|
543
|
-
export interface
|
|
543
|
+
export interface FulfillmentOutboundApiListAllFulfillmentOrdersRequest {
|
|
544
544
|
/**
|
|
545
545
|
* A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
|
|
546
546
|
* @type {string}
|
|
547
|
-
* @memberof
|
|
547
|
+
* @memberof FulfillmentOutboundApiListAllFulfillmentOrders
|
|
548
548
|
*/
|
|
549
549
|
readonly queryStartDate?: string;
|
|
550
550
|
/**
|
|
551
551
|
* A string token returned in the response to your previous request.
|
|
552
552
|
* @type {string}
|
|
553
|
-
* @memberof
|
|
553
|
+
* @memberof FulfillmentOutboundApiListAllFulfillmentOrders
|
|
554
554
|
*/
|
|
555
555
|
readonly nextToken?: string;
|
|
556
556
|
}
|
|
557
557
|
/**
|
|
558
|
-
* Request parameters for listReturnReasonCodes operation in
|
|
558
|
+
* Request parameters for listReturnReasonCodes operation in FulfillmentOutboundApi.
|
|
559
559
|
* @export
|
|
560
|
-
* @interface
|
|
560
|
+
* @interface FulfillmentOutboundApiListReturnReasonCodesRequest
|
|
561
561
|
*/
|
|
562
|
-
export interface
|
|
562
|
+
export interface FulfillmentOutboundApiListReturnReasonCodesRequest {
|
|
563
563
|
/**
|
|
564
564
|
* The seller SKU for which return reason codes are required.
|
|
565
565
|
* @type {string}
|
|
566
|
-
* @memberof
|
|
566
|
+
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
567
567
|
*/
|
|
568
568
|
readonly sellerSku: string;
|
|
569
569
|
/**
|
|
570
570
|
* The marketplace for which the seller wants return reason codes.
|
|
571
571
|
* @type {string}
|
|
572
|
-
* @memberof
|
|
572
|
+
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
573
573
|
*/
|
|
574
574
|
readonly marketplaceId?: string;
|
|
575
575
|
/**
|
|
576
576
|
* The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.
|
|
577
577
|
* @type {string}
|
|
578
|
-
* @memberof
|
|
578
|
+
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
579
579
|
*/
|
|
580
580
|
readonly sellerFulfillmentOrderId?: string;
|
|
581
581
|
/**
|
|
582
582
|
* The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.
|
|
583
583
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
584
|
+
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
585
585
|
*/
|
|
586
586
|
readonly language?: string;
|
|
587
587
|
}
|
|
588
588
|
/**
|
|
589
|
-
* Request parameters for submitFulfillmentOrderStatusUpdate operation in
|
|
589
|
+
* Request parameters for submitFulfillmentOrderStatusUpdate operation in FulfillmentOutboundApi.
|
|
590
590
|
* @export
|
|
591
|
-
* @interface
|
|
591
|
+
* @interface FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest
|
|
592
592
|
*/
|
|
593
|
-
export interface
|
|
593
|
+
export interface FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest {
|
|
594
594
|
/**
|
|
595
595
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
596
596
|
* @type {string}
|
|
597
|
-
* @memberof
|
|
597
|
+
* @memberof FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdate
|
|
598
598
|
*/
|
|
599
599
|
readonly sellerFulfillmentOrderId: string;
|
|
600
600
|
/**
|
|
601
601
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
602
602
|
* @type {SubmitFulfillmentOrderStatusUpdateRequest}
|
|
603
|
-
* @memberof
|
|
603
|
+
* @memberof FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdate
|
|
604
604
|
*/
|
|
605
605
|
readonly body: SubmitFulfillmentOrderStatusUpdateRequest;
|
|
606
606
|
}
|
|
607
607
|
/**
|
|
608
|
-
* Request parameters for updateFulfillmentOrder operation in
|
|
608
|
+
* Request parameters for updateFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
609
609
|
* @export
|
|
610
|
-
* @interface
|
|
610
|
+
* @interface FulfillmentOutboundApiUpdateFulfillmentOrderRequest
|
|
611
611
|
*/
|
|
612
|
-
export interface
|
|
612
|
+
export interface FulfillmentOutboundApiUpdateFulfillmentOrderRequest {
|
|
613
613
|
/**
|
|
614
614
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
615
615
|
* @type {string}
|
|
616
|
-
* @memberof
|
|
616
|
+
* @memberof FulfillmentOutboundApiUpdateFulfillmentOrder
|
|
617
617
|
*/
|
|
618
618
|
readonly sellerFulfillmentOrderId: string;
|
|
619
619
|
/**
|
|
620
620
|
* UpdateFulfillmentOrderRequest parameter
|
|
621
621
|
* @type {UpdateFulfillmentOrderRequest}
|
|
622
|
-
* @memberof
|
|
622
|
+
* @memberof FulfillmentOutboundApiUpdateFulfillmentOrder
|
|
623
623
|
*/
|
|
624
624
|
readonly body: UpdateFulfillmentOrderRequest;
|
|
625
625
|
}
|
|
626
626
|
/**
|
|
627
|
-
*
|
|
627
|
+
* FulfillmentOutboundApi - object-oriented interface
|
|
628
628
|
* @export
|
|
629
|
-
* @class
|
|
629
|
+
* @class FulfillmentOutboundApi
|
|
630
630
|
* @extends {BaseAPI}
|
|
631
631
|
*/
|
|
632
|
-
export declare class
|
|
632
|
+
export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
633
633
|
/**
|
|
634
634
|
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
635
|
-
* @param {
|
|
635
|
+
* @param {FulfillmentOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
637
637
|
* @throws {RequiredError}
|
|
638
|
-
* @memberof
|
|
638
|
+
* @memberof FulfillmentOutboundApi
|
|
639
639
|
*/
|
|
640
|
-
cancelFulfillmentOrder(requestParameters:
|
|
640
|
+
cancelFulfillmentOrder(requestParameters: FulfillmentOutboundApiCancelFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelFulfillmentOrderResponse, any>>;
|
|
641
641
|
/**
|
|
642
642
|
* Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
643
|
-
* @param {
|
|
643
|
+
* @param {FulfillmentOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
644
644
|
* @param {*} [options] Override http request option.
|
|
645
645
|
* @throws {RequiredError}
|
|
646
|
-
* @memberof
|
|
646
|
+
* @memberof FulfillmentOutboundApi
|
|
647
647
|
*/
|
|
648
|
-
createFulfillmentOrder(requestParameters:
|
|
648
|
+
createFulfillmentOrder(requestParameters: FulfillmentOutboundApiCreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFulfillmentOrderResponse, any>>;
|
|
649
649
|
/**
|
|
650
650
|
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
651
|
-
* @param {
|
|
651
|
+
* @param {FulfillmentOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
|
|
652
652
|
* @param {*} [options] Override http request option.
|
|
653
653
|
* @throws {RequiredError}
|
|
654
|
-
* @memberof
|
|
654
|
+
* @memberof FulfillmentOutboundApi
|
|
655
655
|
*/
|
|
656
|
-
createFulfillmentReturn(requestParameters:
|
|
656
|
+
createFulfillmentReturn(requestParameters: FulfillmentOutboundApiCreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFulfillmentReturnResponse, any>>;
|
|
657
657
|
/**
|
|
658
658
|
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
659
|
-
* @param {
|
|
659
|
+
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
|
|
660
660
|
* @param {*} [options] Override http request option.
|
|
661
661
|
* @throws {RequiredError}
|
|
662
|
-
* @memberof
|
|
662
|
+
* @memberof FulfillmentOutboundApi
|
|
663
663
|
*/
|
|
664
|
-
deliveryOffers(requestParameters:
|
|
664
|
+
deliveryOffers(requestParameters: FulfillmentOutboundApiDeliveryOffersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDeliveryOffersResponse, any>>;
|
|
665
665
|
/**
|
|
666
666
|
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
|
|
667
|
-
* @param {
|
|
667
|
+
* @param {FulfillmentOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
|
|
668
668
|
* @param {*} [options] Override http request option.
|
|
669
669
|
* @throws {RequiredError}
|
|
670
|
-
* @memberof
|
|
670
|
+
* @memberof FulfillmentOutboundApi
|
|
671
671
|
*/
|
|
672
|
-
getFeatureInventory(requestParameters:
|
|
672
|
+
getFeatureInventory(requestParameters: FulfillmentOutboundApiGetFeatureInventoryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeatureInventoryResponse, any>>;
|
|
673
673
|
/**
|
|
674
674
|
* Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
675
|
-
* @param {
|
|
675
|
+
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
|
|
676
676
|
* @param {*} [options] Override http request option.
|
|
677
677
|
* @throws {RequiredError}
|
|
678
|
-
* @memberof
|
|
678
|
+
* @memberof FulfillmentOutboundApi
|
|
679
679
|
*/
|
|
680
|
-
getFeatureSKU(requestParameters:
|
|
680
|
+
getFeatureSKU(requestParameters: FulfillmentOutboundApiGetFeatureSKURequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeatureSkuResponse, any>>;
|
|
681
681
|
/**
|
|
682
682
|
* Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
683
|
-
* @param {
|
|
683
|
+
* @param {FulfillmentOutboundApiGetFeaturesRequest} requestParameters Request parameters.
|
|
684
684
|
* @param {*} [options] Override http request option.
|
|
685
685
|
* @throws {RequiredError}
|
|
686
|
-
* @memberof
|
|
686
|
+
* @memberof FulfillmentOutboundApi
|
|
687
687
|
*/
|
|
688
|
-
getFeatures(requestParameters:
|
|
688
|
+
getFeatures(requestParameters: FulfillmentOutboundApiGetFeaturesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeaturesResponse, any>>;
|
|
689
689
|
/**
|
|
690
690
|
* Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
691
|
-
* @param {
|
|
691
|
+
* @param {FulfillmentOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
|
|
692
692
|
* @param {*} [options] Override http request option.
|
|
693
693
|
* @throws {RequiredError}
|
|
694
|
-
* @memberof
|
|
694
|
+
* @memberof FulfillmentOutboundApi
|
|
695
695
|
*/
|
|
696
|
-
getFulfillmentOrder(requestParameters:
|
|
696
|
+
getFulfillmentOrder(requestParameters: FulfillmentOutboundApiGetFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFulfillmentOrderResponse, any>>;
|
|
697
697
|
/**
|
|
698
698
|
* Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
699
|
-
* @param {
|
|
699
|
+
* @param {FulfillmentOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
|
|
700
700
|
* @param {*} [options] Override http request option.
|
|
701
701
|
* @throws {RequiredError}
|
|
702
|
-
* @memberof
|
|
702
|
+
* @memberof FulfillmentOutboundApi
|
|
703
703
|
*/
|
|
704
|
-
getFulfillmentPreview(requestParameters:
|
|
704
|
+
getFulfillmentPreview(requestParameters: FulfillmentOutboundApiGetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFulfillmentPreviewResponse, any>>;
|
|
705
705
|
/**
|
|
706
706
|
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
707
|
-
* @param {
|
|
707
|
+
* @param {FulfillmentOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
|
|
708
708
|
* @param {*} [options] Override http request option.
|
|
709
709
|
* @throws {RequiredError}
|
|
710
|
-
* @memberof
|
|
710
|
+
* @memberof FulfillmentOutboundApi
|
|
711
711
|
*/
|
|
712
|
-
getPackageTrackingDetails(requestParameters:
|
|
712
|
+
getPackageTrackingDetails(requestParameters: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackageTrackingDetailsResponse, any>>;
|
|
713
713
|
/**
|
|
714
714
|
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
715
|
-
* @param {
|
|
715
|
+
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
|
|
716
716
|
* @param {*} [options] Override http request option.
|
|
717
717
|
* @throws {RequiredError}
|
|
718
|
-
* @memberof
|
|
718
|
+
* @memberof FulfillmentOutboundApi
|
|
719
719
|
*/
|
|
720
|
-
listAllFulfillmentOrders(requestParameters?:
|
|
720
|
+
listAllFulfillmentOrders(requestParameters?: FulfillmentOutboundApiListAllFulfillmentOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListAllFulfillmentOrdersResponse, any>>;
|
|
721
721
|
/**
|
|
722
722
|
* Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
723
|
-
* @param {
|
|
723
|
+
* @param {FulfillmentOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
|
|
724
724
|
* @param {*} [options] Override http request option.
|
|
725
725
|
* @throws {RequiredError}
|
|
726
|
-
* @memberof
|
|
726
|
+
* @memberof FulfillmentOutboundApi
|
|
727
727
|
*/
|
|
728
|
-
listReturnReasonCodes(requestParameters:
|
|
728
|
+
listReturnReasonCodes(requestParameters: FulfillmentOutboundApiListReturnReasonCodesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListReturnReasonCodesResponse, any>>;
|
|
729
729
|
/**
|
|
730
730
|
* Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
|
|
731
|
-
* @param {
|
|
731
|
+
* @param {FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest} requestParameters Request parameters.
|
|
732
732
|
* @param {*} [options] Override http request option.
|
|
733
733
|
* @throws {RequiredError}
|
|
734
|
-
* @memberof
|
|
734
|
+
* @memberof FulfillmentOutboundApi
|
|
735
735
|
*/
|
|
736
|
-
submitFulfillmentOrderStatusUpdate(requestParameters:
|
|
736
|
+
submitFulfillmentOrderStatusUpdate(requestParameters: FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitFulfillmentOrderStatusUpdateResponse, any>>;
|
|
737
737
|
/**
|
|
738
738
|
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
739
|
-
* @param {
|
|
739
|
+
* @param {FulfillmentOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
740
740
|
* @param {*} [options] Override http request option.
|
|
741
741
|
* @throws {RequiredError}
|
|
742
|
-
* @memberof
|
|
742
|
+
* @memberof FulfillmentOutboundApi
|
|
743
743
|
*/
|
|
744
|
-
updateFulfillmentOrder(requestParameters:
|
|
744
|
+
updateFulfillmentOrder(requestParameters: FulfillmentOutboundApiUpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateFulfillmentOrderResponse, any>>;
|
|
745
745
|
}
|