@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
|
@@ -19,12 +19,11 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
|
|
|
19
19
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
21
|
* OrdersApi - axios parameter creator
|
|
22
|
-
* @export
|
|
23
22
|
*/
|
|
24
23
|
export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
25
24
|
return {
|
|
26
25
|
/**
|
|
27
|
-
* 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
|
|
26
|
+
* 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).
|
|
28
27
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
29
28
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
30
29
|
* @param {*} [options] Override http request option.
|
|
@@ -57,7 +56,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
57
56
|
};
|
|
58
57
|
},
|
|
59
58
|
/**
|
|
60
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
59
|
+
* 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).
|
|
61
60
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
62
61
|
* @param {*} [options] Override http request option.
|
|
63
62
|
* @throws {RequiredError}
|
|
@@ -85,8 +84,8 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
85
84
|
};
|
|
86
85
|
},
|
|
87
86
|
/**
|
|
88
|
-
* 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
|
|
89
|
-
* @param {string} orderId
|
|
87
|
+
* 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).
|
|
88
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
90
89
|
* @param {*} [options] Override http request option.
|
|
91
90
|
* @throws {RequiredError}
|
|
92
91
|
*/
|
|
@@ -113,8 +112,8 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
113
112
|
};
|
|
114
113
|
},
|
|
115
114
|
/**
|
|
116
|
-
* 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
|
|
117
|
-
* @param {string} orderId
|
|
115
|
+
* 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).
|
|
116
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
118
117
|
* @param {*} [options] Override http request option.
|
|
119
118
|
* @throws {RequiredError}
|
|
120
119
|
*/
|
|
@@ -141,7 +140,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
141
140
|
};
|
|
142
141
|
},
|
|
143
142
|
/**
|
|
144
|
-
* 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
|
|
143
|
+
* 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).
|
|
145
144
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
146
145
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
147
146
|
* @param {*} [options] Override http request option.
|
|
@@ -173,7 +172,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
173
172
|
};
|
|
174
173
|
},
|
|
175
174
|
/**
|
|
176
|
-
* 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
|
|
175
|
+
* 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).
|
|
177
176
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
178
177
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
179
178
|
* @param {*} [options] Override http request option.
|
|
@@ -205,8 +204,8 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
205
204
|
};
|
|
206
205
|
},
|
|
207
206
|
/**
|
|
208
|
-
* 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
|
|
209
|
-
* @param {string} orderId
|
|
207
|
+
* 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).
|
|
208
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
210
209
|
* @param {*} [options] Override http request option.
|
|
211
210
|
* @throws {RequiredError}
|
|
212
211
|
*/
|
|
@@ -233,7 +232,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
233
232
|
};
|
|
234
233
|
},
|
|
235
234
|
/**
|
|
236
|
-
* 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
|
|
235
|
+
* 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).
|
|
237
236
|
* @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.
|
|
238
237
|
* @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.
|
|
239
238
|
* @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.
|
|
@@ -347,7 +346,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
347
346
|
};
|
|
348
347
|
},
|
|
349
348
|
/**
|
|
350
|
-
* 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
|
|
349
|
+
* 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).
|
|
351
350
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
352
351
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
353
352
|
* @param {*} [options] Override http request option.
|
|
@@ -380,8 +379,8 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
380
379
|
};
|
|
381
380
|
},
|
|
382
381
|
/**
|
|
383
|
-
* 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
|
|
384
|
-
* @param {string} orderId
|
|
382
|
+
* 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).
|
|
383
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
385
384
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
386
385
|
* @param {*} [options] Override http request option.
|
|
387
386
|
* @throws {RequiredError}
|
|
@@ -416,13 +415,12 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
416
415
|
};
|
|
417
416
|
/**
|
|
418
417
|
* OrdersApi - functional programming interface
|
|
419
|
-
* @export
|
|
420
418
|
*/
|
|
421
419
|
export const OrdersApiFp = function (configuration) {
|
|
422
420
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
|
|
423
421
|
return {
|
|
424
422
|
/**
|
|
425
|
-
* 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
|
|
423
|
+
* 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).
|
|
426
424
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
427
425
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
428
426
|
* @param {*} [options] Override http request option.
|
|
@@ -435,7 +433,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
435
433
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
436
434
|
},
|
|
437
435
|
/**
|
|
438
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
436
|
+
* 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).
|
|
439
437
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
440
438
|
* @param {*} [options] Override http request option.
|
|
441
439
|
* @throws {RequiredError}
|
|
@@ -447,8 +445,8 @@ export const OrdersApiFp = function (configuration) {
|
|
|
447
445
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
448
446
|
},
|
|
449
447
|
/**
|
|
450
|
-
* 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
|
|
451
|
-
* @param {string} orderId
|
|
448
|
+
* 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).
|
|
449
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
452
450
|
* @param {*} [options] Override http request option.
|
|
453
451
|
* @throws {RequiredError}
|
|
454
452
|
*/
|
|
@@ -459,8 +457,8 @@ export const OrdersApiFp = function (configuration) {
|
|
|
459
457
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
460
458
|
},
|
|
461
459
|
/**
|
|
462
|
-
* 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
|
|
463
|
-
* @param {string} orderId
|
|
460
|
+
* 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).
|
|
461
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
464
462
|
* @param {*} [options] Override http request option.
|
|
465
463
|
* @throws {RequiredError}
|
|
466
464
|
*/
|
|
@@ -471,7 +469,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
471
469
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
472
470
|
},
|
|
473
471
|
/**
|
|
474
|
-
* 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
|
|
472
|
+
* 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).
|
|
475
473
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
476
474
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
477
475
|
* @param {*} [options] Override http request option.
|
|
@@ -484,7 +482,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
484
482
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
485
483
|
},
|
|
486
484
|
/**
|
|
487
|
-
* 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
|
|
485
|
+
* 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).
|
|
488
486
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
489
487
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
490
488
|
* @param {*} [options] Override http request option.
|
|
@@ -497,8 +495,8 @@ export const OrdersApiFp = function (configuration) {
|
|
|
497
495
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
498
496
|
},
|
|
499
497
|
/**
|
|
500
|
-
* 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
|
|
501
|
-
* @param {string} orderId
|
|
498
|
+
* 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).
|
|
499
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
502
500
|
* @param {*} [options] Override http request option.
|
|
503
501
|
* @throws {RequiredError}
|
|
504
502
|
*/
|
|
@@ -509,7 +507,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
509
507
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
510
508
|
},
|
|
511
509
|
/**
|
|
512
|
-
* 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
|
|
510
|
+
* 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).
|
|
513
511
|
* @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.
|
|
514
512
|
* @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.
|
|
515
513
|
* @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.
|
|
@@ -542,7 +540,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
542
540
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
543
541
|
},
|
|
544
542
|
/**
|
|
545
|
-
* 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
|
|
543
|
+
* 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).
|
|
546
544
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
547
545
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
548
546
|
* @param {*} [options] Override http request option.
|
|
@@ -555,8 +553,8 @@ export const OrdersApiFp = function (configuration) {
|
|
|
555
553
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
556
554
|
},
|
|
557
555
|
/**
|
|
558
|
-
* 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
|
|
559
|
-
* @param {string} orderId
|
|
556
|
+
* 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).
|
|
557
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
560
558
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
561
559
|
* @param {*} [options] Override http request option.
|
|
562
560
|
* @throws {RequiredError}
|
|
@@ -571,13 +569,12 @@ export const OrdersApiFp = function (configuration) {
|
|
|
571
569
|
};
|
|
572
570
|
/**
|
|
573
571
|
* OrdersApi - factory interface
|
|
574
|
-
* @export
|
|
575
572
|
*/
|
|
576
573
|
export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
577
574
|
const localVarFp = OrdersApiFp(configuration);
|
|
578
575
|
return {
|
|
579
576
|
/**
|
|
580
|
-
* 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
|
|
577
|
+
* 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).
|
|
581
578
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
582
579
|
* @param {*} [options] Override http request option.
|
|
583
580
|
* @throws {RequiredError}
|
|
@@ -586,7 +583,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
586
583
|
return localVarFp.confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
587
584
|
},
|
|
588
585
|
/**
|
|
589
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
586
|
+
* 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).
|
|
590
587
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
591
588
|
* @param {*} [options] Override http request option.
|
|
592
589
|
* @throws {RequiredError}
|
|
@@ -595,7 +592,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
595
592
|
return localVarFp.getOrder(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
596
593
|
},
|
|
597
594
|
/**
|
|
598
|
-
* 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
|
|
595
|
+
* 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).
|
|
599
596
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
600
597
|
* @param {*} [options] Override http request option.
|
|
601
598
|
* @throws {RequiredError}
|
|
@@ -604,7 +601,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
604
601
|
return localVarFp.getOrderAddress(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
605
602
|
},
|
|
606
603
|
/**
|
|
607
|
-
* 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
|
|
604
|
+
* 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).
|
|
608
605
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
609
606
|
* @param {*} [options] Override http request option.
|
|
610
607
|
* @throws {RequiredError}
|
|
@@ -613,7 +610,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
613
610
|
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
614
611
|
},
|
|
615
612
|
/**
|
|
616
|
-
* 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
|
|
613
|
+
* 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).
|
|
617
614
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
618
615
|
* @param {*} [options] Override http request option.
|
|
619
616
|
* @throws {RequiredError}
|
|
@@ -622,7 +619,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
622
619
|
return localVarFp.getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
623
620
|
},
|
|
624
621
|
/**
|
|
625
|
-
* 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
|
|
622
|
+
* 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).
|
|
626
623
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
627
624
|
* @param {*} [options] Override http request option.
|
|
628
625
|
* @throws {RequiredError}
|
|
@@ -631,7 +628,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
631
628
|
return localVarFp.getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
632
629
|
},
|
|
633
630
|
/**
|
|
634
|
-
* 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
|
|
631
|
+
* 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).
|
|
635
632
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
636
633
|
* @param {*} [options] Override http request option.
|
|
637
634
|
* @throws {RequiredError}
|
|
@@ -640,7 +637,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
640
637
|
return localVarFp.getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
641
638
|
},
|
|
642
639
|
/**
|
|
643
|
-
* 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
|
|
640
|
+
* 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).
|
|
644
641
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
645
642
|
* @param {*} [options] Override http request option.
|
|
646
643
|
* @throws {RequiredError}
|
|
@@ -649,7 +646,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
649
646
|
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));
|
|
650
647
|
},
|
|
651
648
|
/**
|
|
652
|
-
* 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
|
|
649
|
+
* 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).
|
|
653
650
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
654
651
|
* @param {*} [options] Override http request option.
|
|
655
652
|
* @throws {RequiredError}
|
|
@@ -658,7 +655,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
658
655
|
return localVarFp.updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
659
656
|
},
|
|
660
657
|
/**
|
|
661
|
-
* 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
|
|
658
|
+
* 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).
|
|
662
659
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
663
660
|
* @param {*} [options] Override http request option.
|
|
664
661
|
* @throws {RequiredError}
|
|
@@ -670,107 +667,94 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
670
667
|
};
|
|
671
668
|
/**
|
|
672
669
|
* OrdersApi - object-oriented interface
|
|
673
|
-
* @export
|
|
674
|
-
* @class OrdersApi
|
|
675
|
-
* @extends {BaseAPI}
|
|
676
670
|
*/
|
|
677
671
|
export class OrdersApi extends BaseAPI {
|
|
678
672
|
/**
|
|
679
|
-
* 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
|
|
673
|
+
* 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).
|
|
680
674
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
681
675
|
* @param {*} [options] Override http request option.
|
|
682
676
|
* @throws {RequiredError}
|
|
683
|
-
* @memberof OrdersApi
|
|
684
677
|
*/
|
|
685
678
|
confirmShipment(requestParameters, options) {
|
|
686
679
|
return OrdersApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
687
680
|
}
|
|
688
681
|
/**
|
|
689
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
682
|
+
* 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).
|
|
690
683
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
691
684
|
* @param {*} [options] Override http request option.
|
|
692
685
|
* @throws {RequiredError}
|
|
693
|
-
* @memberof OrdersApi
|
|
694
686
|
*/
|
|
695
687
|
getOrder(requestParameters, options) {
|
|
696
688
|
return OrdersApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
697
689
|
}
|
|
698
690
|
/**
|
|
699
|
-
* 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
|
|
691
|
+
* 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).
|
|
700
692
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
701
693
|
* @param {*} [options] Override http request option.
|
|
702
694
|
* @throws {RequiredError}
|
|
703
|
-
* @memberof OrdersApi
|
|
704
695
|
*/
|
|
705
696
|
getOrderAddress(requestParameters, options) {
|
|
706
697
|
return OrdersApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
707
698
|
}
|
|
708
699
|
/**
|
|
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
|
|
700
|
+
* 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).
|
|
710
701
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
711
702
|
* @param {*} [options] Override http request option.
|
|
712
703
|
* @throws {RequiredError}
|
|
713
|
-
* @memberof OrdersApi
|
|
714
704
|
*/
|
|
715
705
|
getOrderBuyerInfo(requestParameters, options) {
|
|
716
706
|
return OrdersApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
717
707
|
}
|
|
718
708
|
/**
|
|
719
|
-
* 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
|
|
709
|
+
* 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).
|
|
720
710
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
721
711
|
* @param {*} [options] Override http request option.
|
|
722
712
|
* @throws {RequiredError}
|
|
723
|
-
* @memberof OrdersApi
|
|
724
713
|
*/
|
|
725
714
|
getOrderItems(requestParameters, options) {
|
|
726
715
|
return OrdersApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
727
716
|
}
|
|
728
717
|
/**
|
|
729
|
-
* 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
|
|
718
|
+
* 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).
|
|
730
719
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
731
720
|
* @param {*} [options] Override http request option.
|
|
732
721
|
* @throws {RequiredError}
|
|
733
|
-
* @memberof OrdersApi
|
|
734
722
|
*/
|
|
735
723
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
736
724
|
return OrdersApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
737
725
|
}
|
|
738
726
|
/**
|
|
739
|
-
* 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
|
|
727
|
+
* 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).
|
|
740
728
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
741
729
|
* @param {*} [options] Override http request option.
|
|
742
730
|
* @throws {RequiredError}
|
|
743
|
-
* @memberof OrdersApi
|
|
744
731
|
*/
|
|
745
732
|
getOrderRegulatedInfo(requestParameters, options) {
|
|
746
733
|
return OrdersApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
747
734
|
}
|
|
748
735
|
/**
|
|
749
|
-
* 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
|
|
736
|
+
* 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).
|
|
750
737
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
751
738
|
* @param {*} [options] Override http request option.
|
|
752
739
|
* @throws {RequiredError}
|
|
753
|
-
* @memberof OrdersApi
|
|
754
740
|
*/
|
|
755
741
|
getOrders(requestParameters, options) {
|
|
756
742
|
return 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));
|
|
757
743
|
}
|
|
758
744
|
/**
|
|
759
|
-
* 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
|
|
745
|
+
* 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).
|
|
760
746
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
761
747
|
* @param {*} [options] Override http request option.
|
|
762
748
|
* @throws {RequiredError}
|
|
763
|
-
* @memberof OrdersApi
|
|
764
749
|
*/
|
|
765
750
|
updateShipmentStatus(requestParameters, options) {
|
|
766
751
|
return OrdersApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
767
752
|
}
|
|
768
753
|
/**
|
|
769
|
-
* 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
|
|
754
|
+
* 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).
|
|
770
755
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
771
756
|
* @param {*} [options] Override http request option.
|
|
772
757
|
* @throws {RequiredError}
|
|
773
|
-
* @memberof OrdersApi
|
|
774
758
|
*/
|
|
775
759
|
updateVerificationStatus(requestParameters, options) {
|
|
776
760
|
return OrdersApiFp(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, 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 = {};
|