@sp-api-sdk/orders-api-v0 5.0.0 → 5.1.1
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/orders-api.js +48 -64
- 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/association-type.js +0 -2
- package/dist/cjs/api-model/models/constraint-type.js +0 -2
- package/dist/cjs/api-model/models/easy-ship-shipment-status.js +0 -2
- package/dist/cjs/api-model/models/electronic-invoice-status.js +0 -2
- package/dist/cjs/api-model/models/index.js +0 -1
- package/dist/cjs/api-model/models/other-delivery-attributes.js +0 -2
- package/dist/cjs/api-model/models/shipment-status.js +0 -2
- package/dist/cjs/api-model/models/verification-status.js +0 -2
- package/dist/es/api-model/api/orders-api.js +48 -64
- 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/association-type.js +0 -2
- package/dist/es/api-model/models/constraint-type.js +0 -2
- package/dist/es/api-model/models/easy-ship-shipment-status.js +0 -2
- package/dist/es/api-model/models/electronic-invoice-status.js +0 -2
- package/dist/es/api-model/models/index.js +0 -1
- package/dist/es/api-model/models/other-delivery-attributes.js +0 -2
- package/dist/es/api-model/models/shipment-status.js +0 -2
- package/dist/es/api-model/models/verification-status.js +0 -2
- package/dist/types/api-model/api/orders-api.d.ts +52 -160
- 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/address-extended-fields.d.ts +0 -10
- package/dist/types/api-model/models/address.d.ts +0 -35
- package/dist/types/api-model/models/amazon-programs.d.ts +2 -6
- package/dist/types/api-model/models/associated-item.d.ts +0 -11
- package/dist/types/api-model/models/association-type.d.ts +0 -2
- package/dist/types/api-model/models/automated-shipping-settings.d.ts +0 -8
- package/dist/types/api-model/models/business-hours.d.ts +0 -6
- package/dist/types/api-model/models/buyer-customized-info-detail.d.ts +0 -4
- package/dist/types/api-model/models/buyer-info.d.ts +0 -15
- package/dist/types/api-model/models/buyer-requested-cancel.d.ts +0 -6
- package/dist/types/api-model/models/buyer-tax-info.d.ts +0 -8
- package/dist/types/api-model/models/buyer-tax-information.d.ts +0 -10
- package/dist/types/api-model/models/confirm-shipment-error-response.d.ts +0 -4
- package/dist/types/api-model/models/confirm-shipment-order-item.d.ts +0 -8
- package/dist/types/api-model/models/confirm-shipment-request.d.ts +0 -11
- package/dist/types/api-model/models/constraint-type.d.ts +0 -2
- package/dist/types/api-model/models/delivery-preferences.d.ts +0 -13
- package/dist/types/api-model/models/easy-ship-shipment-status.d.ts +0 -2
- package/dist/types/api-model/models/electronic-invoice-status.d.ts +0 -2
- package/dist/types/api-model/models/exception-dates.d.ts +0 -8
- package/dist/types/api-model/models/fulfillment-instruction.d.ts +0 -4
- package/dist/types/api-model/models/get-order-address-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-buyer-info-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-items-buyer-info-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-items-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-regulated-info-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-response.d.ts +0 -9
- package/dist/types/api-model/models/get-orders-response.d.ts +0 -9
- package/dist/types/api-model/models/index.d.ts +0 -1
- package/dist/types/api-model/models/item-buyer-info.d.ts +0 -21
- package/dist/types/api-model/models/marketplace-tax-info.d.ts +0 -4
- package/dist/types/api-model/models/measurement.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/open-interval.d.ts +0 -12
- package/dist/types/api-model/models/open-time-interval.d.ts +0 -6
- package/dist/types/api-model/models/order-address.d.ts +0 -16
- package/dist/types/api-model/models/order-buyer-info.d.ts +0 -17
- package/dist/types/api-model/models/order-item-buyer-info.d.ts +0 -23
- package/dist/types/api-model/models/order-item.d.ts +0 -146
- package/dist/types/api-model/models/order-items-buyer-info-list.d.ts +0 -8
- package/dist/types/api-model/models/order-items-inner.d.ts +0 -9
- package/dist/types/api-model/models/order-items-list.d.ts +0 -8
- package/dist/types/api-model/models/order-regulated-info.d.ts +0 -16
- package/dist/types/api-model/models/order.d.ts +0 -126
- package/dist/types/api-model/models/orders-list.d.ts +1 -11
- package/dist/types/api-model/models/other-delivery-attributes.d.ts +0 -2
- package/dist/types/api-model/models/package-detail.d.ts +1 -19
- package/dist/types/api-model/models/payment-execution-detail-item.d.ts +0 -9
- package/dist/types/api-model/models/points-granted-detail.d.ts +0 -9
- package/dist/types/api-model/models/preferred-delivery-time.d.ts +0 -6
- package/dist/types/api-model/models/prescription-detail.d.ts +0 -16
- package/dist/types/api-model/models/product-info-detail.d.ts +0 -4
- package/dist/types/api-model/models/regulated-information-field.d.ts +0 -10
- package/dist/types/api-model/models/regulated-information.d.ts +0 -4
- package/dist/types/api-model/models/regulated-order-verification-status.d.ts +0 -22
- package/dist/types/api-model/models/rejection-reason.d.ts +0 -6
- package/dist/types/api-model/models/shipment-status.d.ts +0 -2
- package/dist/types/api-model/models/shipping-constraints.d.ts +0 -22
- package/dist/types/api-model/models/substitution-option.d.ts +0 -15
- package/dist/types/api-model/models/substitution-preferences.d.ts +0 -6
- package/dist/types/api-model/models/tax-classification.d.ts +0 -6
- package/dist/types/api-model/models/tax-collection.d.ts +0 -6
- package/dist/types/api-model/models/update-shipment-status-error-response.d.ts +0 -4
- package/dist/types/api-model/models/update-shipment-status-request.d.ts +0 -11
- package/dist/types/api-model/models/update-verification-status-error-response.d.ts +0 -4
- package/dist/types/api-model/models/update-verification-status-request-body.d.ts +0 -16
- package/dist/types/api-model/models/update-verification-status-request.d.ts +0 -7
- package/dist/types/api-model/models/valid-verification-detail.d.ts +0 -6
- package/dist/types/api-model/models/verification-details.d.ts +0 -7
- package/dist/types/api-model/models/verification-status.d.ts +0 -2
- package/package.json +25 -4
- package/dist/cjs/api-model/models/export-info.js +0 -15
- package/dist/es/api-model/models/export-info.js +0 -14
- package/dist/types/api-model/models/export-info.d.ts +0 -31
|
@@ -25,12 +25,11 @@ const common_1 = require("../common");
|
|
|
25
25
|
const base_1 = require("../base");
|
|
26
26
|
/**
|
|
27
27
|
* OrdersApi - axios parameter creator
|
|
28
|
-
* @export
|
|
29
28
|
*/
|
|
30
29
|
const OrdersApiAxiosParamCreator = function (configuration) {
|
|
31
30
|
return {
|
|
32
31
|
/**
|
|
33
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
32
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
33
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
35
34
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
36
35
|
* @param {*} [options] Override http request option.
|
|
@@ -63,7 +62,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
63
62
|
};
|
|
64
63
|
},
|
|
65
64
|
/**
|
|
66
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
65
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
67
66
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
68
67
|
* @param {*} [options] Override http request option.
|
|
69
68
|
* @throws {RequiredError}
|
|
@@ -91,8 +90,8 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
91
90
|
};
|
|
92
91
|
},
|
|
93
92
|
/**
|
|
94
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
95
|
-
* @param {string} orderId
|
|
93
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
94
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
96
95
|
* @param {*} [options] Override http request option.
|
|
97
96
|
* @throws {RequiredError}
|
|
98
97
|
*/
|
|
@@ -119,8 +118,8 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
119
118
|
};
|
|
120
119
|
},
|
|
121
120
|
/**
|
|
122
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
123
|
-
* @param {string} orderId
|
|
121
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
122
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
124
123
|
* @param {*} [options] Override http request option.
|
|
125
124
|
* @throws {RequiredError}
|
|
126
125
|
*/
|
|
@@ -147,7 +146,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
147
146
|
};
|
|
148
147
|
},
|
|
149
148
|
/**
|
|
150
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
149
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
151
150
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
152
151
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
153
152
|
* @param {*} [options] Override http request option.
|
|
@@ -179,7 +178,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
179
178
|
};
|
|
180
179
|
},
|
|
181
180
|
/**
|
|
182
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
181
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
183
182
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
184
183
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
185
184
|
* @param {*} [options] Override http request option.
|
|
@@ -211,8 +210,8 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
211
210
|
};
|
|
212
211
|
},
|
|
213
212
|
/**
|
|
214
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
215
|
-
* @param {string} orderId
|
|
213
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
214
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
216
215
|
* @param {*} [options] Override http request option.
|
|
217
216
|
* @throws {RequiredError}
|
|
218
217
|
*/
|
|
@@ -239,7 +238,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
239
238
|
};
|
|
240
239
|
},
|
|
241
240
|
/**
|
|
242
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
241
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
243
242
|
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
244
243
|
* @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
245
244
|
* @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
@@ -353,7 +352,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
353
352
|
};
|
|
354
353
|
},
|
|
355
354
|
/**
|
|
356
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
355
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
357
356
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
358
357
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
359
358
|
* @param {*} [options] Override http request option.
|
|
@@ -386,8 +385,8 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
386
385
|
};
|
|
387
386
|
},
|
|
388
387
|
/**
|
|
389
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
390
|
-
* @param {string} orderId
|
|
388
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
389
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
391
390
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
392
391
|
* @param {*} [options] Override http request option.
|
|
393
392
|
* @throws {RequiredError}
|
|
@@ -423,13 +422,12 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
423
422
|
exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
|
|
424
423
|
/**
|
|
425
424
|
* OrdersApi - functional programming interface
|
|
426
|
-
* @export
|
|
427
425
|
*/
|
|
428
426
|
const OrdersApiFp = function (configuration) {
|
|
429
427
|
const localVarAxiosParamCreator = (0, exports.OrdersApiAxiosParamCreator)(configuration);
|
|
430
428
|
return {
|
|
431
429
|
/**
|
|
432
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
430
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
433
431
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
434
432
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
435
433
|
* @param {*} [options] Override http request option.
|
|
@@ -442,7 +440,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
442
440
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
443
441
|
},
|
|
444
442
|
/**
|
|
445
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
443
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
446
444
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
447
445
|
* @param {*} [options] Override http request option.
|
|
448
446
|
* @throws {RequiredError}
|
|
@@ -454,8 +452,8 @@ const OrdersApiFp = function (configuration) {
|
|
|
454
452
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
455
453
|
},
|
|
456
454
|
/**
|
|
457
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
458
|
-
* @param {string} orderId
|
|
455
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
456
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
459
457
|
* @param {*} [options] Override http request option.
|
|
460
458
|
* @throws {RequiredError}
|
|
461
459
|
*/
|
|
@@ -466,8 +464,8 @@ const OrdersApiFp = function (configuration) {
|
|
|
466
464
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
467
465
|
},
|
|
468
466
|
/**
|
|
469
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
470
|
-
* @param {string} orderId
|
|
467
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
468
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
471
469
|
* @param {*} [options] Override http request option.
|
|
472
470
|
* @throws {RequiredError}
|
|
473
471
|
*/
|
|
@@ -478,7 +476,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
478
476
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
479
477
|
},
|
|
480
478
|
/**
|
|
481
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
479
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
482
480
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
483
481
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
484
482
|
* @param {*} [options] Override http request option.
|
|
@@ -491,7 +489,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
491
489
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
492
490
|
},
|
|
493
491
|
/**
|
|
494
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
492
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
495
493
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
496
494
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
497
495
|
* @param {*} [options] Override http request option.
|
|
@@ -504,8 +502,8 @@ const OrdersApiFp = function (configuration) {
|
|
|
504
502
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
505
503
|
},
|
|
506
504
|
/**
|
|
507
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
508
|
-
* @param {string} orderId
|
|
505
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
506
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
509
507
|
* @param {*} [options] Override http request option.
|
|
510
508
|
* @throws {RequiredError}
|
|
511
509
|
*/
|
|
@@ -516,7 +514,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
516
514
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
517
515
|
},
|
|
518
516
|
/**
|
|
519
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
517
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
520
518
|
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
521
519
|
* @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
522
520
|
* @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
@@ -549,7 +547,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
549
547
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
550
548
|
},
|
|
551
549
|
/**
|
|
552
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
550
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
553
551
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
554
552
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
555
553
|
* @param {*} [options] Override http request option.
|
|
@@ -562,8 +560,8 @@ const OrdersApiFp = function (configuration) {
|
|
|
562
560
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
563
561
|
},
|
|
564
562
|
/**
|
|
565
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
566
|
-
* @param {string} orderId
|
|
563
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
564
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
567
565
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
568
566
|
* @param {*} [options] Override http request option.
|
|
569
567
|
* @throws {RequiredError}
|
|
@@ -579,13 +577,12 @@ const OrdersApiFp = function (configuration) {
|
|
|
579
577
|
exports.OrdersApiFp = OrdersApiFp;
|
|
580
578
|
/**
|
|
581
579
|
* OrdersApi - factory interface
|
|
582
|
-
* @export
|
|
583
580
|
*/
|
|
584
581
|
const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
585
582
|
const localVarFp = (0, exports.OrdersApiFp)(configuration);
|
|
586
583
|
return {
|
|
587
584
|
/**
|
|
588
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
585
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
589
586
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
590
587
|
* @param {*} [options] Override http request option.
|
|
591
588
|
* @throws {RequiredError}
|
|
@@ -594,7 +591,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
594
591
|
return localVarFp.confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
595
592
|
},
|
|
596
593
|
/**
|
|
597
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
594
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
598
595
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
599
596
|
* @param {*} [options] Override http request option.
|
|
600
597
|
* @throws {RequiredError}
|
|
@@ -603,7 +600,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
603
600
|
return localVarFp.getOrder(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
604
601
|
},
|
|
605
602
|
/**
|
|
606
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
603
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
607
604
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
608
605
|
* @param {*} [options] Override http request option.
|
|
609
606
|
* @throws {RequiredError}
|
|
@@ -612,7 +609,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
612
609
|
return localVarFp.getOrderAddress(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
613
610
|
},
|
|
614
611
|
/**
|
|
615
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
612
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
616
613
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
617
614
|
* @param {*} [options] Override http request option.
|
|
618
615
|
* @throws {RequiredError}
|
|
@@ -621,7 +618,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
621
618
|
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
622
619
|
},
|
|
623
620
|
/**
|
|
624
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
621
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
625
622
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
626
623
|
* @param {*} [options] Override http request option.
|
|
627
624
|
* @throws {RequiredError}
|
|
@@ -630,7 +627,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
630
627
|
return localVarFp.getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
631
628
|
},
|
|
632
629
|
/**
|
|
633
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
630
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
634
631
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
635
632
|
* @param {*} [options] Override http request option.
|
|
636
633
|
* @throws {RequiredError}
|
|
@@ -639,7 +636,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
639
636
|
return localVarFp.getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
640
637
|
},
|
|
641
638
|
/**
|
|
642
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
639
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
643
640
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
644
641
|
* @param {*} [options] Override http request option.
|
|
645
642
|
* @throws {RequiredError}
|
|
@@ -648,7 +645,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
648
645
|
return localVarFp.getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
649
646
|
},
|
|
650
647
|
/**
|
|
651
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
648
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
652
649
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
653
650
|
* @param {*} [options] Override http request option.
|
|
654
651
|
* @throws {RequiredError}
|
|
@@ -657,7 +654,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
657
654
|
return localVarFp.getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(axios, basePath));
|
|
658
655
|
},
|
|
659
656
|
/**
|
|
660
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
657
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
661
658
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
662
659
|
* @param {*} [options] Override http request option.
|
|
663
660
|
* @throws {RequiredError}
|
|
@@ -666,7 +663,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
666
663
|
return localVarFp.updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
667
664
|
},
|
|
668
665
|
/**
|
|
669
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
666
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
670
667
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
671
668
|
* @param {*} [options] Override http request option.
|
|
672
669
|
* @throws {RequiredError}
|
|
@@ -679,107 +676,94 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
679
676
|
exports.OrdersApiFactory = OrdersApiFactory;
|
|
680
677
|
/**
|
|
681
678
|
* OrdersApi - object-oriented interface
|
|
682
|
-
* @export
|
|
683
|
-
* @class OrdersApi
|
|
684
|
-
* @extends {BaseAPI}
|
|
685
679
|
*/
|
|
686
680
|
class OrdersApi extends base_1.BaseAPI {
|
|
687
681
|
/**
|
|
688
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
682
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
689
683
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
690
684
|
* @param {*} [options] Override http request option.
|
|
691
685
|
* @throws {RequiredError}
|
|
692
|
-
* @memberof OrdersApi
|
|
693
686
|
*/
|
|
694
687
|
confirmShipment(requestParameters, options) {
|
|
695
688
|
return (0, exports.OrdersApiFp)(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
696
689
|
}
|
|
697
690
|
/**
|
|
698
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
691
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
699
692
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
700
693
|
* @param {*} [options] Override http request option.
|
|
701
694
|
* @throws {RequiredError}
|
|
702
|
-
* @memberof OrdersApi
|
|
703
695
|
*/
|
|
704
696
|
getOrder(requestParameters, options) {
|
|
705
697
|
return (0, exports.OrdersApiFp)(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
706
698
|
}
|
|
707
699
|
/**
|
|
708
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
700
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
709
701
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
710
702
|
* @param {*} [options] Override http request option.
|
|
711
703
|
* @throws {RequiredError}
|
|
712
|
-
* @memberof OrdersApi
|
|
713
704
|
*/
|
|
714
705
|
getOrderAddress(requestParameters, options) {
|
|
715
706
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
716
707
|
}
|
|
717
708
|
/**
|
|
718
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
709
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
719
710
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
720
711
|
* @param {*} [options] Override http request option.
|
|
721
712
|
* @throws {RequiredError}
|
|
722
|
-
* @memberof OrdersApi
|
|
723
713
|
*/
|
|
724
714
|
getOrderBuyerInfo(requestParameters, options) {
|
|
725
715
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
726
716
|
}
|
|
727
717
|
/**
|
|
728
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
718
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
729
719
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
730
720
|
* @param {*} [options] Override http request option.
|
|
731
721
|
* @throws {RequiredError}
|
|
732
|
-
* @memberof OrdersApi
|
|
733
722
|
*/
|
|
734
723
|
getOrderItems(requestParameters, options) {
|
|
735
724
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
736
725
|
}
|
|
737
726
|
/**
|
|
738
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
727
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
739
728
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
740
729
|
* @param {*} [options] Override http request option.
|
|
741
730
|
* @throws {RequiredError}
|
|
742
|
-
* @memberof OrdersApi
|
|
743
731
|
*/
|
|
744
732
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
745
733
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
746
734
|
}
|
|
747
735
|
/**
|
|
748
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
736
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
749
737
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
750
738
|
* @param {*} [options] Override http request option.
|
|
751
739
|
* @throws {RequiredError}
|
|
752
|
-
* @memberof OrdersApi
|
|
753
740
|
*/
|
|
754
741
|
getOrderRegulatedInfo(requestParameters, options) {
|
|
755
742
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
756
743
|
}
|
|
757
744
|
/**
|
|
758
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
745
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
759
746
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
760
747
|
* @param {*} [options] Override http request option.
|
|
761
748
|
* @throws {RequiredError}
|
|
762
|
-
* @memberof OrdersApi
|
|
763
749
|
*/
|
|
764
750
|
getOrders(requestParameters, options) {
|
|
765
751
|
return (0, exports.OrdersApiFp)(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(this.axios, this.basePath));
|
|
766
752
|
}
|
|
767
753
|
/**
|
|
768
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
754
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
769
755
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
770
756
|
* @param {*} [options] Override http request option.
|
|
771
757
|
* @throws {RequiredError}
|
|
772
|
-
* @memberof OrdersApi
|
|
773
758
|
*/
|
|
774
759
|
updateShipmentStatus(requestParameters, options) {
|
|
775
760
|
return (0, exports.OrdersApiFp)(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
776
761
|
}
|
|
777
762
|
/**
|
|
778
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
763
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
779
764
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
780
765
|
* @param {*} [options] Override http request option.
|
|
781
766
|
* @throws {RequiredError}
|
|
782
|
-
* @memberof OrdersApi
|
|
783
767
|
*/
|
|
784
768
|
updateVerificationStatus(requestParameters, options) {
|
|
785
769
|
return (0, exports.OrdersApiFp)(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
19
19
|
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @export
|
|
25
|
-
*/
|
|
26
22
|
exports.COLLECTION_FORMATS = {
|
|
27
23
|
csv: ",",
|
|
28
24
|
ssv: " ",
|
|
29
25
|
tsv: "\t",
|
|
30
26
|
pipes: "|",
|
|
31
27
|
};
|
|
32
|
-
/**
|
|
33
|
-
*
|
|
34
|
-
* @export
|
|
35
|
-
* @class BaseAPI
|
|
36
|
-
*/
|
|
37
28
|
class BaseAPI {
|
|
38
29
|
basePath;
|
|
39
30
|
axios;
|
|
@@ -49,12 +40,6 @@ class BaseAPI {
|
|
|
49
40
|
}
|
|
50
41
|
exports.BaseAPI = BaseAPI;
|
|
51
42
|
;
|
|
52
|
-
/**
|
|
53
|
-
*
|
|
54
|
-
* @export
|
|
55
|
-
* @class RequiredError
|
|
56
|
-
* @extends {Error}
|
|
57
|
-
*/
|
|
58
43
|
class RequiredError extends Error {
|
|
59
44
|
field;
|
|
60
45
|
constructor(field, msg) {
|
|
@@ -64,8 +49,4 @@ class RequiredError extends Error {
|
|
|
64
49
|
}
|
|
65
50
|
}
|
|
66
51
|
exports.RequiredError = RequiredError;
|
|
67
|
-
/**
|
|
68
|
-
*
|
|
69
|
-
* @export
|
|
70
|
-
*/
|
|
71
52
|
exports.operationServerMap = {};
|