@sp-api-sdk/orders-api-v0 5.5.0 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/orders-api.js +24 -59
- package/dist/cjs/api-model/models/index.js +0 -9
- package/dist/cjs/client.js +0 -7
- package/dist/es/api-model/api/orders-api.js +24 -59
- package/dist/es/api-model/models/index.js +0 -9
- package/dist/es/client.js +0 -7
- package/dist/types/api-model/api/orders-api.d.ts +24 -38
- package/dist/types/api-model/models/index.d.ts +0 -9
- package/dist/types/api-model/models/order-item.d.ts +0 -2
- package/package.json +4 -4
- package/dist/cjs/api-model/models/export-info.js +0 -15
- package/dist/cjs/api-model/models/fulfillment-instructions.js +0 -15
- package/dist/cjs/api-model/models/fulfillment-location.js +0 -15
- package/dist/cjs/api-model/models/fulfillment-plan-constraint-type.js +0 -23
- package/dist/cjs/api-model/models/fulfillment-plan-item.js +0 -15
- package/dist/cjs/api-model/models/fulfillment-plan-shipping-constraints.js +0 -15
- package/dist/cjs/api-model/models/fulfillment-plan.js +0 -27
- package/dist/cjs/api-model/models/get-order-fulfillment-instructions-response.js +0 -15
- package/dist/cjs/api-model/models/shipping-instructions.js +0 -15
- package/dist/es/api-model/models/export-info.js +0 -14
- package/dist/es/api-model/models/fulfillment-instructions.js +0 -14
- package/dist/es/api-model/models/fulfillment-location.js +0 -14
- package/dist/es/api-model/models/fulfillment-plan-constraint-type.js +0 -20
- package/dist/es/api-model/models/fulfillment-plan-item.js +0 -14
- package/dist/es/api-model/models/fulfillment-plan-shipping-constraints.js +0 -14
- package/dist/es/api-model/models/fulfillment-plan.js +0 -24
- package/dist/es/api-model/models/get-order-fulfillment-instructions-response.js +0 -14
- package/dist/es/api-model/models/shipping-instructions.js +0 -14
- package/dist/types/api-model/models/export-info.d.ts +0 -22
- package/dist/types/api-model/models/fulfillment-instructions.d.ts +0 -25
- package/dist/types/api-model/models/fulfillment-location.d.ts +0 -20
- package/dist/types/api-model/models/fulfillment-plan-constraint-type.d.ts +0 -19
- package/dist/types/api-model/models/fulfillment-plan-item.d.ts +0 -22
- package/dist/types/api-model/models/fulfillment-plan-shipping-constraints.d.ts +0 -19
- package/dist/types/api-model/models/fulfillment-plan.d.ts +0 -58
- package/dist/types/api-model/models/get-order-fulfillment-instructions-response.d.ts +0 -22
- package/dist/types/api-model/models/shipping-instructions.d.ts +0 -26
|
@@ -66,6 +66,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
66
66
|
* 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
67
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
68
68
|
* @param {*} [options] Override http request option.
|
|
69
|
+
* @deprecated
|
|
69
70
|
* @throws {RequiredError}
|
|
70
71
|
*/
|
|
71
72
|
getOrder: async (orderId, options = {}) => {
|
|
@@ -95,6 +96,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
95
96
|
* 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).
|
|
96
97
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
97
98
|
* @param {*} [options] Override http request option.
|
|
99
|
+
* @deprecated
|
|
98
100
|
* @throws {RequiredError}
|
|
99
101
|
*/
|
|
100
102
|
getOrderAddress: async (orderId, options = {}) => {
|
|
@@ -124,6 +126,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
124
126
|
* 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).
|
|
125
127
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
126
128
|
* @param {*} [options] Override http request option.
|
|
129
|
+
* @deprecated
|
|
127
130
|
* @throws {RequiredError}
|
|
128
131
|
*/
|
|
129
132
|
getOrderBuyerInfo: async (orderId, options = {}) => {
|
|
@@ -149,40 +152,12 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
149
152
|
options: localVarRequestOptions,
|
|
150
153
|
};
|
|
151
154
|
},
|
|
152
|
-
/**
|
|
153
|
-
* Returns the fulfillment instructions 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).
|
|
154
|
-
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
155
|
-
* @param {*} [options] Override http request option.
|
|
156
|
-
* @throws {RequiredError}
|
|
157
|
-
*/
|
|
158
|
-
getOrderFulfillmentInstructions: async (orderId, options = {}) => {
|
|
159
|
-
// verify required parameter 'orderId' is not null or undefined
|
|
160
|
-
(0, common_1.assertParamExists)('getOrderFulfillmentInstructions', 'orderId', orderId);
|
|
161
|
-
const localVarPath = `/orders/v0/orders/{orderId}/fulfillmentInstructions`
|
|
162
|
-
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
163
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
164
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
165
|
-
let baseOptions;
|
|
166
|
-
if (configuration) {
|
|
167
|
-
baseOptions = configuration.baseOptions;
|
|
168
|
-
}
|
|
169
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
170
|
-
const localVarHeaderParameter = {};
|
|
171
|
-
const localVarQueryParameter = {};
|
|
172
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
173
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
174
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
175
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
176
|
-
return {
|
|
177
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
178
|
-
options: localVarRequestOptions,
|
|
179
|
-
};
|
|
180
|
-
},
|
|
181
155
|
/**
|
|
182
156
|
* 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).
|
|
183
157
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
184
158
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
185
159
|
* @param {*} [options] Override http request option.
|
|
160
|
+
* @deprecated
|
|
186
161
|
* @throws {RequiredError}
|
|
187
162
|
*/
|
|
188
163
|
getOrderItems: async (orderId, nextToken, options = {}) => {
|
|
@@ -216,6 +191,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
216
191
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
217
192
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
218
193
|
* @param {*} [options] Override http request option.
|
|
194
|
+
* @deprecated
|
|
219
195
|
* @throws {RequiredError}
|
|
220
196
|
*/
|
|
221
197
|
getOrderItemsBuyerInfo: async (orderId, nextToken, options = {}) => {
|
|
@@ -297,6 +273,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
297
273
|
* @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
298
274
|
* @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
299
275
|
* @param {*} [options] Override http request option.
|
|
276
|
+
* @deprecated
|
|
300
277
|
* @throws {RequiredError}
|
|
301
278
|
*/
|
|
302
279
|
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options = {}) => {
|
|
@@ -478,6 +455,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
478
455
|
* 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).
|
|
479
456
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
480
457
|
* @param {*} [options] Override http request option.
|
|
458
|
+
* @deprecated
|
|
481
459
|
* @throws {RequiredError}
|
|
482
460
|
*/
|
|
483
461
|
async getOrder(orderId, options) {
|
|
@@ -490,6 +468,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
490
468
|
* 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).
|
|
491
469
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
492
470
|
* @param {*} [options] Override http request option.
|
|
471
|
+
* @deprecated
|
|
493
472
|
* @throws {RequiredError}
|
|
494
473
|
*/
|
|
495
474
|
async getOrderAddress(orderId, options) {
|
|
@@ -502,6 +481,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
502
481
|
* 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).
|
|
503
482
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
504
483
|
* @param {*} [options] Override http request option.
|
|
484
|
+
* @deprecated
|
|
505
485
|
* @throws {RequiredError}
|
|
506
486
|
*/
|
|
507
487
|
async getOrderBuyerInfo(orderId, options) {
|
|
@@ -510,23 +490,12 @@ const OrdersApiFp = function (configuration) {
|
|
|
510
490
|
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
511
491
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
512
492
|
},
|
|
513
|
-
/**
|
|
514
|
-
* Returns the fulfillment instructions 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).
|
|
515
|
-
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
516
|
-
* @param {*} [options] Override http request option.
|
|
517
|
-
* @throws {RequiredError}
|
|
518
|
-
*/
|
|
519
|
-
async getOrderFulfillmentInstructions(orderId, options) {
|
|
520
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderFulfillmentInstructions(orderId, options);
|
|
521
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
522
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderFulfillmentInstructions']?.[localVarOperationServerIndex]?.url;
|
|
523
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
524
|
-
},
|
|
525
493
|
/**
|
|
526
494
|
* 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).
|
|
527
495
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
528
496
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
529
497
|
* @param {*} [options] Override http request option.
|
|
498
|
+
* @deprecated
|
|
530
499
|
* @throws {RequiredError}
|
|
531
500
|
*/
|
|
532
501
|
async getOrderItems(orderId, nextToken, options) {
|
|
@@ -540,6 +509,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
540
509
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
541
510
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
542
511
|
* @param {*} [options] Override http request option.
|
|
512
|
+
* @deprecated
|
|
543
513
|
* @throws {RequiredError}
|
|
544
514
|
*/
|
|
545
515
|
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
@@ -584,6 +554,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
584
554
|
* @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
585
555
|
* @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
586
556
|
* @param {*} [options] Override http request option.
|
|
557
|
+
* @deprecated
|
|
587
558
|
* @throws {RequiredError}
|
|
588
559
|
*/
|
|
589
560
|
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options) {
|
|
@@ -640,6 +611,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
640
611
|
* 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).
|
|
641
612
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
642
613
|
* @param {*} [options] Override http request option.
|
|
614
|
+
* @deprecated
|
|
643
615
|
* @throws {RequiredError}
|
|
644
616
|
*/
|
|
645
617
|
getOrder(requestParameters, options) {
|
|
@@ -649,6 +621,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
649
621
|
* 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).
|
|
650
622
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
651
623
|
* @param {*} [options] Override http request option.
|
|
624
|
+
* @deprecated
|
|
652
625
|
* @throws {RequiredError}
|
|
653
626
|
*/
|
|
654
627
|
getOrderAddress(requestParameters, options) {
|
|
@@ -658,24 +631,17 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
658
631
|
* 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).
|
|
659
632
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
660
633
|
* @param {*} [options] Override http request option.
|
|
634
|
+
* @deprecated
|
|
661
635
|
* @throws {RequiredError}
|
|
662
636
|
*/
|
|
663
637
|
getOrderBuyerInfo(requestParameters, options) {
|
|
664
638
|
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
665
639
|
},
|
|
666
|
-
/**
|
|
667
|
-
* Returns the fulfillment instructions 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).
|
|
668
|
-
* @param {OrdersApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters.
|
|
669
|
-
* @param {*} [options] Override http request option.
|
|
670
|
-
* @throws {RequiredError}
|
|
671
|
-
*/
|
|
672
|
-
getOrderFulfillmentInstructions(requestParameters, options) {
|
|
673
|
-
return localVarFp.getOrderFulfillmentInstructions(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
674
|
-
},
|
|
675
640
|
/**
|
|
676
641
|
* 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).
|
|
677
642
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
678
643
|
* @param {*} [options] Override http request option.
|
|
644
|
+
* @deprecated
|
|
679
645
|
* @throws {RequiredError}
|
|
680
646
|
*/
|
|
681
647
|
getOrderItems(requestParameters, options) {
|
|
@@ -685,6 +651,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
685
651
|
* 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).
|
|
686
652
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
687
653
|
* @param {*} [options] Override http request option.
|
|
654
|
+
* @deprecated
|
|
688
655
|
* @throws {RequiredError}
|
|
689
656
|
*/
|
|
690
657
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
@@ -703,6 +670,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
703
670
|
* 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).
|
|
704
671
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
705
672
|
* @param {*} [options] Override http request option.
|
|
673
|
+
* @deprecated
|
|
706
674
|
* @throws {RequiredError}
|
|
707
675
|
*/
|
|
708
676
|
getOrders(requestParameters, options) {
|
|
@@ -746,6 +714,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
746
714
|
* 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).
|
|
747
715
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
748
716
|
* @param {*} [options] Override http request option.
|
|
717
|
+
* @deprecated
|
|
749
718
|
* @throws {RequiredError}
|
|
750
719
|
*/
|
|
751
720
|
getOrder(requestParameters, options) {
|
|
@@ -755,6 +724,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
755
724
|
* 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).
|
|
756
725
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
757
726
|
* @param {*} [options] Override http request option.
|
|
727
|
+
* @deprecated
|
|
758
728
|
* @throws {RequiredError}
|
|
759
729
|
*/
|
|
760
730
|
getOrderAddress(requestParameters, options) {
|
|
@@ -764,24 +734,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
764
734
|
* 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).
|
|
765
735
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
766
736
|
* @param {*} [options] Override http request option.
|
|
737
|
+
* @deprecated
|
|
767
738
|
* @throws {RequiredError}
|
|
768
739
|
*/
|
|
769
740
|
getOrderBuyerInfo(requestParameters, options) {
|
|
770
741
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
771
742
|
}
|
|
772
|
-
/**
|
|
773
|
-
* Returns the fulfillment instructions 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).
|
|
774
|
-
* @param {OrdersApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters.
|
|
775
|
-
* @param {*} [options] Override http request option.
|
|
776
|
-
* @throws {RequiredError}
|
|
777
|
-
*/
|
|
778
|
-
getOrderFulfillmentInstructions(requestParameters, options) {
|
|
779
|
-
return (0, exports.OrdersApiFp)(this.configuration).getOrderFulfillmentInstructions(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
780
|
-
}
|
|
781
743
|
/**
|
|
782
744
|
* 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).
|
|
783
745
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
784
746
|
* @param {*} [options] Override http request option.
|
|
747
|
+
* @deprecated
|
|
785
748
|
* @throws {RequiredError}
|
|
786
749
|
*/
|
|
787
750
|
getOrderItems(requestParameters, options) {
|
|
@@ -791,6 +754,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
791
754
|
* 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).
|
|
792
755
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
793
756
|
* @param {*} [options] Override http request option.
|
|
757
|
+
* @deprecated
|
|
794
758
|
* @throws {RequiredError}
|
|
795
759
|
*/
|
|
796
760
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
@@ -809,6 +773,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
809
773
|
* 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).
|
|
810
774
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
811
775
|
* @param {*} [options] Override http request option.
|
|
776
|
+
* @deprecated
|
|
812
777
|
* @throws {RequiredError}
|
|
813
778
|
*/
|
|
814
779
|
getOrders(requestParameters, options) {
|
|
@@ -34,17 +34,9 @@ __exportStar(require("./delivery-preferences"), exports);
|
|
|
34
34
|
__exportStar(require("./easy-ship-shipment-status"), exports);
|
|
35
35
|
__exportStar(require("./electronic-invoice-status"), exports);
|
|
36
36
|
__exportStar(require("./exception-dates"), exports);
|
|
37
|
-
__exportStar(require("./export-info"), exports);
|
|
38
37
|
__exportStar(require("./fulfillment-instruction"), exports);
|
|
39
|
-
__exportStar(require("./fulfillment-instructions"), exports);
|
|
40
|
-
__exportStar(require("./fulfillment-location"), exports);
|
|
41
|
-
__exportStar(require("./fulfillment-plan"), exports);
|
|
42
|
-
__exportStar(require("./fulfillment-plan-constraint-type"), exports);
|
|
43
|
-
__exportStar(require("./fulfillment-plan-item"), exports);
|
|
44
|
-
__exportStar(require("./fulfillment-plan-shipping-constraints"), exports);
|
|
45
38
|
__exportStar(require("./get-order-address-response"), exports);
|
|
46
39
|
__exportStar(require("./get-order-buyer-info-response"), exports);
|
|
47
|
-
__exportStar(require("./get-order-fulfillment-instructions-response"), exports);
|
|
48
40
|
__exportStar(require("./get-order-items-buyer-info-response"), exports);
|
|
49
41
|
__exportStar(require("./get-order-items-response"), exports);
|
|
50
42
|
__exportStar(require("./get-order-regulated-info-response"), exports);
|
|
@@ -80,7 +72,6 @@ __exportStar(require("./regulated-order-verification-status"), exports);
|
|
|
80
72
|
__exportStar(require("./rejection-reason"), exports);
|
|
81
73
|
__exportStar(require("./shipment-status"), exports);
|
|
82
74
|
__exportStar(require("./shipping-constraints"), exports);
|
|
83
|
-
__exportStar(require("./shipping-instructions"), exports);
|
|
84
75
|
__exportStar(require("./substitution-option"), exports);
|
|
85
76
|
__exportStar(require("./substitution-preferences"), exports);
|
|
86
77
|
__exportStar(require("./tax-classification"), exports);
|
package/dist/cjs/client.js
CHANGED
|
@@ -32,13 +32,6 @@ exports.clientRateLimits = [
|
|
|
32
32
|
rate: 0.5,
|
|
33
33
|
burst: 30,
|
|
34
34
|
},
|
|
35
|
-
{
|
|
36
|
-
method: 'get',
|
|
37
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
38
|
-
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/fulfillmentInstructions$'),
|
|
39
|
-
rate: 0.5,
|
|
40
|
-
burst: 30,
|
|
41
|
-
},
|
|
42
35
|
{
|
|
43
36
|
method: 'get',
|
|
44
37
|
// eslint-disable-next-line prefer-regex-literals
|
|
@@ -60,6 +60,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
60
60
|
* 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
61
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
63
|
+
* @deprecated
|
|
63
64
|
* @throws {RequiredError}
|
|
64
65
|
*/
|
|
65
66
|
getOrder: async (orderId, options = {}) => {
|
|
@@ -89,6 +90,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
89
90
|
* 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).
|
|
90
91
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
91
92
|
* @param {*} [options] Override http request option.
|
|
93
|
+
* @deprecated
|
|
92
94
|
* @throws {RequiredError}
|
|
93
95
|
*/
|
|
94
96
|
getOrderAddress: async (orderId, options = {}) => {
|
|
@@ -118,6 +120,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
118
120
|
* 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).
|
|
119
121
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
120
122
|
* @param {*} [options] Override http request option.
|
|
123
|
+
* @deprecated
|
|
121
124
|
* @throws {RequiredError}
|
|
122
125
|
*/
|
|
123
126
|
getOrderBuyerInfo: async (orderId, options = {}) => {
|
|
@@ -143,40 +146,12 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
143
146
|
options: localVarRequestOptions,
|
|
144
147
|
};
|
|
145
148
|
},
|
|
146
|
-
/**
|
|
147
|
-
* Returns the fulfillment instructions 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).
|
|
148
|
-
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
149
|
-
* @param {*} [options] Override http request option.
|
|
150
|
-
* @throws {RequiredError}
|
|
151
|
-
*/
|
|
152
|
-
getOrderFulfillmentInstructions: async (orderId, options = {}) => {
|
|
153
|
-
// verify required parameter 'orderId' is not null or undefined
|
|
154
|
-
assertParamExists('getOrderFulfillmentInstructions', 'orderId', orderId);
|
|
155
|
-
const localVarPath = `/orders/v0/orders/{orderId}/fulfillmentInstructions`
|
|
156
|
-
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
157
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
158
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
159
|
-
let baseOptions;
|
|
160
|
-
if (configuration) {
|
|
161
|
-
baseOptions = configuration.baseOptions;
|
|
162
|
-
}
|
|
163
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
164
|
-
const localVarHeaderParameter = {};
|
|
165
|
-
const localVarQueryParameter = {};
|
|
166
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
167
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
168
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
169
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
170
|
-
return {
|
|
171
|
-
url: toPathString(localVarUrlObj),
|
|
172
|
-
options: localVarRequestOptions,
|
|
173
|
-
};
|
|
174
|
-
},
|
|
175
149
|
/**
|
|
176
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 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
151
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
178
152
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
179
153
|
* @param {*} [options] Override http request option.
|
|
154
|
+
* @deprecated
|
|
180
155
|
* @throws {RequiredError}
|
|
181
156
|
*/
|
|
182
157
|
getOrderItems: async (orderId, nextToken, options = {}) => {
|
|
@@ -210,6 +185,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
210
185
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
211
186
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
212
187
|
* @param {*} [options] Override http request option.
|
|
188
|
+
* @deprecated
|
|
213
189
|
* @throws {RequiredError}
|
|
214
190
|
*/
|
|
215
191
|
getOrderItemsBuyerInfo: async (orderId, nextToken, options = {}) => {
|
|
@@ -291,6 +267,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
291
267
|
* @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
292
268
|
* @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
293
269
|
* @param {*} [options] Override http request option.
|
|
270
|
+
* @deprecated
|
|
294
271
|
* @throws {RequiredError}
|
|
295
272
|
*/
|
|
296
273
|
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options = {}) => {
|
|
@@ -471,6 +448,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
471
448
|
* 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).
|
|
472
449
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
473
450
|
* @param {*} [options] Override http request option.
|
|
451
|
+
* @deprecated
|
|
474
452
|
* @throws {RequiredError}
|
|
475
453
|
*/
|
|
476
454
|
async getOrder(orderId, options) {
|
|
@@ -483,6 +461,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
483
461
|
* 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).
|
|
484
462
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
485
463
|
* @param {*} [options] Override http request option.
|
|
464
|
+
* @deprecated
|
|
486
465
|
* @throws {RequiredError}
|
|
487
466
|
*/
|
|
488
467
|
async getOrderAddress(orderId, options) {
|
|
@@ -495,6 +474,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
495
474
|
* 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).
|
|
496
475
|
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
497
476
|
* @param {*} [options] Override http request option.
|
|
477
|
+
* @deprecated
|
|
498
478
|
* @throws {RequiredError}
|
|
499
479
|
*/
|
|
500
480
|
async getOrderBuyerInfo(orderId, options) {
|
|
@@ -503,23 +483,12 @@ export const OrdersApiFp = function (configuration) {
|
|
|
503
483
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
504
484
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
505
485
|
},
|
|
506
|
-
/**
|
|
507
|
-
* Returns the fulfillment instructions 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).
|
|
508
|
-
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
509
|
-
* @param {*} [options] Override http request option.
|
|
510
|
-
* @throws {RequiredError}
|
|
511
|
-
*/
|
|
512
|
-
async getOrderFulfillmentInstructions(orderId, options) {
|
|
513
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderFulfillmentInstructions(orderId, options);
|
|
514
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
515
|
-
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderFulfillmentInstructions']?.[localVarOperationServerIndex]?.url;
|
|
516
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
517
|
-
},
|
|
518
486
|
/**
|
|
519
487
|
* 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).
|
|
520
488
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
521
489
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
522
490
|
* @param {*} [options] Override http request option.
|
|
491
|
+
* @deprecated
|
|
523
492
|
* @throws {RequiredError}
|
|
524
493
|
*/
|
|
525
494
|
async getOrderItems(orderId, nextToken, options) {
|
|
@@ -533,6 +502,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
533
502
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
534
503
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
535
504
|
* @param {*} [options] Override http request option.
|
|
505
|
+
* @deprecated
|
|
536
506
|
* @throws {RequiredError}
|
|
537
507
|
*/
|
|
538
508
|
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
@@ -577,6 +547,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
577
547
|
* @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
578
548
|
* @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
579
549
|
* @param {*} [options] Override http request option.
|
|
550
|
+
* @deprecated
|
|
580
551
|
* @throws {RequiredError}
|
|
581
552
|
*/
|
|
582
553
|
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options) {
|
|
@@ -632,6 +603,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
632
603
|
* 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).
|
|
633
604
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
634
605
|
* @param {*} [options] Override http request option.
|
|
606
|
+
* @deprecated
|
|
635
607
|
* @throws {RequiredError}
|
|
636
608
|
*/
|
|
637
609
|
getOrder(requestParameters, options) {
|
|
@@ -641,6 +613,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
641
613
|
* 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).
|
|
642
614
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
643
615
|
* @param {*} [options] Override http request option.
|
|
616
|
+
* @deprecated
|
|
644
617
|
* @throws {RequiredError}
|
|
645
618
|
*/
|
|
646
619
|
getOrderAddress(requestParameters, options) {
|
|
@@ -650,24 +623,17 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
650
623
|
* 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).
|
|
651
624
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
652
625
|
* @param {*} [options] Override http request option.
|
|
626
|
+
* @deprecated
|
|
653
627
|
* @throws {RequiredError}
|
|
654
628
|
*/
|
|
655
629
|
getOrderBuyerInfo(requestParameters, options) {
|
|
656
630
|
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
657
631
|
},
|
|
658
|
-
/**
|
|
659
|
-
* Returns the fulfillment instructions 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).
|
|
660
|
-
* @param {OrdersApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters.
|
|
661
|
-
* @param {*} [options] Override http request option.
|
|
662
|
-
* @throws {RequiredError}
|
|
663
|
-
*/
|
|
664
|
-
getOrderFulfillmentInstructions(requestParameters, options) {
|
|
665
|
-
return localVarFp.getOrderFulfillmentInstructions(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
666
|
-
},
|
|
667
632
|
/**
|
|
668
633
|
* 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).
|
|
669
634
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
670
635
|
* @param {*} [options] Override http request option.
|
|
636
|
+
* @deprecated
|
|
671
637
|
* @throws {RequiredError}
|
|
672
638
|
*/
|
|
673
639
|
getOrderItems(requestParameters, options) {
|
|
@@ -677,6 +643,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
677
643
|
* 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).
|
|
678
644
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
679
645
|
* @param {*} [options] Override http request option.
|
|
646
|
+
* @deprecated
|
|
680
647
|
* @throws {RequiredError}
|
|
681
648
|
*/
|
|
682
649
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
@@ -695,6 +662,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
695
662
|
* 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).
|
|
696
663
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
697
664
|
* @param {*} [options] Override http request option.
|
|
665
|
+
* @deprecated
|
|
698
666
|
* @throws {RequiredError}
|
|
699
667
|
*/
|
|
700
668
|
getOrders(requestParameters, options) {
|
|
@@ -737,6 +705,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
737
705
|
* 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).
|
|
738
706
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
739
707
|
* @param {*} [options] Override http request option.
|
|
708
|
+
* @deprecated
|
|
740
709
|
* @throws {RequiredError}
|
|
741
710
|
*/
|
|
742
711
|
getOrder(requestParameters, options) {
|
|
@@ -746,6 +715,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
746
715
|
* 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).
|
|
747
716
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
748
717
|
* @param {*} [options] Override http request option.
|
|
718
|
+
* @deprecated
|
|
749
719
|
* @throws {RequiredError}
|
|
750
720
|
*/
|
|
751
721
|
getOrderAddress(requestParameters, options) {
|
|
@@ -755,24 +725,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
755
725
|
* 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).
|
|
756
726
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
757
727
|
* @param {*} [options] Override http request option.
|
|
728
|
+
* @deprecated
|
|
758
729
|
* @throws {RequiredError}
|
|
759
730
|
*/
|
|
760
731
|
getOrderBuyerInfo(requestParameters, options) {
|
|
761
732
|
return OrdersApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
762
733
|
}
|
|
763
|
-
/**
|
|
764
|
-
* Returns the fulfillment instructions 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).
|
|
765
|
-
* @param {OrdersApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters.
|
|
766
|
-
* @param {*} [options] Override http request option.
|
|
767
|
-
* @throws {RequiredError}
|
|
768
|
-
*/
|
|
769
|
-
getOrderFulfillmentInstructions(requestParameters, options) {
|
|
770
|
-
return OrdersApiFp(this.configuration).getOrderFulfillmentInstructions(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
771
|
-
}
|
|
772
734
|
/**
|
|
773
735
|
* 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).
|
|
774
736
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
775
737
|
* @param {*} [options] Override http request option.
|
|
738
|
+
* @deprecated
|
|
776
739
|
* @throws {RequiredError}
|
|
777
740
|
*/
|
|
778
741
|
getOrderItems(requestParameters, options) {
|
|
@@ -782,6 +745,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
782
745
|
* 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).
|
|
783
746
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
784
747
|
* @param {*} [options] Override http request option.
|
|
748
|
+
* @deprecated
|
|
785
749
|
* @throws {RequiredError}
|
|
786
750
|
*/
|
|
787
751
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
@@ -800,6 +764,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
800
764
|
* 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).
|
|
801
765
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
802
766
|
* @param {*} [options] Override http request option.
|
|
767
|
+
* @deprecated
|
|
803
768
|
* @throws {RequiredError}
|
|
804
769
|
*/
|
|
805
770
|
getOrders(requestParameters, options) {
|