@sp-api-sdk/fulfillment-outbound-api-2020-07-01 4.0.1 → 4.1.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/fulfillment-outbound-api.js +93 -51
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/cjs/api-model/models/additional-location-info.js +0 -2
- package/dist/cjs/api-model/models/current-status.js +0 -2
- package/dist/cjs/api-model/models/delivery-offering.js +15 -0
- package/dist/cjs/api-model/models/delivery-quantity.js +19 -0
- package/dist/cjs/api-model/models/event-code.js +0 -2
- package/dist/cjs/api-model/models/fulfillment-action.js +0 -2
- package/dist/cjs/api-model/models/fulfillment-order-status.js +0 -2
- package/dist/cjs/api-model/models/fulfillment-policy.js +1 -3
- package/dist/cjs/api-model/models/fulfillment-return-item-status.js +0 -2
- package/dist/cjs/api-model/models/get-delivery-offerings-request.js +15 -0
- package/dist/cjs/api-model/models/get-delivery-offerings-response.js +15 -0
- package/dist/cjs/api-model/models/get-delivery-offerings-result.js +15 -0
- package/dist/cjs/api-model/models/index.js +5 -0
- package/dist/cjs/api-model/models/invalid-item-reason-code.js +0 -2
- package/dist/cjs/api-model/models/return-item-disposition.js +0 -2
- package/dist/cjs/api-model/models/shipping-speed-category.js +0 -2
- package/dist/cjs/client.js +7 -0
- package/dist/es/api-model/api/fulfillment-outbound-api.js +93 -51
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/es/api-model/models/additional-location-info.js +0 -2
- package/dist/es/api-model/models/current-status.js +0 -2
- package/dist/es/api-model/models/delivery-offering.js +14 -0
- package/dist/es/api-model/models/delivery-quantity.js +16 -0
- package/dist/es/api-model/models/event-code.js +0 -2
- package/dist/es/api-model/models/fulfillment-action.js +0 -2
- package/dist/es/api-model/models/fulfillment-order-status.js +0 -2
- package/dist/es/api-model/models/fulfillment-policy.js +1 -3
- package/dist/es/api-model/models/fulfillment-return-item-status.js +0 -2
- package/dist/es/api-model/models/get-delivery-offerings-request.js +14 -0
- package/dist/es/api-model/models/get-delivery-offerings-response.js +14 -0
- package/dist/es/api-model/models/get-delivery-offerings-result.js +14 -0
- package/dist/es/api-model/models/index.js +5 -0
- package/dist/es/api-model/models/invalid-item-reason-code.js +0 -2
- package/dist/es/api-model/models/return-item-disposition.js +0 -2
- package/dist/es/api-model/models/shipping-speed-category.js +0 -2
- package/dist/es/client.js +7 -0
- package/dist/types/api-model/api/fulfillment-outbound-api.d.ts +79 -134
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/additional-location-info.d.ts +0 -2
- package/dist/types/api-model/models/address.d.ts +0 -22
- package/dist/types/api-model/models/amount.d.ts +0 -6
- package/dist/types/api-model/models/cancel-fulfillment-order-response.d.ts +0 -4
- package/dist/types/api-model/models/codsettings.d.ts +0 -24
- package/dist/types/api-model/models/create-fulfillment-order-item.d.ts +1 -30
- package/dist/types/api-model/models/create-fulfillment-order-request.d.ts +2 -59
- package/dist/types/api-model/models/create-fulfillment-order-response.d.ts +0 -4
- package/dist/types/api-model/models/create-fulfillment-return-request.d.ts +1 -5
- package/dist/types/api-model/models/create-fulfillment-return-response.d.ts +0 -9
- package/dist/types/api-model/models/create-fulfillment-return-result.d.ts +1 -9
- package/dist/types/api-model/models/create-return-item.d.ts +1 -13
- package/dist/types/api-model/models/current-status.d.ts +0 -2
- package/dist/types/api-model/models/date-range.d.ts +0 -6
- package/dist/types/api-model/models/delivery-document.d.ts +0 -6
- package/dist/types/api-model/models/delivery-information.d.ts +0 -9
- package/dist/types/api-model/models/delivery-message.d.ts +1 -7
- package/dist/types/api-model/models/delivery-offer.d.ts +0 -14
- package/dist/types/api-model/models/delivery-offering.d.ts +24 -0
- package/dist/types/api-model/models/delivery-policy.d.ts +0 -7
- package/dist/types/api-model/models/delivery-preferences.d.ts +0 -9
- package/dist/types/api-model/models/delivery-quantity.d.ts +28 -0
- package/dist/types/api-model/models/delivery-window.d.ts +0 -6
- package/dist/types/api-model/models/destination.d.ts +0 -9
- package/dist/types/api-model/models/drop-off-location.d.ts +0 -6
- package/dist/types/api-model/models/event-code.d.ts +0 -2
- package/dist/types/api-model/models/feature-settings.d.ts +1 -7
- package/dist/types/api-model/models/feature-sku.d.ts +0 -12
- package/dist/types/api-model/models/feature.d.ts +0 -8
- package/dist/types/api-model/models/fee.d.ts +0 -9
- package/dist/types/api-model/models/fulfillment-action.d.ts +0 -2
- package/dist/types/api-model/models/fulfillment-order-item.d.ts +0 -39
- package/dist/types/api-model/models/fulfillment-order-status.d.ts +0 -2
- package/dist/types/api-model/models/fulfillment-order.d.ts +0 -55
- package/dist/types/api-model/models/fulfillment-policy.d.ts +1 -3
- package/dist/types/api-model/models/fulfillment-preview-item.d.ts +0 -15
- package/dist/types/api-model/models/fulfillment-preview-shipment.d.ts +0 -14
- package/dist/types/api-model/models/fulfillment-preview.d.ts +0 -33
- package/dist/types/api-model/models/fulfillment-return-item-status.d.ts +0 -2
- package/dist/types/api-model/models/fulfillment-shipment-item.d.ts +0 -14
- package/dist/types/api-model/models/fulfillment-shipment-package.d.ts +4 -20
- package/dist/types/api-model/models/fulfillment-shipment.d.ts +2 -20
- package/dist/types/api-model/models/get-delivery-offerings-request.d.ts +28 -0
- package/dist/types/api-model/models/get-delivery-offerings-response.d.ts +22 -0
- package/dist/types/api-model/models/get-delivery-offerings-result.d.ts +21 -0
- package/dist/types/api-model/models/get-delivery-offers-product.d.ts +0 -12
- package/dist/types/api-model/models/get-delivery-offers-request.d.ts +1 -13
- package/dist/types/api-model/models/get-delivery-offers-response.d.ts +1 -10
- package/dist/types/api-model/models/get-delivery-offers-result.d.ts +0 -4
- package/dist/types/api-model/models/get-delivery-offers-terms.d.ts +0 -12
- package/dist/types/api-model/models/get-feature-inventory-response.d.ts +0 -9
- package/dist/types/api-model/models/get-feature-inventory-result.d.ts +1 -11
- package/dist/types/api-model/models/get-feature-sku-response.d.ts +0 -9
- package/dist/types/api-model/models/get-feature-sku-result.d.ts +1 -16
- package/dist/types/api-model/models/get-features-response.d.ts +0 -9
- package/dist/types/api-model/models/get-features-result.d.ts +0 -4
- package/dist/types/api-model/models/get-fulfillment-order-response.d.ts +0 -9
- package/dist/types/api-model/models/get-fulfillment-order-result.d.ts +1 -18
- package/dist/types/api-model/models/get-fulfillment-preview-item.d.ts +0 -13
- package/dist/types/api-model/models/get-fulfillment-preview-request.d.ts +2 -21
- package/dist/types/api-model/models/get-fulfillment-preview-response.d.ts +0 -9
- package/dist/types/api-model/models/get-fulfillment-preview-result.d.ts +0 -4
- package/dist/types/api-model/models/get-package-tracking-details-response.d.ts +0 -9
- package/dist/types/api-model/models/index.d.ts +5 -0
- package/dist/types/api-model/models/invalid-item-reason-code.d.ts +0 -2
- package/dist/types/api-model/models/invalid-item-reason.d.ts +0 -9
- package/dist/types/api-model/models/invalid-return-item.d.ts +1 -12
- package/dist/types/api-model/models/list-all-fulfillment-orders-response.d.ts +0 -9
- package/dist/types/api-model/models/list-all-fulfillment-orders-result.d.ts +1 -7
- package/dist/types/api-model/models/list-return-reason-codes-response.d.ts +0 -9
- package/dist/types/api-model/models/list-return-reason-codes-result.d.ts +1 -5
- package/dist/types/api-model/models/locker-details.d.ts +0 -6
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/money.d.ts +0 -6
- package/dist/types/api-model/models/origin.d.ts +0 -4
- package/dist/types/api-model/models/package-tracking-details.d.ts +1 -45
- package/dist/types/api-model/models/payment-information.d.ts +0 -8
- package/dist/types/api-model/models/product-identifier.d.ts +0 -4
- package/dist/types/api-model/models/reason-code-details.d.ts +1 -9
- package/dist/types/api-model/models/return-authorization.d.ts +1 -16
- package/dist/types/api-model/models/return-item-disposition.d.ts +0 -2
- package/dist/types/api-model/models/return-item.d.ts +1 -31
- package/dist/types/api-model/models/scheduled-delivery-info.d.ts +0 -6
- package/dist/types/api-model/models/shipping-speed-category.d.ts +0 -2
- package/dist/types/api-model/models/submit-fulfillment-order-status-update-request.d.ts +0 -7
- package/dist/types/api-model/models/submit-fulfillment-order-status-update-response.d.ts +0 -4
- package/dist/types/api-model/models/tracking-address.d.ts +0 -8
- package/dist/types/api-model/models/tracking-event.d.ts +0 -16
- package/dist/types/api-model/models/unfulfillable-preview-item.d.ts +0 -10
- package/dist/types/api-model/models/update-fulfillment-order-item.d.ts +1 -32
- package/dist/types/api-model/models/update-fulfillment-order-request.d.ts +0 -38
- package/dist/types/api-model/models/update-fulfillment-order-response.d.ts +0 -4
- package/dist/types/api-model/models/variable-precision-address.d.ts +0 -18
- package/dist/types/api-model/models/weight.d.ts +0 -6
- package/package.json +25 -4
|
@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
|
|
|
19
19
|
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
21
|
* FulfillmentOutboundApi - axios parameter creator
|
|
22
|
-
* @export
|
|
23
22
|
*/
|
|
24
23
|
export const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
|
|
25
24
|
return {
|
|
@@ -82,8 +81,8 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
82
81
|
},
|
|
83
82
|
/**
|
|
84
83
|
* 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).
|
|
85
|
-
* @param {string} sellerFulfillmentOrderId An identifier
|
|
86
|
-
* @param {CreateFulfillmentReturnRequest} body
|
|
84
|
+
* @param {string} sellerFulfillmentOrderId An identifier the seller assigns 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.
|
|
85
|
+
* @param {CreateFulfillmentReturnRequest} body The request body of the `createFulfillmentReturn` operation.
|
|
87
86
|
* @param {*} [options] Override http request option.
|
|
88
87
|
* @throws {RequiredError}
|
|
89
88
|
*/
|
|
@@ -113,6 +112,35 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
113
112
|
options: localVarRequestOptions,
|
|
114
113
|
};
|
|
115
114
|
},
|
|
115
|
+
/**
|
|
116
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, 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).
|
|
117
|
+
* @param {GetDeliveryOfferingsRequest} body GetDeliveryOfferingsRequest parameter
|
|
118
|
+
* @param {*} [options] Override http request option.
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
deliveryOfferings: async (body, options = {}) => {
|
|
122
|
+
// verify required parameter 'body' is not null or undefined
|
|
123
|
+
assertParamExists('deliveryOfferings', 'body', body);
|
|
124
|
+
const localVarPath = `/fba/outbound/2020-07-01/deliveryOfferings`;
|
|
125
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
126
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
127
|
+
let baseOptions;
|
|
128
|
+
if (configuration) {
|
|
129
|
+
baseOptions = configuration.baseOptions;
|
|
130
|
+
}
|
|
131
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
132
|
+
const localVarHeaderParameter = {};
|
|
133
|
+
const localVarQueryParameter = {};
|
|
134
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
135
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
136
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
137
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
138
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
139
|
+
return {
|
|
140
|
+
url: toPathString(localVarUrlObj),
|
|
141
|
+
options: localVarRequestOptions,
|
|
142
|
+
};
|
|
143
|
+
},
|
|
116
144
|
/**
|
|
117
145
|
* 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).
|
|
118
146
|
* @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter
|
|
@@ -146,8 +174,8 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
146
174
|
* 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)..
|
|
147
175
|
* @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
148
176
|
* @param {string} featureName The name of the feature for which to return a list of eligible inventory.
|
|
149
|
-
* @param {string} [nextToken] 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.
|
|
150
|
-
* @param {string} [queryStartDate] 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
|
|
177
|
+
* @param {string} [nextToken] 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.
|
|
178
|
+
* @param {string} [queryStartDate] 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`
|
|
151
179
|
* @param {*} [options] Override http request option.
|
|
152
180
|
* @throws {RequiredError}
|
|
153
181
|
*/
|
|
@@ -187,10 +215,10 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
187
215
|
};
|
|
188
216
|
},
|
|
189
217
|
/**
|
|
190
|
-
* Returns the number of items with the
|
|
218
|
+
* 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
|
|
191
219
|
* @param {string} marketplaceId The marketplace for which to return the count.
|
|
192
220
|
* @param {string} featureName The name of the feature.
|
|
193
|
-
* @param {string} sellerSku Used to identify an item in the given marketplace. `
|
|
221
|
+
* @param {string} sellerSku 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.
|
|
194
222
|
* @param {*} [options] Override http request option.
|
|
195
223
|
* @throws {RequiredError}
|
|
196
224
|
*/
|
|
@@ -313,13 +341,12 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
313
341
|
},
|
|
314
342
|
/**
|
|
315
343
|
* 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).
|
|
316
|
-
* @param {number} packageNumber The unencrypted package identifier
|
|
344
|
+
* @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
345
|
+
* @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
317
346
|
* @param {*} [options] Override http request option.
|
|
318
347
|
* @throws {RequiredError}
|
|
319
348
|
*/
|
|
320
|
-
getPackageTrackingDetails: async (packageNumber, options = {}) => {
|
|
321
|
-
// verify required parameter 'packageNumber' is not null or undefined
|
|
322
|
-
assertParamExists('getPackageTrackingDetails', 'packageNumber', packageNumber);
|
|
349
|
+
getPackageTrackingDetails: async (packageNumber, amazonFulfillmentTrackingNumber, options = {}) => {
|
|
323
350
|
const localVarPath = `/fba/outbound/2020-07-01/tracking`;
|
|
324
351
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
325
352
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -333,6 +360,9 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
333
360
|
if (packageNumber !== undefined) {
|
|
334
361
|
localVarQueryParameter['packageNumber'] = packageNumber;
|
|
335
362
|
}
|
|
363
|
+
if (amazonFulfillmentTrackingNumber !== undefined) {
|
|
364
|
+
localVarQueryParameter['amazonFulfillmentTrackingNumber'] = amazonFulfillmentTrackingNumber;
|
|
365
|
+
}
|
|
336
366
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
337
367
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
338
368
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -342,7 +372,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
342
372
|
};
|
|
343
373
|
},
|
|
344
374
|
/**
|
|
345
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
375
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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)
|
|
346
376
|
* @param {string} [queryStartDate] 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.
|
|
347
377
|
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
348
378
|
* @param {*} [options] Override http request option.
|
|
@@ -453,7 +483,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
453
483
|
/**
|
|
454
484
|
* 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).
|
|
455
485
|
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
456
|
-
* @param {UpdateFulfillmentOrderRequest} body
|
|
486
|
+
* @param {UpdateFulfillmentOrderRequest} body The request body of the `updateFulfillmentOrder` operation.
|
|
457
487
|
* @param {*} [options] Override http request option.
|
|
458
488
|
* @throws {RequiredError}
|
|
459
489
|
*/
|
|
@@ -487,7 +517,6 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
|
|
|
487
517
|
};
|
|
488
518
|
/**
|
|
489
519
|
* FulfillmentOutboundApi - functional programming interface
|
|
490
|
-
* @export
|
|
491
520
|
*/
|
|
492
521
|
export const FulfillmentOutboundApiFp = function (configuration) {
|
|
493
522
|
const localVarAxiosParamCreator = FulfillmentOutboundApiAxiosParamCreator(configuration);
|
|
@@ -518,8 +547,8 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
518
547
|
},
|
|
519
548
|
/**
|
|
520
549
|
* 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).
|
|
521
|
-
* @param {string} sellerFulfillmentOrderId An identifier
|
|
522
|
-
* @param {CreateFulfillmentReturnRequest} body
|
|
550
|
+
* @param {string} sellerFulfillmentOrderId An identifier the seller assigns 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.
|
|
551
|
+
* @param {CreateFulfillmentReturnRequest} body The request body of the `createFulfillmentReturn` operation.
|
|
523
552
|
* @param {*} [options] Override http request option.
|
|
524
553
|
* @throws {RequiredError}
|
|
525
554
|
*/
|
|
@@ -529,6 +558,18 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
529
558
|
const localVarOperationServerBasePath = operationServerMap['FulfillmentOutboundApi.createFulfillmentReturn']?.[localVarOperationServerIndex]?.url;
|
|
530
559
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
531
560
|
},
|
|
561
|
+
/**
|
|
562
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, 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).
|
|
563
|
+
* @param {GetDeliveryOfferingsRequest} body GetDeliveryOfferingsRequest parameter
|
|
564
|
+
* @param {*} [options] Override http request option.
|
|
565
|
+
* @throws {RequiredError}
|
|
566
|
+
*/
|
|
567
|
+
async deliveryOfferings(body, options) {
|
|
568
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deliveryOfferings(body, options);
|
|
569
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
570
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentOutboundApi.deliveryOfferings']?.[localVarOperationServerIndex]?.url;
|
|
571
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
572
|
+
},
|
|
532
573
|
/**
|
|
533
574
|
* 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).
|
|
534
575
|
* @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter
|
|
@@ -545,8 +586,8 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
545
586
|
* 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)..
|
|
546
587
|
* @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
547
588
|
* @param {string} featureName The name of the feature for which to return a list of eligible inventory.
|
|
548
|
-
* @param {string} [nextToken] 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.
|
|
549
|
-
* @param {string} [queryStartDate] 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
|
|
589
|
+
* @param {string} [nextToken] 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.
|
|
590
|
+
* @param {string} [queryStartDate] 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`
|
|
550
591
|
* @param {*} [options] Override http request option.
|
|
551
592
|
* @throws {RequiredError}
|
|
552
593
|
*/
|
|
@@ -557,10 +598,10 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
557
598
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
558
599
|
},
|
|
559
600
|
/**
|
|
560
|
-
* Returns the number of items with the
|
|
601
|
+
* 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
|
|
561
602
|
* @param {string} marketplaceId The marketplace for which to return the count.
|
|
562
603
|
* @param {string} featureName The name of the feature.
|
|
563
|
-
* @param {string} sellerSku Used to identify an item in the given marketplace. `
|
|
604
|
+
* @param {string} sellerSku 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.
|
|
564
605
|
* @param {*} [options] Override http request option.
|
|
565
606
|
* @throws {RequiredError}
|
|
566
607
|
*/
|
|
@@ -608,18 +649,19 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
608
649
|
},
|
|
609
650
|
/**
|
|
610
651
|
* 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).
|
|
611
|
-
* @param {number} packageNumber The unencrypted package identifier
|
|
652
|
+
* @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
653
|
+
* @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
612
654
|
* @param {*} [options] Override http request option.
|
|
613
655
|
* @throws {RequiredError}
|
|
614
656
|
*/
|
|
615
|
-
async getPackageTrackingDetails(packageNumber, options) {
|
|
616
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageTrackingDetails(packageNumber, options);
|
|
657
|
+
async getPackageTrackingDetails(packageNumber, amazonFulfillmentTrackingNumber, options) {
|
|
658
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageTrackingDetails(packageNumber, amazonFulfillmentTrackingNumber, options);
|
|
617
659
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
618
660
|
const localVarOperationServerBasePath = operationServerMap['FulfillmentOutboundApi.getPackageTrackingDetails']?.[localVarOperationServerIndex]?.url;
|
|
619
661
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
620
662
|
},
|
|
621
663
|
/**
|
|
622
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
664
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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)
|
|
623
665
|
* @param {string} [queryStartDate] 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.
|
|
624
666
|
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
625
667
|
* @param {*} [options] Override http request option.
|
|
@@ -662,7 +704,7 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
662
704
|
/**
|
|
663
705
|
* 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).
|
|
664
706
|
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
665
|
-
* @param {UpdateFulfillmentOrderRequest} body
|
|
707
|
+
* @param {UpdateFulfillmentOrderRequest} body The request body of the `updateFulfillmentOrder` operation.
|
|
666
708
|
* @param {*} [options] Override http request option.
|
|
667
709
|
* @throws {RequiredError}
|
|
668
710
|
*/
|
|
@@ -676,7 +718,6 @@ export const FulfillmentOutboundApiFp = function (configuration) {
|
|
|
676
718
|
};
|
|
677
719
|
/**
|
|
678
720
|
* FulfillmentOutboundApi - factory interface
|
|
679
|
-
* @export
|
|
680
721
|
*/
|
|
681
722
|
export const FulfillmentOutboundApiFactory = function (configuration, basePath, axios) {
|
|
682
723
|
const localVarFp = FulfillmentOutboundApiFp(configuration);
|
|
@@ -708,6 +749,15 @@ export const FulfillmentOutboundApiFactory = function (configuration, basePath,
|
|
|
708
749
|
createFulfillmentReturn(requestParameters, options) {
|
|
709
750
|
return localVarFp.createFulfillmentReturn(requestParameters.sellerFulfillmentOrderId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
710
751
|
},
|
|
752
|
+
/**
|
|
753
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, 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).
|
|
754
|
+
* @param {FulfillmentOutboundApiDeliveryOfferingsRequest} requestParameters Request parameters.
|
|
755
|
+
* @param {*} [options] Override http request option.
|
|
756
|
+
* @throws {RequiredError}
|
|
757
|
+
*/
|
|
758
|
+
deliveryOfferings(requestParameters, options) {
|
|
759
|
+
return localVarFp.deliveryOfferings(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
760
|
+
},
|
|
711
761
|
/**
|
|
712
762
|
* 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).
|
|
713
763
|
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
|
|
@@ -727,7 +777,7 @@ export const FulfillmentOutboundApiFactory = function (configuration, basePath,
|
|
|
727
777
|
return localVarFp.getFeatureInventory(requestParameters.marketplaceId, requestParameters.featureName, requestParameters.nextToken, requestParameters.queryStartDate, options).then((request) => request(axios, basePath));
|
|
728
778
|
},
|
|
729
779
|
/**
|
|
730
|
-
* Returns the number of items with the
|
|
780
|
+
* 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
|
|
731
781
|
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
|
|
732
782
|
* @param {*} [options] Override http request option.
|
|
733
783
|
* @throws {RequiredError}
|
|
@@ -768,11 +818,11 @@ export const FulfillmentOutboundApiFactory = function (configuration, basePath,
|
|
|
768
818
|
* @param {*} [options] Override http request option.
|
|
769
819
|
* @throws {RequiredError}
|
|
770
820
|
*/
|
|
771
|
-
getPackageTrackingDetails(requestParameters, options) {
|
|
772
|
-
return localVarFp.getPackageTrackingDetails(requestParameters.packageNumber, options).then((request) => request(axios, basePath));
|
|
821
|
+
getPackageTrackingDetails(requestParameters = {}, options) {
|
|
822
|
+
return localVarFp.getPackageTrackingDetails(requestParameters.packageNumber, requestParameters.amazonFulfillmentTrackingNumber, options).then((request) => request(axios, basePath));
|
|
773
823
|
},
|
|
774
824
|
/**
|
|
775
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
825
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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)
|
|
776
826
|
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
|
|
777
827
|
* @param {*} [options] Override http request option.
|
|
778
828
|
* @throws {RequiredError}
|
|
@@ -811,9 +861,6 @@ export const FulfillmentOutboundApiFactory = function (configuration, basePath,
|
|
|
811
861
|
};
|
|
812
862
|
/**
|
|
813
863
|
* FulfillmentOutboundApi - object-oriented interface
|
|
814
|
-
* @export
|
|
815
|
-
* @class FulfillmentOutboundApi
|
|
816
|
-
* @extends {BaseAPI}
|
|
817
864
|
*/
|
|
818
865
|
export class FulfillmentOutboundApi extends BaseAPI {
|
|
819
866
|
/**
|
|
@@ -821,7 +868,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
821
868
|
* @param {FulfillmentOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters.
|
|
822
869
|
* @param {*} [options] Override http request option.
|
|
823
870
|
* @throws {RequiredError}
|
|
824
|
-
* @memberof FulfillmentOutboundApi
|
|
825
871
|
*/
|
|
826
872
|
cancelFulfillmentOrder(requestParameters, options) {
|
|
827
873
|
return FulfillmentOutboundApiFp(this.configuration).cancelFulfillmentOrder(requestParameters.sellerFulfillmentOrderId, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -831,7 +877,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
831
877
|
* @param {FulfillmentOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
832
878
|
* @param {*} [options] Override http request option.
|
|
833
879
|
* @throws {RequiredError}
|
|
834
|
-
* @memberof FulfillmentOutboundApi
|
|
835
880
|
*/
|
|
836
881
|
createFulfillmentOrder(requestParameters, options) {
|
|
837
882
|
return FulfillmentOutboundApiFp(this.configuration).createFulfillmentOrder(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -841,17 +886,24 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
841
886
|
* @param {FulfillmentOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
|
|
842
887
|
* @param {*} [options] Override http request option.
|
|
843
888
|
* @throws {RequiredError}
|
|
844
|
-
* @memberof FulfillmentOutboundApi
|
|
845
889
|
*/
|
|
846
890
|
createFulfillmentReturn(requestParameters, options) {
|
|
847
891
|
return FulfillmentOutboundApiFp(this.configuration).createFulfillmentReturn(requestParameters.sellerFulfillmentOrderId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
848
892
|
}
|
|
893
|
+
/**
|
|
894
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, 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).
|
|
895
|
+
* @param {FulfillmentOutboundApiDeliveryOfferingsRequest} requestParameters Request parameters.
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
deliveryOfferings(requestParameters, options) {
|
|
900
|
+
return FulfillmentOutboundApiFp(this.configuration).deliveryOfferings(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
901
|
+
}
|
|
849
902
|
/**
|
|
850
903
|
* 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).
|
|
851
904
|
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
|
|
852
905
|
* @param {*} [options] Override http request option.
|
|
853
906
|
* @throws {RequiredError}
|
|
854
|
-
* @memberof FulfillmentOutboundApi
|
|
855
907
|
*/
|
|
856
908
|
deliveryOffers(requestParameters, options) {
|
|
857
909
|
return FulfillmentOutboundApiFp(this.configuration).deliveryOffers(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -861,17 +913,15 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
861
913
|
* @param {FulfillmentOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
|
|
862
914
|
* @param {*} [options] Override http request option.
|
|
863
915
|
* @throws {RequiredError}
|
|
864
|
-
* @memberof FulfillmentOutboundApi
|
|
865
916
|
*/
|
|
866
917
|
getFeatureInventory(requestParameters, options) {
|
|
867
918
|
return FulfillmentOutboundApiFp(this.configuration).getFeatureInventory(requestParameters.marketplaceId, requestParameters.featureName, requestParameters.nextToken, requestParameters.queryStartDate, options).then((request) => request(this.axios, this.basePath));
|
|
868
919
|
}
|
|
869
920
|
/**
|
|
870
|
-
* Returns the number of items with the
|
|
921
|
+
* 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
|
|
871
922
|
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
|
|
872
923
|
* @param {*} [options] Override http request option.
|
|
873
924
|
* @throws {RequiredError}
|
|
874
|
-
* @memberof FulfillmentOutboundApi
|
|
875
925
|
*/
|
|
876
926
|
getFeatureSKU(requestParameters, options) {
|
|
877
927
|
return FulfillmentOutboundApiFp(this.configuration).getFeatureSKU(requestParameters.marketplaceId, requestParameters.featureName, requestParameters.sellerSku, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -881,7 +931,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
881
931
|
* @param {FulfillmentOutboundApiGetFeaturesRequest} requestParameters Request parameters.
|
|
882
932
|
* @param {*} [options] Override http request option.
|
|
883
933
|
* @throws {RequiredError}
|
|
884
|
-
* @memberof FulfillmentOutboundApi
|
|
885
934
|
*/
|
|
886
935
|
getFeatures(requestParameters, options) {
|
|
887
936
|
return FulfillmentOutboundApiFp(this.configuration).getFeatures(requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -891,7 +940,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
891
940
|
* @param {FulfillmentOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
|
|
892
941
|
* @param {*} [options] Override http request option.
|
|
893
942
|
* @throws {RequiredError}
|
|
894
|
-
* @memberof FulfillmentOutboundApi
|
|
895
943
|
*/
|
|
896
944
|
getFulfillmentOrder(requestParameters, options) {
|
|
897
945
|
return FulfillmentOutboundApiFp(this.configuration).getFulfillmentOrder(requestParameters.sellerFulfillmentOrderId, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -901,7 +949,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
901
949
|
* @param {FulfillmentOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
|
|
902
950
|
* @param {*} [options] Override http request option.
|
|
903
951
|
* @throws {RequiredError}
|
|
904
|
-
* @memberof FulfillmentOutboundApi
|
|
905
952
|
*/
|
|
906
953
|
getFulfillmentPreview(requestParameters, options) {
|
|
907
954
|
return FulfillmentOutboundApiFp(this.configuration).getFulfillmentPreview(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -911,17 +958,15 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
911
958
|
* @param {FulfillmentOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
|
|
912
959
|
* @param {*} [options] Override http request option.
|
|
913
960
|
* @throws {RequiredError}
|
|
914
|
-
* @memberof FulfillmentOutboundApi
|
|
915
961
|
*/
|
|
916
|
-
getPackageTrackingDetails(requestParameters, options) {
|
|
917
|
-
return FulfillmentOutboundApiFp(this.configuration).getPackageTrackingDetails(requestParameters.packageNumber, options).then((request) => request(this.axios, this.basePath));
|
|
962
|
+
getPackageTrackingDetails(requestParameters = {}, options) {
|
|
963
|
+
return FulfillmentOutboundApiFp(this.configuration).getPackageTrackingDetails(requestParameters.packageNumber, requestParameters.amazonFulfillmentTrackingNumber, options).then((request) => request(this.axios, this.basePath));
|
|
918
964
|
}
|
|
919
965
|
/**
|
|
920
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
966
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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)
|
|
921
967
|
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
|
|
922
968
|
* @param {*} [options] Override http request option.
|
|
923
969
|
* @throws {RequiredError}
|
|
924
|
-
* @memberof FulfillmentOutboundApi
|
|
925
970
|
*/
|
|
926
971
|
listAllFulfillmentOrders(requestParameters = {}, options) {
|
|
927
972
|
return FulfillmentOutboundApiFp(this.configuration).listAllFulfillmentOrders(requestParameters.queryStartDate, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -931,7 +976,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
931
976
|
* @param {FulfillmentOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
|
|
932
977
|
* @param {*} [options] Override http request option.
|
|
933
978
|
* @throws {RequiredError}
|
|
934
|
-
* @memberof FulfillmentOutboundApi
|
|
935
979
|
*/
|
|
936
980
|
listReturnReasonCodes(requestParameters, options) {
|
|
937
981
|
return FulfillmentOutboundApiFp(this.configuration).listReturnReasonCodes(requestParameters.sellerSku, requestParameters.marketplaceId, requestParameters.sellerFulfillmentOrderId, requestParameters.language, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -941,7 +985,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
941
985
|
* @param {FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest} requestParameters Request parameters.
|
|
942
986
|
* @param {*} [options] Override http request option.
|
|
943
987
|
* @throws {RequiredError}
|
|
944
|
-
* @memberof FulfillmentOutboundApi
|
|
945
988
|
*/
|
|
946
989
|
submitFulfillmentOrderStatusUpdate(requestParameters, options) {
|
|
947
990
|
return FulfillmentOutboundApiFp(this.configuration).submitFulfillmentOrderStatusUpdate(requestParameters.sellerFulfillmentOrderId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -951,7 +994,6 @@ export class FulfillmentOutboundApi extends BaseAPI {
|
|
|
951
994
|
* @param {FulfillmentOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
952
995
|
* @param {*} [options] Override http request option.
|
|
953
996
|
* @throws {RequiredError}
|
|
954
|
-
* @memberof FulfillmentOutboundApi
|
|
955
997
|
*/
|
|
956
998
|
updateFulfillmentOrder(requestParameters, options) {
|
|
957
999
|
return FulfillmentOutboundApiFp(this.configuration).updateFulfillmentOrder(requestParameters.sellerFulfillmentOrderId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -13,21 +13,12 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
15
|
export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
16
|
-
/**
|
|
17
|
-
*
|
|
18
|
-
* @export
|
|
19
|
-
*/
|
|
20
16
|
export const COLLECTION_FORMATS = {
|
|
21
17
|
csv: ",",
|
|
22
18
|
ssv: " ",
|
|
23
19
|
tsv: "\t",
|
|
24
20
|
pipes: "|",
|
|
25
21
|
};
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
* @class BaseAPI
|
|
30
|
-
*/
|
|
31
22
|
export class BaseAPI {
|
|
32
23
|
basePath;
|
|
33
24
|
axios;
|
|
@@ -42,12 +33,6 @@ export class BaseAPI {
|
|
|
42
33
|
}
|
|
43
34
|
}
|
|
44
35
|
;
|
|
45
|
-
/**
|
|
46
|
-
*
|
|
47
|
-
* @export
|
|
48
|
-
* @class RequiredError
|
|
49
|
-
* @extends {Error}
|
|
50
|
-
*/
|
|
51
36
|
export class RequiredError extends Error {
|
|
52
37
|
field;
|
|
53
38
|
constructor(field, msg) {
|
|
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
|
|
|
56
41
|
this.name = "RequiredError";
|
|
57
42
|
}
|
|
58
43
|
}
|
|
59
|
-
/**
|
|
60
|
-
*
|
|
61
|
-
* @export
|
|
62
|
-
*/
|
|
63
44
|
export const operationServerMap = {};
|
|
@@ -12,25 +12,16 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { RequiredError } from "./base";
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export const DUMMY_BASE_URL = 'https://example.com';
|
|
20
16
|
/**
|
|
21
17
|
*
|
|
22
18
|
* @throws {RequiredError}
|
|
23
|
-
* @export
|
|
24
19
|
*/
|
|
25
20
|
export const assertParamExists = function (functionName, paramName, paramValue) {
|
|
26
21
|
if (paramValue === null || paramValue === undefined) {
|
|
27
22
|
throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
28
23
|
}
|
|
29
24
|
};
|
|
30
|
-
/**
|
|
31
|
-
*
|
|
32
|
-
* @export
|
|
33
|
-
*/
|
|
34
25
|
export const setApiKeyToObject = async function (object, keyParamName, configuration) {
|
|
35
26
|
if (configuration && configuration.apiKey) {
|
|
36
27
|
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
|
|
|
39
30
|
object[keyParamName] = localVarApiKeyValue;
|
|
40
31
|
}
|
|
41
32
|
};
|
|
42
|
-
/**
|
|
43
|
-
*
|
|
44
|
-
* @export
|
|
45
|
-
*/
|
|
46
33
|
export const setBasicAuthToObject = function (object, configuration) {
|
|
47
34
|
if (configuration && (configuration.username || configuration.password)) {
|
|
48
35
|
object["auth"] = { username: configuration.username, password: configuration.password };
|
|
49
36
|
}
|
|
50
37
|
};
|
|
51
|
-
/**
|
|
52
|
-
*
|
|
53
|
-
* @export
|
|
54
|
-
*/
|
|
55
38
|
export const setBearerAuthToObject = async function (object, configuration) {
|
|
56
39
|
if (configuration && configuration.accessToken) {
|
|
57
40
|
const accessToken = typeof configuration.accessToken === 'function'
|
|
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
|
|
|
60
43
|
object["Authorization"] = "Bearer " + accessToken;
|
|
61
44
|
}
|
|
62
45
|
};
|
|
63
|
-
/**
|
|
64
|
-
*
|
|
65
|
-
* @export
|
|
66
|
-
*/
|
|
67
46
|
export const setOAuthToObject = async function (object, name, scopes, configuration) {
|
|
68
47
|
if (configuration && configuration.accessToken) {
|
|
69
48
|
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
|
92
71
|
}
|
|
93
72
|
}
|
|
94
73
|
}
|
|
95
|
-
/**
|
|
96
|
-
*
|
|
97
|
-
* @export
|
|
98
|
-
*/
|
|
99
74
|
export const setSearchParams = function (url, ...objects) {
|
|
100
75
|
const searchParams = new URLSearchParams(url.search);
|
|
101
76
|
setFlattenedQueryParams(searchParams, objects);
|
|
102
77
|
url.search = searchParams.toString();
|
|
103
78
|
};
|
|
104
|
-
/**
|
|
105
|
-
*
|
|
106
|
-
* @export
|
|
107
|
-
*/
|
|
108
79
|
export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
109
80
|
const nonString = typeof value !== 'string';
|
|
110
81
|
const needsSerialization = nonString && configuration && configuration.isJsonMime
|
|
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
|
|
|
114
85
|
? JSON.stringify(value !== undefined ? value : {})
|
|
115
86
|
: (value || "");
|
|
116
87
|
};
|
|
117
|
-
/**
|
|
118
|
-
*
|
|
119
|
-
* @export
|
|
120
|
-
*/
|
|
121
88
|
export const toPathString = function (url) {
|
|
122
89
|
return url.pathname + url.search + url.hash;
|
|
123
90
|
};
|
|
124
|
-
/**
|
|
125
|
-
*
|
|
126
|
-
* @export
|
|
127
|
-
*/
|
|
128
91
|
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
129
92
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
130
93
|
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
@@ -15,49 +15,32 @@ export class Configuration {
|
|
|
15
15
|
/**
|
|
16
16
|
* parameter for apiKey security
|
|
17
17
|
* @param name security name
|
|
18
|
-
* @memberof Configuration
|
|
19
18
|
*/
|
|
20
19
|
apiKey;
|
|
21
20
|
/**
|
|
22
21
|
* parameter for basic security
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof Configuration
|
|
26
22
|
*/
|
|
27
23
|
username;
|
|
28
24
|
/**
|
|
29
25
|
* parameter for basic security
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof Configuration
|
|
33
26
|
*/
|
|
34
27
|
password;
|
|
35
28
|
/**
|
|
36
29
|
* parameter for oauth2 security
|
|
37
30
|
* @param name security name
|
|
38
31
|
* @param scopes oauth2 scope
|
|
39
|
-
* @memberof Configuration
|
|
40
32
|
*/
|
|
41
33
|
accessToken;
|
|
42
34
|
/**
|
|
43
35
|
* override base path
|
|
44
|
-
*
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof Configuration
|
|
47
36
|
*/
|
|
48
37
|
basePath;
|
|
49
38
|
/**
|
|
50
39
|
* override server index
|
|
51
|
-
*
|
|
52
|
-
* @type {number}
|
|
53
|
-
* @memberof Configuration
|
|
54
40
|
*/
|
|
55
41
|
serverIndex;
|
|
56
42
|
/**
|
|
57
43
|
* base options for axios calls
|
|
58
|
-
*
|
|
59
|
-
* @type {any}
|
|
60
|
-
* @memberof Configuration
|
|
61
44
|
*/
|
|
62
45
|
baseOptions;
|
|
63
46
|
/**
|