@sp-api-sdk/orders-api-v0 1.8.5

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 (117) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +58 -0
  3. package/dist/cjs/index.js +6 -0
  4. package/dist/cjs/src/api-model/api/orders-v0-api.js +513 -0
  5. package/dist/cjs/src/api-model/api.js +17 -0
  6. package/dist/cjs/src/api-model/base.js +62 -0
  7. package/dist/cjs/src/api-model/common.js +137 -0
  8. package/dist/cjs/src/api-model/configuration.js +42 -0
  9. package/dist/cjs/src/api-model/index.js +19 -0
  10. package/dist/cjs/src/api-model/models/address.js +25 -0
  11. package/dist/cjs/src/api-model/models/buyer-customized-info-detail.js +15 -0
  12. package/dist/cjs/src/api-model/models/buyer-info.js +15 -0
  13. package/dist/cjs/src/api-model/models/buyer-tax-info.js +15 -0
  14. package/dist/cjs/src/api-model/models/fulfillment-instruction.js +15 -0
  15. package/dist/cjs/src/api-model/models/get-order-address-response.js +15 -0
  16. package/dist/cjs/src/api-model/models/get-order-buyer-info-response.js +15 -0
  17. package/dist/cjs/src/api-model/models/get-order-items-buyer-info-response.js +15 -0
  18. package/dist/cjs/src/api-model/models/get-order-items-response.js +15 -0
  19. package/dist/cjs/src/api-model/models/get-order-response.js +15 -0
  20. package/dist/cjs/src/api-model/models/get-orders-response.js +15 -0
  21. package/dist/cjs/src/api-model/models/index.js +31 -0
  22. package/dist/cjs/src/api-model/models/item-buyer-info.js +15 -0
  23. package/dist/cjs/src/api-model/models/marketplace-tax-info.js +15 -0
  24. package/dist/cjs/src/api-model/models/model-error.js +15 -0
  25. package/dist/cjs/src/api-model/models/money.js +15 -0
  26. package/dist/cjs/src/api-model/models/order-address.js +15 -0
  27. package/dist/cjs/src/api-model/models/order-buyer-info.js +15 -0
  28. package/dist/cjs/src/api-model/models/order-item-buyer-info.js +15 -0
  29. package/dist/cjs/src/api-model/models/order-item.js +25 -0
  30. package/dist/cjs/src/api-model/models/order-items-buyer-info-list.js +15 -0
  31. package/dist/cjs/src/api-model/models/order-items-list.js +15 -0
  32. package/dist/cjs/src/api-model/models/order.js +62 -0
  33. package/dist/cjs/src/api-model/models/orders-list.js +15 -0
  34. package/dist/cjs/src/api-model/models/payment-execution-detail-item.js +15 -0
  35. package/dist/cjs/src/api-model/models/points-granted-detail.js +15 -0
  36. package/dist/cjs/src/api-model/models/product-info-detail.js +15 -0
  37. package/dist/cjs/src/api-model/models/tax-classification.js +15 -0
  38. package/dist/cjs/src/api-model/models/tax-collection.js +32 -0
  39. package/dist/cjs/src/client.js +65 -0
  40. package/dist/cjs/src/error.js +10 -0
  41. package/dist/es/index.js +3 -0
  42. package/dist/es/src/api-model/api/orders-v0-api.js +505 -0
  43. package/dist/es/src/api-model/api.js +14 -0
  44. package/dist/es/src/api-model/base.js +56 -0
  45. package/dist/es/src/api-model/common.js +125 -0
  46. package/dist/es/src/api-model/configuration.js +38 -0
  47. package/dist/es/src/api-model/index.js +16 -0
  48. package/dist/es/src/api-model/models/address.js +22 -0
  49. package/dist/es/src/api-model/models/buyer-customized-info-detail.js +14 -0
  50. package/dist/es/src/api-model/models/buyer-info.js +14 -0
  51. package/dist/es/src/api-model/models/buyer-tax-info.js +14 -0
  52. package/dist/es/src/api-model/models/fulfillment-instruction.js +14 -0
  53. package/dist/es/src/api-model/models/get-order-address-response.js +14 -0
  54. package/dist/es/src/api-model/models/get-order-buyer-info-response.js +14 -0
  55. package/dist/es/src/api-model/models/get-order-items-buyer-info-response.js +14 -0
  56. package/dist/es/src/api-model/models/get-order-items-response.js +14 -0
  57. package/dist/es/src/api-model/models/get-order-response.js +14 -0
  58. package/dist/es/src/api-model/models/get-orders-response.js +14 -0
  59. package/dist/es/src/api-model/models/index.js +28 -0
  60. package/dist/es/src/api-model/models/item-buyer-info.js +14 -0
  61. package/dist/es/src/api-model/models/marketplace-tax-info.js +14 -0
  62. package/dist/es/src/api-model/models/model-error.js +14 -0
  63. package/dist/es/src/api-model/models/money.js +14 -0
  64. package/dist/es/src/api-model/models/order-address.js +14 -0
  65. package/dist/es/src/api-model/models/order-buyer-info.js +14 -0
  66. package/dist/es/src/api-model/models/order-item-buyer-info.js +14 -0
  67. package/dist/es/src/api-model/models/order-item.js +22 -0
  68. package/dist/es/src/api-model/models/order-items-buyer-info-list.js +14 -0
  69. package/dist/es/src/api-model/models/order-items-list.js +14 -0
  70. package/dist/es/src/api-model/models/order.js +59 -0
  71. package/dist/es/src/api-model/models/orders-list.js +14 -0
  72. package/dist/es/src/api-model/models/payment-execution-detail-item.js +14 -0
  73. package/dist/es/src/api-model/models/points-granted-detail.js +14 -0
  74. package/dist/es/src/api-model/models/product-info-detail.js +14 -0
  75. package/dist/es/src/api-model/models/tax-classification.js +14 -0
  76. package/dist/es/src/api-model/models/tax-collection.js +29 -0
  77. package/dist/es/src/client.js +61 -0
  78. package/dist/es/src/error.js +6 -0
  79. package/dist/types/index.d.ts +3 -0
  80. package/dist/types/src/api-model/api/orders-v0-api.d.ts +460 -0
  81. package/dist/types/src/api-model/api.d.ts +12 -0
  82. package/dist/types/src/api-model/base.d.ts +55 -0
  83. package/dist/types/src/api-model/common.d.ts +65 -0
  84. package/dist/types/src/api-model/configuration.d.ts +83 -0
  85. package/dist/types/src/api-model/index.d.ts +14 -0
  86. package/dist/types/src/api-model/models/address.d.ts +104 -0
  87. package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +24 -0
  88. package/dist/types/src/api-model/models/buyer-info.d.ts +49 -0
  89. package/dist/types/src/api-model/models/buyer-tax-info.d.ts +37 -0
  90. package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +24 -0
  91. package/dist/types/src/api-model/models/get-order-address-response.d.ts +31 -0
  92. package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +31 -0
  93. package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +31 -0
  94. package/dist/types/src/api-model/models/get-order-items-response.d.ts +31 -0
  95. package/dist/types/src/api-model/models/get-order-response.d.ts +31 -0
  96. package/dist/types/src/api-model/models/get-orders-response.d.ts +31 -0
  97. package/dist/types/src/api-model/models/index.d.ts +28 -0
  98. package/dist/types/src/api-model/models/item-buyer-info.d.ts +50 -0
  99. package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +25 -0
  100. package/dist/types/src/api-model/models/model-error.d.ts +36 -0
  101. package/dist/types/src/api-model/models/money.d.ts +30 -0
  102. package/dist/types/src/api-model/models/order-address.d.ts +31 -0
  103. package/dist/types/src/api-model/models/order-buyer-info.d.ts +55 -0
  104. package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +56 -0
  105. package/dist/types/src/api-model/models/order-item.d.ts +229 -0
  106. package/dist/types/src/api-model/models/order-items-buyer-info-list.d.ts +37 -0
  107. package/dist/types/src/api-model/models/order-items-list.d.ts +37 -0
  108. package/dist/types/src/api-model/models/order.d.ts +306 -0
  109. package/dist/types/src/api-model/models/orders-list.d.ts +43 -0
  110. package/dist/types/src/api-model/models/payment-execution-detail-item.d.ts +31 -0
  111. package/dist/types/src/api-model/models/points-granted-detail.d.ts +31 -0
  112. package/dist/types/src/api-model/models/product-info-detail.d.ts +24 -0
  113. package/dist/types/src/api-model/models/tax-classification.d.ts +30 -0
  114. package/dist/types/src/api-model/models/tax-collection.d.ts +44 -0
  115. package/dist/types/src/client.d.ts +13 -0
  116. package/dist/types/src/error.d.ts +3 -0
  117. package/package.json +53 -0
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,22 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ * @enum {string}
17
+ */
18
+ export var OrderItemDeemedResellerCategoryEnum;
19
+ (function (OrderItemDeemedResellerCategoryEnum) {
20
+ OrderItemDeemedResellerCategoryEnum["Ioss"] = "IOSS";
21
+ OrderItemDeemedResellerCategoryEnum["Uoss"] = "UOSS";
22
+ })(OrderItemDeemedResellerCategoryEnum || (OrderItemDeemedResellerCategoryEnum = {}));
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,59 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ * @enum {string}
17
+ */
18
+ export var OrderOrderStatusEnum;
19
+ (function (OrderOrderStatusEnum) {
20
+ OrderOrderStatusEnum["Pending"] = "Pending";
21
+ OrderOrderStatusEnum["Unshipped"] = "Unshipped";
22
+ OrderOrderStatusEnum["PartiallyShipped"] = "PartiallyShipped";
23
+ OrderOrderStatusEnum["Shipped"] = "Shipped";
24
+ OrderOrderStatusEnum["Canceled"] = "Canceled";
25
+ OrderOrderStatusEnum["Unfulfillable"] = "Unfulfillable";
26
+ OrderOrderStatusEnum["InvoiceUnconfirmed"] = "InvoiceUnconfirmed";
27
+ OrderOrderStatusEnum["PendingAvailability"] = "PendingAvailability";
28
+ })(OrderOrderStatusEnum || (OrderOrderStatusEnum = {}));
29
+ /**
30
+ * @export
31
+ * @enum {string}
32
+ */
33
+ export var OrderFulfillmentChannelEnum;
34
+ (function (OrderFulfillmentChannelEnum) {
35
+ OrderFulfillmentChannelEnum["Mfn"] = "MFN";
36
+ OrderFulfillmentChannelEnum["Afn"] = "AFN";
37
+ })(OrderFulfillmentChannelEnum || (OrderFulfillmentChannelEnum = {}));
38
+ /**
39
+ * @export
40
+ * @enum {string}
41
+ */
42
+ export var OrderPaymentMethodEnum;
43
+ (function (OrderPaymentMethodEnum) {
44
+ OrderPaymentMethodEnum["Cod"] = "COD";
45
+ OrderPaymentMethodEnum["Cvs"] = "CVS";
46
+ OrderPaymentMethodEnum["Other"] = "Other";
47
+ })(OrderPaymentMethodEnum || (OrderPaymentMethodEnum = {}));
48
+ /**
49
+ * @export
50
+ * @enum {string}
51
+ */
52
+ export var OrderOrderTypeEnum;
53
+ (function (OrderOrderTypeEnum) {
54
+ OrderOrderTypeEnum["StandardOrder"] = "StandardOrder";
55
+ OrderOrderTypeEnum["LongLeadTimeOrder"] = "LongLeadTimeOrder";
56
+ OrderOrderTypeEnum["Preorder"] = "Preorder";
57
+ OrderOrderTypeEnum["BackOrder"] = "BackOrder";
58
+ OrderOrderTypeEnum["SourcingOnDemandOrder"] = "SourcingOnDemandOrder";
59
+ })(OrderOrderTypeEnum || (OrderOrderTypeEnum = {}));
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,29 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ * @enum {string}
17
+ */
18
+ export var TaxCollectionModelEnum;
19
+ (function (TaxCollectionModelEnum) {
20
+ TaxCollectionModelEnum["MarketplaceFacilitator"] = "MarketplaceFacilitator";
21
+ })(TaxCollectionModelEnum || (TaxCollectionModelEnum = {}));
22
+ /**
23
+ * @export
24
+ * @enum {string}
25
+ */
26
+ export var TaxCollectionResponsiblePartyEnum;
27
+ (function (TaxCollectionResponsiblePartyEnum) {
28
+ TaxCollectionResponsiblePartyEnum["AmazonServicesInc"] = "Amazon Services, Inc.";
29
+ })(TaxCollectionResponsiblePartyEnum || (TaxCollectionResponsiblePartyEnum = {}));
@@ -0,0 +1,61 @@
1
+ /* eslint-disable prefer-regex-literals */
2
+ import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
3
+ import { Configuration, OrdersV0Api } from './api-model';
4
+ import { OrdersApiError } from './error';
5
+ export const RATE_LIMITS = [
6
+ {
7
+ method: 'get',
8
+ urlRegex: new RegExp('^/orders/v0/orders$'),
9
+ rate: 0.0055,
10
+ burst: 20,
11
+ },
12
+ {
13
+ method: 'get',
14
+ urlRegex: new RegExp('^/orders/v0/orders/[^/]*$'),
15
+ rate: 0.0055,
16
+ burst: 20,
17
+ },
18
+ {
19
+ method: 'get',
20
+ urlRegex: new RegExp('^/orders/v0/orders/[^/]*/buyerInfo$'),
21
+ rate: 0.0055,
22
+ burst: 20,
23
+ },
24
+ {
25
+ method: 'get',
26
+ urlRegex: new RegExp('^/orders/v0/orders/[^/]*/address$'),
27
+ rate: 0.0055,
28
+ burst: 20,
29
+ },
30
+ {
31
+ method: 'get',
32
+ urlRegex: new RegExp('^/orders/v0/orders/[^/]*/orderItems$'),
33
+ rate: 0.0055,
34
+ burst: 20,
35
+ },
36
+ {
37
+ method: 'get',
38
+ urlRegex: new RegExp('^/orders/v0/orders/[^/]*/orderItems/buyerInfo$'),
39
+ rate: 0.0055,
40
+ burst: 20,
41
+ },
42
+ ];
43
+ export class OrdersApiClient extends OrdersV0Api {
44
+ constructor(parameters) {
45
+ const region = awsRegionByCode[parameters.region] ?? parameters.region;
46
+ const { rateLimiting, ...clientParameters } = parameters;
47
+ const axiosParameters = { ...clientParameters, region };
48
+ if (rateLimiting?.retry) {
49
+ axiosParameters.rateLimits = RATE_LIMITS;
50
+ axiosParameters.onRetry = rateLimiting.onRetry;
51
+ }
52
+ const axiosInstance = createAxiosInstance(axiosParameters);
53
+ const configuration = new Configuration();
54
+ const environment = parameters.sandbox ? 'sandbox' : 'production';
55
+ const endpoint = endpoints[environment][region];
56
+ if (!endpoint) {
57
+ throw new OrdersApiError(`Unknown region : ${region}`);
58
+ }
59
+ super(configuration, endpoint, axiosInstance);
60
+ }
61
+ }
@@ -0,0 +1,6 @@
1
+ export class OrdersApiError extends Error {
2
+ constructor(message) {
3
+ super(message);
4
+ this.name = 'OrdersApiError';
5
+ }
6
+ }
@@ -0,0 +1,3 @@
1
+ export * from './src/client';
2
+ export * from './src/error';
3
+ export * from './src/api-model/models';
@@ -0,0 +1,460 @@
1
+ /**
2
+ * Selling Partner API for Orders
3
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { GetOrderAddressResponse } from '../models';
16
+ import { GetOrderBuyerInfoResponse } from '../models';
17
+ import { GetOrderItemsBuyerInfoResponse } from '../models';
18
+ import { GetOrderItemsResponse } from '../models';
19
+ import { GetOrderResponse } from '../models';
20
+ import { GetOrdersResponse } from '../models';
21
+ /**
22
+ * OrdersV0Api - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
26
+ /**
27
+ * Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
28
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ getOrder: (orderId: string, options?: any) => Promise<RequestArgs>;
33
+ /**
34
+ * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
35
+ * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ getOrderAddress: (orderId: string, options?: any) => Promise<RequestArgs>;
40
+ /**
41
+ * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
42
+ * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ getOrderBuyerInfo: (orderId: string, options?: any) => Promise<RequestArgs>;
47
+ /**
48
+ * Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
49
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
50
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ getOrderItems: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
55
+ /**
56
+ * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
57
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
58
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ getOrderItemsBuyerInfo: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
63
+ /**
64
+ * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
65
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
66
+ * @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
67
+ * @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
68
+ * @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
69
+ * @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
70
+ * @param {Array<string>} [orderStatuses] A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
71
+ * @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
72
+ * @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
73
+ * @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
74
+ * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
75
+ * @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
76
+ * @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
77
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
78
+ * @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
79
+ * @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
80
+ * @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
81
+ * @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ */
85
+ getOrders: (marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any) => Promise<RequestArgs>;
86
+ };
87
+ /**
88
+ * OrdersV0Api - functional programming interface
89
+ * @export
90
+ */
91
+ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined) => {
92
+ /**
93
+ * Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
94
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ getOrder(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderResponse>>;
99
+ /**
100
+ * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
101
+ * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ getOrderAddress(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderAddressResponse>>;
106
+ /**
107
+ * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
108
+ * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
109
+ * @param {*} [options] Override http request option.
110
+ * @throws {RequiredError}
111
+ */
112
+ getOrderBuyerInfo(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderBuyerInfoResponse>>;
113
+ /**
114
+ * Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
115
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
116
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ getOrderItems(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsResponse>>;
121
+ /**
122
+ * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
123
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
124
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
129
+ /**
130
+ * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
131
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
132
+ * @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
133
+ * @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
134
+ * @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
135
+ * @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
136
+ * @param {Array<string>} [orderStatuses] A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
137
+ * @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
138
+ * @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
139
+ * @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
140
+ * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
141
+ * @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
142
+ * @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
143
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
144
+ * @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
145
+ * @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
146
+ * @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
147
+ * @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ getOrders(marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrdersResponse>>;
152
+ };
153
+ /**
154
+ * OrdersV0Api - factory interface
155
+ * @export
156
+ */
157
+ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
158
+ /**
159
+ * Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
160
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ getOrder(orderId: string, options?: any): AxiosPromise<GetOrderResponse>;
165
+ /**
166
+ * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
167
+ * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
168
+ * @param {*} [options] Override http request option.
169
+ * @throws {RequiredError}
170
+ */
171
+ getOrderAddress(orderId: string, options?: any): AxiosPromise<GetOrderAddressResponse>;
172
+ /**
173
+ * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
174
+ * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
175
+ * @param {*} [options] Override http request option.
176
+ * @throws {RequiredError}
177
+ */
178
+ getOrderBuyerInfo(orderId: string, options?: any): AxiosPromise<GetOrderBuyerInfoResponse>;
179
+ /**
180
+ * Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
181
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
182
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ getOrderItems(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsResponse>;
187
+ /**
188
+ * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
189
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
190
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
195
+ /**
196
+ * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
197
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
198
+ * @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
199
+ * @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
200
+ * @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
201
+ * @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
202
+ * @param {Array<string>} [orderStatuses] A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
203
+ * @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
204
+ * @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
205
+ * @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
206
+ * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
207
+ * @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
208
+ * @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
209
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
210
+ * @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
211
+ * @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
212
+ * @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
213
+ * @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ */
217
+ getOrders(marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any): AxiosPromise<GetOrdersResponse>;
218
+ };
219
+ /**
220
+ * Request parameters for getOrder operation in OrdersV0Api.
221
+ * @export
222
+ * @interface OrdersV0ApiGetOrderRequest
223
+ */
224
+ export interface OrdersV0ApiGetOrderRequest {
225
+ /**
226
+ * An Amazon-defined order identifier, in 3-7-7 format.
227
+ * @type {string}
228
+ * @memberof OrdersV0ApiGetOrder
229
+ */
230
+ readonly orderId: string;
231
+ }
232
+ /**
233
+ * Request parameters for getOrderAddress operation in OrdersV0Api.
234
+ * @export
235
+ * @interface OrdersV0ApiGetOrderAddressRequest
236
+ */
237
+ export interface OrdersV0ApiGetOrderAddressRequest {
238
+ /**
239
+ * An orderId is an Amazon-defined order identifier, in 3-7-7 format.
240
+ * @type {string}
241
+ * @memberof OrdersV0ApiGetOrderAddress
242
+ */
243
+ readonly orderId: string;
244
+ }
245
+ /**
246
+ * Request parameters for getOrderBuyerInfo operation in OrdersV0Api.
247
+ * @export
248
+ * @interface OrdersV0ApiGetOrderBuyerInfoRequest
249
+ */
250
+ export interface OrdersV0ApiGetOrderBuyerInfoRequest {
251
+ /**
252
+ * An orderId is an Amazon-defined order identifier, in 3-7-7 format.
253
+ * @type {string}
254
+ * @memberof OrdersV0ApiGetOrderBuyerInfo
255
+ */
256
+ readonly orderId: string;
257
+ }
258
+ /**
259
+ * Request parameters for getOrderItems operation in OrdersV0Api.
260
+ * @export
261
+ * @interface OrdersV0ApiGetOrderItemsRequest
262
+ */
263
+ export interface OrdersV0ApiGetOrderItemsRequest {
264
+ /**
265
+ * An Amazon-defined order identifier, in 3-7-7 format.
266
+ * @type {string}
267
+ * @memberof OrdersV0ApiGetOrderItems
268
+ */
269
+ readonly orderId: string;
270
+ /**
271
+ * A string token returned in the response of your previous request.
272
+ * @type {string}
273
+ * @memberof OrdersV0ApiGetOrderItems
274
+ */
275
+ readonly nextToken?: string;
276
+ }
277
+ /**
278
+ * Request parameters for getOrderItemsBuyerInfo operation in OrdersV0Api.
279
+ * @export
280
+ * @interface OrdersV0ApiGetOrderItemsBuyerInfoRequest
281
+ */
282
+ export interface OrdersV0ApiGetOrderItemsBuyerInfoRequest {
283
+ /**
284
+ * An Amazon-defined order identifier, in 3-7-7 format.
285
+ * @type {string}
286
+ * @memberof OrdersV0ApiGetOrderItemsBuyerInfo
287
+ */
288
+ readonly orderId: string;
289
+ /**
290
+ * A string token returned in the response of your previous request.
291
+ * @type {string}
292
+ * @memberof OrdersV0ApiGetOrderItemsBuyerInfo
293
+ */
294
+ readonly nextToken?: string;
295
+ }
296
+ /**
297
+ * Request parameters for getOrders operation in OrdersV0Api.
298
+ * @export
299
+ * @interface OrdersV0ApiGetOrdersRequest
300
+ */
301
+ export interface OrdersV0ApiGetOrdersRequest {
302
+ /**
303
+ * A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
304
+ * @type {Array<string>}
305
+ * @memberof OrdersV0ApiGetOrders
306
+ */
307
+ readonly marketplaceIds: Array<string>;
308
+ /**
309
+ * A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
310
+ * @type {string}
311
+ * @memberof OrdersV0ApiGetOrders
312
+ */
313
+ readonly createdAfter?: string;
314
+ /**
315
+ * A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
316
+ * @type {string}
317
+ * @memberof OrdersV0ApiGetOrders
318
+ */
319
+ readonly createdBefore?: string;
320
+ /**
321
+ * A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
322
+ * @type {string}
323
+ * @memberof OrdersV0ApiGetOrders
324
+ */
325
+ readonly lastUpdatedAfter?: string;
326
+ /**
327
+ * A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
328
+ * @type {string}
329
+ * @memberof OrdersV0ApiGetOrders
330
+ */
331
+ readonly lastUpdatedBefore?: string;
332
+ /**
333
+ * A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
334
+ * @type {Array<string>}
335
+ * @memberof OrdersV0ApiGetOrders
336
+ */
337
+ readonly orderStatuses?: Array<string>;
338
+ /**
339
+ * A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
340
+ * @type {Array<string>}
341
+ * @memberof OrdersV0ApiGetOrders
342
+ */
343
+ readonly fulfillmentChannels?: Array<string>;
344
+ /**
345
+ * A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
346
+ * @type {Array<string>}
347
+ * @memberof OrdersV0ApiGetOrders
348
+ */
349
+ readonly paymentMethods?: Array<string>;
350
+ /**
351
+ * The email address of a buyer. Used to select orders that contain the specified email address.
352
+ * @type {string}
353
+ * @memberof OrdersV0ApiGetOrders
354
+ */
355
+ readonly buyerEmail?: string;
356
+ /**
357
+ * An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
358
+ * @type {string}
359
+ * @memberof OrdersV0ApiGetOrders
360
+ */
361
+ readonly sellerOrderId?: string;
362
+ /**
363
+ * A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
364
+ * @type {number}
365
+ * @memberof OrdersV0ApiGetOrders
366
+ */
367
+ readonly maxResultsPerPage?: number;
368
+ /**
369
+ * A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
370
+ * @type {Array<string>}
371
+ * @memberof OrdersV0ApiGetOrders
372
+ */
373
+ readonly easyShipShipmentStatuses?: Array<string>;
374
+ /**
375
+ * A string token returned in the response of your previous request.
376
+ * @type {string}
377
+ * @memberof OrdersV0ApiGetOrders
378
+ */
379
+ readonly nextToken?: string;
380
+ /**
381
+ * A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
382
+ * @type {Array<string>}
383
+ * @memberof OrdersV0ApiGetOrders
384
+ */
385
+ readonly amazonOrderIds?: Array<string>;
386
+ /**
387
+ * Denotes the recommended sourceId where the order should be fulfilled from.
388
+ * @type {string}
389
+ * @memberof OrdersV0ApiGetOrders
390
+ */
391
+ readonly actualFulfillmentSupplySourceId?: string;
392
+ /**
393
+ * When true, this order is marked to be picked up from a store rather than delivered.
394
+ * @type {boolean}
395
+ * @memberof OrdersV0ApiGetOrders
396
+ */
397
+ readonly isISPU?: boolean;
398
+ /**
399
+ * The store chain store identifier. Linked to a specific store in a store chain.
400
+ * @type {string}
401
+ * @memberof OrdersV0ApiGetOrders
402
+ */
403
+ readonly storeChainStoreId?: string;
404
+ }
405
+ /**
406
+ * OrdersV0Api - object-oriented interface
407
+ * @export
408
+ * @class OrdersV0Api
409
+ * @extends {BaseAPI}
410
+ */
411
+ export declare class OrdersV0Api extends BaseAPI {
412
+ /**
413
+ * Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
414
+ * @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
415
+ * @param {*} [options] Override http request option.
416
+ * @throws {RequiredError}
417
+ * @memberof OrdersV0Api
418
+ */
419
+ getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderResponse>>;
420
+ /**
421
+ * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
422
+ * @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
423
+ * @param {*} [options] Override http request option.
424
+ * @throws {RequiredError}
425
+ * @memberof OrdersV0Api
426
+ */
427
+ getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderAddressResponse>>;
428
+ /**
429
+ * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
430
+ * @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
431
+ * @param {*} [options] Override http request option.
432
+ * @throws {RequiredError}
433
+ * @memberof OrdersV0Api
434
+ */
435
+ getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderBuyerInfoResponse>>;
436
+ /**
437
+ * Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
438
+ * @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
439
+ * @param {*} [options] Override http request option.
440
+ * @throws {RequiredError}
441
+ * @memberof OrdersV0Api
442
+ */
443
+ getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderItemsResponse>>;
444
+ /**
445
+ * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
446
+ * @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
447
+ * @param {*} [options] Override http request option.
448
+ * @throws {RequiredError}
449
+ * @memberof OrdersV0Api
450
+ */
451
+ getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderItemsBuyerInfoResponse>>;
452
+ /**
453
+ * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
454
+ * @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
455
+ * @param {*} [options] Override http request option.
456
+ * @throws {RequiredError}
457
+ * @memberof OrdersV0Api
458
+ */
459
+ getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrdersResponse>>;
460
+ }