@sp-api-sdk/orders-api-v0 5.6.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.
Files changed (4) hide show
  1. package/dist/cjs/api-model/api/orders-api.js +24 -0
  2. package/dist/es/api-model/api/orders-api.js +24 -0
  3. package/dist/types/api-model/api/orders-api.d.ts +24 -0
  4. package/package.json +3 -3
package/dist/cjs/api-model/api/orders-api.js CHANGED
@@ -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 = {}) => {
@@ -154,6 +157,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
154
157
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
155
158
  * @param {string} [nextToken] A string token returned in the response of your previous request.
156
159
  * @param {*} [options] Override http request option.
160
+ * @deprecated
157
161
  * @throws {RequiredError}
158
162
  */
159
163
  getOrderItems: async (orderId, nextToken, options = {}) => {
@@ -187,6 +191,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
187
191
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
188
192
  * @param {string} [nextToken] A string token returned in the response of your previous request.
189
193
  * @param {*} [options] Override http request option.
194
+ * @deprecated
190
195
  * @throws {RequiredError}
191
196
  */
192
197
  getOrderItemsBuyerInfo: async (orderId, nextToken, options = {}) => {
@@ -268,6 +273,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
268
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.
269
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.
270
275
  * @param {*} [options] Override http request option.
276
+ * @deprecated
271
277
  * @throws {RequiredError}
272
278
  */
273
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 = {}) => {
@@ -449,6 +455,7 @@ const OrdersApiFp = function (configuration) {
449
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).
450
456
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
451
457
  * @param {*} [options] Override http request option.
458
+ * @deprecated
452
459
  * @throws {RequiredError}
453
460
  */
454
461
  async getOrder(orderId, options) {
@@ -461,6 +468,7 @@ const OrdersApiFp = function (configuration) {
461
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).
462
469
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
463
470
  * @param {*} [options] Override http request option.
471
+ * @deprecated
464
472
  * @throws {RequiredError}
465
473
  */
466
474
  async getOrderAddress(orderId, options) {
@@ -473,6 +481,7 @@ const OrdersApiFp = function (configuration) {
473
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).
474
482
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
475
483
  * @param {*} [options] Override http request option.
484
+ * @deprecated
476
485
  * @throws {RequiredError}
477
486
  */
478
487
  async getOrderBuyerInfo(orderId, options) {
@@ -486,6 +495,7 @@ const OrdersApiFp = function (configuration) {
486
495
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
487
496
  * @param {string} [nextToken] A string token returned in the response of your previous request.
488
497
  * @param {*} [options] Override http request option.
498
+ * @deprecated
489
499
  * @throws {RequiredError}
490
500
  */
491
501
  async getOrderItems(orderId, nextToken, options) {
@@ -499,6 +509,7 @@ const OrdersApiFp = function (configuration) {
499
509
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
500
510
  * @param {string} [nextToken] A string token returned in the response of your previous request.
501
511
  * @param {*} [options] Override http request option.
512
+ * @deprecated
502
513
  * @throws {RequiredError}
503
514
  */
504
515
  async getOrderItemsBuyerInfo(orderId, nextToken, options) {
@@ -543,6 +554,7 @@ const OrdersApiFp = function (configuration) {
543
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.
544
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.
545
556
  * @param {*} [options] Override http request option.
557
+ * @deprecated
546
558
  * @throws {RequiredError}
547
559
  */
548
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) {
@@ -599,6 +611,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
599
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).
600
612
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
601
613
  * @param {*} [options] Override http request option.
614
+ * @deprecated
602
615
  * @throws {RequiredError}
603
616
  */
604
617
  getOrder(requestParameters, options) {
@@ -608,6 +621,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
608
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).
609
622
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
610
623
  * @param {*} [options] Override http request option.
624
+ * @deprecated
611
625
  * @throws {RequiredError}
612
626
  */
613
627
  getOrderAddress(requestParameters, options) {
@@ -617,6 +631,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
617
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).
618
632
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
619
633
  * @param {*} [options] Override http request option.
634
+ * @deprecated
620
635
  * @throws {RequiredError}
621
636
  */
622
637
  getOrderBuyerInfo(requestParameters, options) {
@@ -626,6 +641,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
626
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).
627
642
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
628
643
  * @param {*} [options] Override http request option.
644
+ * @deprecated
629
645
  * @throws {RequiredError}
630
646
  */
631
647
  getOrderItems(requestParameters, options) {
@@ -635,6 +651,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
635
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).
636
652
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
637
653
  * @param {*} [options] Override http request option.
654
+ * @deprecated
638
655
  * @throws {RequiredError}
639
656
  */
640
657
  getOrderItemsBuyerInfo(requestParameters, options) {
@@ -653,6 +670,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
653
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).
654
671
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
655
672
  * @param {*} [options] Override http request option.
673
+ * @deprecated
656
674
  * @throws {RequiredError}
657
675
  */
658
676
  getOrders(requestParameters, options) {
@@ -696,6 +714,7 @@ class OrdersApi extends base_1.BaseAPI {
696
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).
697
715
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
698
716
  * @param {*} [options] Override http request option.
717
+ * @deprecated
699
718
  * @throws {RequiredError}
700
719
  */
701
720
  getOrder(requestParameters, options) {
@@ -705,6 +724,7 @@ class OrdersApi extends base_1.BaseAPI {
705
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).
706
725
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
707
726
  * @param {*} [options] Override http request option.
727
+ * @deprecated
708
728
  * @throws {RequiredError}
709
729
  */
710
730
  getOrderAddress(requestParameters, options) {
@@ -714,6 +734,7 @@ class OrdersApi extends base_1.BaseAPI {
714
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).
715
735
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
716
736
  * @param {*} [options] Override http request option.
737
+ * @deprecated
717
738
  * @throws {RequiredError}
718
739
  */
719
740
  getOrderBuyerInfo(requestParameters, options) {
@@ -723,6 +744,7 @@ class OrdersApi extends base_1.BaseAPI {
723
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).
724
745
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
725
746
  * @param {*} [options] Override http request option.
747
+ * @deprecated
726
748
  * @throws {RequiredError}
727
749
  */
728
750
  getOrderItems(requestParameters, options) {
@@ -732,6 +754,7 @@ class OrdersApi extends base_1.BaseAPI {
732
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).
733
755
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
734
756
  * @param {*} [options] Override http request option.
757
+ * @deprecated
735
758
  * @throws {RequiredError}
736
759
  */
737
760
  getOrderItemsBuyerInfo(requestParameters, options) {
@@ -750,6 +773,7 @@ class OrdersApi extends base_1.BaseAPI {
750
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).
751
774
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
752
775
  * @param {*} [options] Override http request option.
776
+ * @deprecated
753
777
  * @throws {RequiredError}
754
778
  */
755
779
  getOrders(requestParameters, options) {
package/dist/es/api-model/api/orders-api.js CHANGED
@@ -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 = {}) => {
@@ -148,6 +151,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
148
151
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
149
152
  * @param {string} [nextToken] A string token returned in the response of your previous request.
150
153
  * @param {*} [options] Override http request option.
154
+ * @deprecated
151
155
  * @throws {RequiredError}
152
156
  */
153
157
  getOrderItems: async (orderId, nextToken, options = {}) => {
@@ -181,6 +185,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
181
185
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
182
186
  * @param {string} [nextToken] A string token returned in the response of your previous request.
183
187
  * @param {*} [options] Override http request option.
188
+ * @deprecated
184
189
  * @throws {RequiredError}
185
190
  */
186
191
  getOrderItemsBuyerInfo: async (orderId, nextToken, options = {}) => {
@@ -262,6 +267,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
262
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.
263
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.
264
269
  * @param {*} [options] Override http request option.
270
+ * @deprecated
265
271
  * @throws {RequiredError}
266
272
  */
267
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 = {}) => {
@@ -442,6 +448,7 @@ export const OrdersApiFp = function (configuration) {
442
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).
443
449
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
444
450
  * @param {*} [options] Override http request option.
451
+ * @deprecated
445
452
  * @throws {RequiredError}
446
453
  */
447
454
  async getOrder(orderId, options) {
@@ -454,6 +461,7 @@ export const OrdersApiFp = function (configuration) {
454
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).
455
462
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
456
463
  * @param {*} [options] Override http request option.
464
+ * @deprecated
457
465
  * @throws {RequiredError}
458
466
  */
459
467
  async getOrderAddress(orderId, options) {
@@ -466,6 +474,7 @@ export const OrdersApiFp = function (configuration) {
466
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).
467
475
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
468
476
  * @param {*} [options] Override http request option.
477
+ * @deprecated
469
478
  * @throws {RequiredError}
470
479
  */
471
480
  async getOrderBuyerInfo(orderId, options) {
@@ -479,6 +488,7 @@ export const OrdersApiFp = function (configuration) {
479
488
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
480
489
  * @param {string} [nextToken] A string token returned in the response of your previous request.
481
490
  * @param {*} [options] Override http request option.
491
+ * @deprecated
482
492
  * @throws {RequiredError}
483
493
  */
484
494
  async getOrderItems(orderId, nextToken, options) {
@@ -492,6 +502,7 @@ export const OrdersApiFp = function (configuration) {
492
502
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
493
503
  * @param {string} [nextToken] A string token returned in the response of your previous request.
494
504
  * @param {*} [options] Override http request option.
505
+ * @deprecated
495
506
  * @throws {RequiredError}
496
507
  */
497
508
  async getOrderItemsBuyerInfo(orderId, nextToken, options) {
@@ -536,6 +547,7 @@ export const OrdersApiFp = function (configuration) {
536
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.
537
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.
538
549
  * @param {*} [options] Override http request option.
550
+ * @deprecated
539
551
  * @throws {RequiredError}
540
552
  */
541
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) {
@@ -591,6 +603,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
591
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).
592
604
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
593
605
  * @param {*} [options] Override http request option.
606
+ * @deprecated
594
607
  * @throws {RequiredError}
595
608
  */
596
609
  getOrder(requestParameters, options) {
@@ -600,6 +613,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
600
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).
601
614
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
602
615
  * @param {*} [options] Override http request option.
616
+ * @deprecated
603
617
  * @throws {RequiredError}
604
618
  */
605
619
  getOrderAddress(requestParameters, options) {
@@ -609,6 +623,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
609
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).
610
624
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
611
625
  * @param {*} [options] Override http request option.
626
+ * @deprecated
612
627
  * @throws {RequiredError}
613
628
  */
614
629
  getOrderBuyerInfo(requestParameters, options) {
@@ -618,6 +633,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
618
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).
619
634
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
620
635
  * @param {*} [options] Override http request option.
636
+ * @deprecated
621
637
  * @throws {RequiredError}
622
638
  */
623
639
  getOrderItems(requestParameters, options) {
@@ -627,6 +643,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
627
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).
628
644
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
629
645
  * @param {*} [options] Override http request option.
646
+ * @deprecated
630
647
  * @throws {RequiredError}
631
648
  */
632
649
  getOrderItemsBuyerInfo(requestParameters, options) {
@@ -645,6 +662,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
645
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).
646
663
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
647
664
  * @param {*} [options] Override http request option.
665
+ * @deprecated
648
666
  * @throws {RequiredError}
649
667
  */
650
668
  getOrders(requestParameters, options) {
@@ -687,6 +705,7 @@ export class OrdersApi extends BaseAPI {
687
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).
688
706
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
689
707
  * @param {*} [options] Override http request option.
708
+ * @deprecated
690
709
  * @throws {RequiredError}
691
710
  */
692
711
  getOrder(requestParameters, options) {
@@ -696,6 +715,7 @@ export class OrdersApi extends BaseAPI {
696
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).
697
716
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
698
717
  * @param {*} [options] Override http request option.
718
+ * @deprecated
699
719
  * @throws {RequiredError}
700
720
  */
701
721
  getOrderAddress(requestParameters, options) {
@@ -705,6 +725,7 @@ export class OrdersApi extends BaseAPI {
705
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).
706
726
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
707
727
  * @param {*} [options] Override http request option.
728
+ * @deprecated
708
729
  * @throws {RequiredError}
709
730
  */
710
731
  getOrderBuyerInfo(requestParameters, options) {
@@ -714,6 +735,7 @@ export class OrdersApi extends BaseAPI {
714
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).
715
736
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
716
737
  * @param {*} [options] Override http request option.
738
+ * @deprecated
717
739
  * @throws {RequiredError}
718
740
  */
719
741
  getOrderItems(requestParameters, options) {
@@ -723,6 +745,7 @@ export class OrdersApi extends BaseAPI {
723
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).
724
746
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
725
747
  * @param {*} [options] Override http request option.
748
+ * @deprecated
726
749
  * @throws {RequiredError}
727
750
  */
728
751
  getOrderItemsBuyerInfo(requestParameters, options) {
@@ -741,6 +764,7 @@ export class OrdersApi extends BaseAPI {
741
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).
742
765
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
743
766
  * @param {*} [options] Override http request option.
767
+ * @deprecated
744
768
  * @throws {RequiredError}
745
769
  */
746
770
  getOrders(requestParameters, options) {
package/dist/types/api-model/api/orders-api.d.ts CHANGED
@@ -39,6 +39,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
39
39
  * 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).
40
40
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
41
41
  * @param {*} [options] Override http request option.
42
+ * @deprecated
42
43
  * @throws {RequiredError}
43
44
  */
44
45
  getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -46,6 +47,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
46
47
  * 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).
47
48
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
48
49
  * @param {*} [options] Override http request option.
50
+ * @deprecated
49
51
  * @throws {RequiredError}
50
52
  */
51
53
  getOrderAddress: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -53,6 +55,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
53
55
  * 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).
54
56
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
55
57
  * @param {*} [options] Override http request option.
58
+ * @deprecated
56
59
  * @throws {RequiredError}
57
60
  */
58
61
  getOrderBuyerInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -61,6 +64,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
61
64
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
62
65
  * @param {string} [nextToken] A string token returned in the response of your previous request.
63
66
  * @param {*} [options] Override http request option.
67
+ * @deprecated
64
68
  * @throws {RequiredError}
65
69
  */
66
70
  getOrderItems: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -69,6 +73,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
69
73
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
70
74
  * @param {string} [nextToken] A string token returned in the response of your previous request.
71
75
  * @param {*} [options] Override http request option.
76
+ * @deprecated
72
77
  * @throws {RequiredError}
73
78
  */
74
79
  getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -103,6 +108,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
103
108
  * @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.
104
109
  * @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.
105
110
  * @param {*} [options] Override http request option.
111
+ * @deprecated
106
112
  * @throws {RequiredError}
107
113
  */
108
114
  getOrders: (marketplaceIds: Array<string>, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array<string>, fulfillmentChannels?: Array<string>, paymentMethods?: Array<string>, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array<string>, electronicInvoiceStatuses?: Array<string>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -139,6 +145,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
139
145
  * 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).
140
146
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
141
147
  * @param {*} [options] Override http request option.
148
+ * @deprecated
142
149
  * @throws {RequiredError}
143
150
  */
144
151
  getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
@@ -146,6 +153,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
146
153
  * 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).
147
154
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
148
155
  * @param {*} [options] Override http request option.
156
+ * @deprecated
149
157
  * @throws {RequiredError}
150
158
  */
151
159
  getOrderAddress(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
@@ -153,6 +161,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
153
161
  * 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).
154
162
  * @param {string} orderId The Amazon order identifier in 3-7-7 format.
155
163
  * @param {*} [options] Override http request option.
164
+ * @deprecated
156
165
  * @throws {RequiredError}
157
166
  */
158
167
  getOrderBuyerInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
@@ -161,6 +170,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
161
170
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
162
171
  * @param {string} [nextToken] A string token returned in the response of your previous request.
163
172
  * @param {*} [options] Override http request option.
173
+ * @deprecated
164
174
  * @throws {RequiredError}
165
175
  */
166
176
  getOrderItems(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
@@ -169,6 +179,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
169
179
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
170
180
  * @param {string} [nextToken] A string token returned in the response of your previous request.
171
181
  * @param {*} [options] Override http request option.
182
+ * @deprecated
172
183
  * @throws {RequiredError}
173
184
  */
174
185
  getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
@@ -203,6 +214,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
203
214
  * @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.
204
215
  * @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.
205
216
  * @param {*} [options] Override http request option.
217
+ * @deprecated
206
218
  * @throws {RequiredError}
207
219
  */
208
220
  getOrders(marketplaceIds: Array<string>, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array<string>, fulfillmentChannels?: Array<string>, paymentMethods?: Array<string>, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array<string>, electronicInvoiceStatuses?: Array<string>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
@@ -238,6 +250,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
238
250
  * 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).
239
251
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
240
252
  * @param {*} [options] Override http request option.
253
+ * @deprecated
241
254
  * @throws {RequiredError}
242
255
  */
243
256
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
@@ -245,6 +258,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
245
258
  * 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).
246
259
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
247
260
  * @param {*} [options] Override http request option.
261
+ * @deprecated
248
262
  * @throws {RequiredError}
249
263
  */
250
264
  getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
@@ -252,6 +266,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
252
266
  * 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).
253
267
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
254
268
  * @param {*} [options] Override http request option.
269
+ * @deprecated
255
270
  * @throws {RequiredError}
256
271
  */
257
272
  getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
@@ -259,6 +274,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
259
274
  * 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).
260
275
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
261
276
  * @param {*} [options] Override http request option.
277
+ * @deprecated
262
278
  * @throws {RequiredError}
263
279
  */
264
280
  getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
@@ -266,6 +282,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
266
282
  * 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).
267
283
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
268
284
  * @param {*} [options] Override http request option.
285
+ * @deprecated
269
286
  * @throws {RequiredError}
270
287
  */
271
288
  getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
@@ -280,6 +297,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
280
297
  * 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).
281
298
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
282
299
  * @param {*} [options] Override http request option.
300
+ * @deprecated
283
301
  * @throws {RequiredError}
284
302
  */
285
303
  getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
@@ -503,6 +521,7 @@ export declare class OrdersApi extends BaseAPI {
503
521
  * 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).
504
522
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
505
523
  * @param {*} [options] Override http request option.
524
+ * @deprecated
506
525
  * @throws {RequiredError}
507
526
  */
508
527
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any, {}>>;
@@ -510,6 +529,7 @@ export declare class OrdersApi extends BaseAPI {
510
529
  * 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).
511
530
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
512
531
  * @param {*} [options] Override http request option.
532
+ * @deprecated
513
533
  * @throws {RequiredError}
514
534
  */
515
535
  getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderAddressResponse, any, {}>>;
@@ -517,6 +537,7 @@ export declare class OrdersApi extends BaseAPI {
517
537
  * 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).
518
538
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
519
539
  * @param {*} [options] Override http request option.
540
+ * @deprecated
520
541
  * @throws {RequiredError}
521
542
  */
522
543
  getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderBuyerInfoResponse, any, {}>>;
@@ -524,6 +545,7 @@ export declare class OrdersApi extends BaseAPI {
524
545
  * 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).
525
546
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
526
547
  * @param {*} [options] Override http request option.
548
+ * @deprecated
527
549
  * @throws {RequiredError}
528
550
  */
529
551
  getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsResponse, any, {}>>;
@@ -531,6 +553,7 @@ export declare class OrdersApi extends BaseAPI {
531
553
  * 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).
532
554
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
533
555
  * @param {*} [options] Override http request option.
556
+ * @deprecated
534
557
  * @throws {RequiredError}
535
558
  */
536
559
  getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsBuyerInfoResponse, any, {}>>;
@@ -545,6 +568,7 @@ export declare class OrdersApi extends BaseAPI {
545
568
  * 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).
546
569
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
547
570
  * @param {*} [options] Override http request option.
571
+ * @deprecated
548
572
  * @throws {RequiredError}
549
573
  */
550
574
  getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any, {}>>;
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/orders-api-v0",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. Note: For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don't show up in the response).",
5
- "version": "5.6.0",
5
+ "version": "5.7.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.28",
21
+ "@sp-api-sdk/common": "2.1.29",
22
22
  "axios": "^1.13.5"
23
23
  },
24
24
  "repository": {
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "orders api"
42
42
  ],
43
- "gitHead": "111f635ee267c031683ba5cd53937a7f381574be"
43
+ "gitHead": "2c1fe783fb7c2204e7e19d4f85fa2bdf822e4593"
44
44
  }