@sp-api-sdk/orders-api-2026-01-01 0.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (192) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +105 -0
  3. package/dist/cjs/api-model/api/orders-api.js +266 -0
  4. package/dist/cjs/api-model/api.js +30 -0
  5. package/dist/cjs/api-model/base.js +52 -0
  6. package/dist/cjs/api-model/common.js +122 -0
  7. package/dist/cjs/api-model/configuration.js +98 -0
  8. package/dist/cjs/api-model/index.js +32 -0
  9. package/dist/cjs/api-model/models/address-extended-fields.js +15 -0
  10. package/dist/cjs/api-model/models/alias.js +15 -0
  11. package/dist/cjs/api-model/models/associated-order.js +15 -0
  12. package/dist/cjs/api-model/models/business-hour.js +25 -0
  13. package/dist/cjs/api-model/models/buyer.js +15 -0
  14. package/dist/cjs/api-model/models/constraint-type.js +22 -0
  15. package/dist/cjs/api-model/models/customer-address.js +15 -0
  16. package/dist/cjs/api-model/models/date-time-range.js +15 -0
  17. package/dist/cjs/api-model/models/delivery-preference.js +15 -0
  18. package/dist/cjs/api-model/models/error-list.js +15 -0
  19. package/dist/cjs/api-model/models/exception-date.js +20 -0
  20. package/dist/cjs/api-model/models/fulfillment-status.js +28 -0
  21. package/dist/cjs/api-model/models/get-order-response.js +15 -0
  22. package/dist/cjs/api-model/models/gift-option.js +15 -0
  23. package/dist/cjs/api-model/models/hour-minute.js +15 -0
  24. package/dist/cjs/api-model/models/index.js +70 -0
  25. package/dist/cjs/api-model/models/item-cancellation-request.js +15 -0
  26. package/dist/cjs/api-model/models/item-cancellation.js +15 -0
  27. package/dist/cjs/api-model/models/item-condition.js +15 -0
  28. package/dist/cjs/api-model/models/item-customization.js +15 -0
  29. package/dist/cjs/api-model/models/item-expense.js +15 -0
  30. package/dist/cjs/api-model/models/item-fulfillment.js +15 -0
  31. package/dist/cjs/api-model/models/item-international-shipping.js +15 -0
  32. package/dist/cjs/api-model/models/item-packing.js +15 -0
  33. package/dist/cjs/api-model/models/item-picking.js +15 -0
  34. package/dist/cjs/api-model/models/item-points-cost.js +15 -0
  35. package/dist/cjs/api-model/models/item-price.js +15 -0
  36. package/dist/cjs/api-model/models/item-proceeds-breakdown.js +15 -0
  37. package/dist/cjs/api-model/models/item-proceeds-detailed-breakdown.js +15 -0
  38. package/dist/cjs/api-model/models/item-proceeds.js +15 -0
  39. package/dist/cjs/api-model/models/item-product.js +15 -0
  40. package/dist/cjs/api-model/models/item-promotion-breakdown.js +15 -0
  41. package/dist/cjs/api-model/models/item-promotion.js +15 -0
  42. package/dist/cjs/api-model/models/item-shipping-constraints.js +15 -0
  43. package/dist/cjs/api-model/models/item-shipping.js +15 -0
  44. package/dist/cjs/api-model/models/item-substitution-option.js +15 -0
  45. package/dist/cjs/api-model/models/item-substitution-preference.js +21 -0
  46. package/dist/cjs/api-model/models/measurement.js +42 -0
  47. package/dist/cjs/api-model/models/merchant-address.js +15 -0
  48. package/dist/cjs/api-model/models/model-error.js +15 -0
  49. package/dist/cjs/api-model/models/money.js +15 -0
  50. package/dist/cjs/api-model/models/order-fulfillment.js +15 -0
  51. package/dist/cjs/api-model/models/order-item.js +15 -0
  52. package/dist/cjs/api-model/models/order-package.js +15 -0
  53. package/dist/cjs/api-model/models/order-proceeds.js +15 -0
  54. package/dist/cjs/api-model/models/order.js +15 -0
  55. package/dist/cjs/api-model/models/package-item.js +15 -0
  56. package/dist/cjs/api-model/models/package-status.js +24 -0
  57. package/dist/cjs/api-model/models/pagination.js +15 -0
  58. package/dist/cjs/api-model/models/points-granted.js +15 -0
  59. package/dist/cjs/api-model/models/preferred-delivery-time.js +15 -0
  60. package/dist/cjs/api-model/models/recipient.js +15 -0
  61. package/dist/cjs/api-model/models/sales-channel.js +15 -0
  62. package/dist/cjs/api-model/models/search-orders-response.js +15 -0
  63. package/dist/cjs/api-model/models/time-window.js +15 -0
  64. package/dist/cjs/client.js +13 -0
  65. package/dist/cjs/index.js +19 -0
  66. package/dist/es/api-model/api/orders-api.js +256 -0
  67. package/dist/es/api-model/api.js +14 -0
  68. package/dist/es/api-model/base.js +44 -0
  69. package/dist/es/api-model/common.js +109 -0
  70. package/dist/es/api-model/configuration.js +94 -0
  71. package/dist/es/api-model/index.js +16 -0
  72. package/dist/es/api-model/models/address-extended-fields.js +14 -0
  73. package/dist/es/api-model/models/alias.js +14 -0
  74. package/dist/es/api-model/models/associated-order.js +14 -0
  75. package/dist/es/api-model/models/business-hour.js +22 -0
  76. package/dist/es/api-model/models/buyer.js +14 -0
  77. package/dist/es/api-model/models/constraint-type.js +19 -0
  78. package/dist/es/api-model/models/customer-address.js +14 -0
  79. package/dist/es/api-model/models/date-time-range.js +14 -0
  80. package/dist/es/api-model/models/delivery-preference.js +14 -0
  81. package/dist/es/api-model/models/error-list.js +14 -0
  82. package/dist/es/api-model/models/exception-date.js +17 -0
  83. package/dist/es/api-model/models/fulfillment-status.js +25 -0
  84. package/dist/es/api-model/models/get-order-response.js +14 -0
  85. package/dist/es/api-model/models/gift-option.js +14 -0
  86. package/dist/es/api-model/models/hour-minute.js +14 -0
  87. package/dist/es/api-model/models/index.js +54 -0
  88. package/dist/es/api-model/models/item-cancellation-request.js +14 -0
  89. package/dist/es/api-model/models/item-cancellation.js +14 -0
  90. package/dist/es/api-model/models/item-condition.js +14 -0
  91. package/dist/es/api-model/models/item-customization.js +14 -0
  92. package/dist/es/api-model/models/item-expense.js +14 -0
  93. package/dist/es/api-model/models/item-fulfillment.js +14 -0
  94. package/dist/es/api-model/models/item-international-shipping.js +14 -0
  95. package/dist/es/api-model/models/item-packing.js +14 -0
  96. package/dist/es/api-model/models/item-picking.js +14 -0
  97. package/dist/es/api-model/models/item-points-cost.js +14 -0
  98. package/dist/es/api-model/models/item-price.js +14 -0
  99. package/dist/es/api-model/models/item-proceeds-breakdown.js +14 -0
  100. package/dist/es/api-model/models/item-proceeds-detailed-breakdown.js +14 -0
  101. package/dist/es/api-model/models/item-proceeds.js +14 -0
  102. package/dist/es/api-model/models/item-product.js +14 -0
  103. package/dist/es/api-model/models/item-promotion-breakdown.js +14 -0
  104. package/dist/es/api-model/models/item-promotion.js +14 -0
  105. package/dist/es/api-model/models/item-shipping-constraints.js +14 -0
  106. package/dist/es/api-model/models/item-shipping.js +14 -0
  107. package/dist/es/api-model/models/item-substitution-option.js +14 -0
  108. package/dist/es/api-model/models/item-substitution-preference.js +18 -0
  109. package/dist/es/api-model/models/measurement.js +39 -0
  110. package/dist/es/api-model/models/merchant-address.js +14 -0
  111. package/dist/es/api-model/models/model-error.js +14 -0
  112. package/dist/es/api-model/models/money.js +14 -0
  113. package/dist/es/api-model/models/order-fulfillment.js +14 -0
  114. package/dist/es/api-model/models/order-item.js +14 -0
  115. package/dist/es/api-model/models/order-package.js +14 -0
  116. package/dist/es/api-model/models/order-proceeds.js +14 -0
  117. package/dist/es/api-model/models/order.js +14 -0
  118. package/dist/es/api-model/models/package-item.js +14 -0
  119. package/dist/es/api-model/models/package-status.js +21 -0
  120. package/dist/es/api-model/models/pagination.js +14 -0
  121. package/dist/es/api-model/models/points-granted.js +14 -0
  122. package/dist/es/api-model/models/preferred-delivery-time.js +14 -0
  123. package/dist/es/api-model/models/recipient.js +14 -0
  124. package/dist/es/api-model/models/sales-channel.js +14 -0
  125. package/dist/es/api-model/models/search-orders-response.js +14 -0
  126. package/dist/es/api-model/models/time-window.js +14 -0
  127. package/dist/es/client.js +9 -0
  128. package/dist/es/index.js +3 -0
  129. package/dist/types/api-model/api/orders-api.d.ts +208 -0
  130. package/dist/types/api-model/api.d.ts +12 -0
  131. package/dist/types/api-model/base.d.ts +42 -0
  132. package/dist/types/api-model/common.d.ts +34 -0
  133. package/dist/types/api-model/configuration.d.ts +98 -0
  134. package/dist/types/api-model/index.d.ts +14 -0
  135. package/dist/types/api-model/models/address-extended-fields.d.ts +32 -0
  136. package/dist/types/api-model/models/alias.d.ts +24 -0
  137. package/dist/types/api-model/models/associated-order.d.ts +24 -0
  138. package/dist/types/api-model/models/business-hour.d.ts +35 -0
  139. package/dist/types/api-model/models/buyer.d.ts +32 -0
  140. package/dist/types/api-model/models/constraint-type.d.ts +18 -0
  141. package/dist/types/api-model/models/customer-address.d.ts +70 -0
  142. package/dist/types/api-model/models/date-time-range.d.ts +24 -0
  143. package/dist/types/api-model/models/delivery-preference.d.ts +30 -0
  144. package/dist/types/api-model/models/error-list.d.ts +20 -0
  145. package/dist/types/api-model/models/exception-date.d.ts +34 -0
  146. package/dist/types/api-model/models/fulfillment-status.d.ts +24 -0
  147. package/dist/types/api-model/models/get-order-response.d.ts +18 -0
  148. package/dist/types/api-model/models/gift-option.d.ts +24 -0
  149. package/dist/types/api-model/models/hour-minute.d.ts +24 -0
  150. package/dist/types/api-model/models/index.d.ts +54 -0
  151. package/dist/types/api-model/models/item-cancellation-request.d.ts +24 -0
  152. package/dist/types/api-model/models/item-cancellation.d.ts +18 -0
  153. package/dist/types/api-model/models/item-condition.d.ts +28 -0
  154. package/dist/types/api-model/models/item-customization.d.ts +20 -0
  155. package/dist/types/api-model/models/item-expense.d.ts +18 -0
  156. package/dist/types/api-model/models/item-fulfillment.d.ts +30 -0
  157. package/dist/types/api-model/models/item-international-shipping.d.ts +20 -0
  158. package/dist/types/api-model/models/item-packing.d.ts +18 -0
  159. package/dist/types/api-model/models/item-picking.d.ts +18 -0
  160. package/dist/types/api-model/models/item-points-cost.d.ts +18 -0
  161. package/dist/types/api-model/models/item-price.d.ts +22 -0
  162. package/dist/types/api-model/models/item-proceeds-breakdown.d.ts +27 -0
  163. package/dist/types/api-model/models/item-proceeds-detailed-breakdown.d.ts +22 -0
  164. package/dist/types/api-model/models/item-proceeds.d.ts +23 -0
  165. package/dist/types/api-model/models/item-product.d.ts +38 -0
  166. package/dist/types/api-model/models/item-promotion-breakdown.d.ts +20 -0
  167. package/dist/types/api-model/models/item-promotion.d.ts +21 -0
  168. package/dist/types/api-model/models/item-shipping-constraints.d.ts +22 -0
  169. package/dist/types/api-model/models/item-shipping.d.ts +22 -0
  170. package/dist/types/api-model/models/item-substitution-option.d.ts +34 -0
  171. package/dist/types/api-model/models/item-substitution-preference.d.ts +31 -0
  172. package/dist/types/api-model/models/measurement.d.ts +51 -0
  173. package/dist/types/api-model/models/merchant-address.d.ts +56 -0
  174. package/dist/types/api-model/models/model-error.d.ts +28 -0
  175. package/dist/types/api-model/models/money.d.ts +24 -0
  176. package/dist/types/api-model/models/order-fulfillment.d.ts +29 -0
  177. package/dist/types/api-model/models/order-item.d.ts +42 -0
  178. package/dist/types/api-model/models/order-package.d.ts +49 -0
  179. package/dist/types/api-model/models/order-proceeds.d.ts +18 -0
  180. package/dist/types/api-model/models/order.d.ts +62 -0
  181. package/dist/types/api-model/models/package-item.d.ts +28 -0
  182. package/dist/types/api-model/models/package-status.d.ts +33 -0
  183. package/dist/types/api-model/models/pagination.d.ts +20 -0
  184. package/dist/types/api-model/models/points-granted.d.ts +22 -0
  185. package/dist/types/api-model/models/preferred-delivery-time.d.ts +26 -0
  186. package/dist/types/api-model/models/recipient.d.ts +20 -0
  187. package/dist/types/api-model/models/sales-channel.d.ts +28 -0
  188. package/dist/types/api-model/models/search-orders-response.d.ts +31 -0
  189. package/dist/types/api-model/models/time-window.d.ts +19 -0
  190. package/dist/types/client.d.ts +6 -0
  191. package/dist/types/index.d.ts +3 -0
  192. package/package.json +32 -3
@@ -0,0 +1,28 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * Detailed information about the physical condition and quality state of the item being sold.
14
+ */
15
+ export interface ItemCondition {
16
+ /**
17
+ * The primary condition category that broadly describes the item\'s state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`.
18
+ */
19
+ 'conditionType'?: string;
20
+ /**
21
+ * A more specific condition classification that provides additional detail about the item\'s quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`.
22
+ */
23
+ 'conditionSubtype'?: string;
24
+ /**
25
+ * Additional details provided by the seller to describe the specific condition of this particular item.
26
+ */
27
+ 'conditionNote'?: string;
28
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * Information about any personalization, customization, or special modifications applied to this order item.
14
+ */
15
+ export interface ItemCustomization {
16
+ /**
17
+ * The URL of the customized data for custom orders from the Amazon Custom program.
18
+ */
19
+ 'customizedUrl'?: string;
20
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemPointsCost } from './item-points-cost';
13
+ /**
14
+ * The expense information related to this specific item.
15
+ */
16
+ export interface ItemExpense {
17
+ 'pointsCost'?: ItemPointsCost;
18
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemPacking } from './item-packing';
13
+ import type { ItemPicking } from './item-picking';
14
+ import type { ItemShipping } from './item-shipping';
15
+ /**
16
+ * Information about how the order item should be processed, packed, and shipped to the customer.
17
+ */
18
+ export interface ItemFulfillment {
19
+ /**
20
+ * The number of units of this item that have been successfully processed and shipped.
21
+ */
22
+ 'quantityFulfilled'?: number;
23
+ /**
24
+ * The number of units of this item that remain to be processed and shipped.
25
+ */
26
+ 'quantityUnfulfilled'?: number;
27
+ 'picking'?: ItemPicking;
28
+ 'packing'?: ItemPacking;
29
+ 'shipping'?: ItemShipping;
30
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * Additional requirements needed for cross-border shipping of an order item.
14
+ */
15
+ export interface ItemInternationalShipping {
16
+ /**
17
+ * Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.
18
+ */
19
+ 'iossNumber'?: string;
20
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { GiftOption } from './gift-option';
13
+ /**
14
+ * Information related to the packaging process for an order item.
15
+ */
16
+ export interface ItemPacking {
17
+ 'giftOption'?: GiftOption;
18
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemSubstitutionPreference } from './item-substitution-preference';
13
+ /**
14
+ * Information related to the warehouse picking process for an order item.
15
+ */
16
+ export interface ItemPicking {
17
+ 'substitutionPreference'?: ItemSubstitutionPreference;
18
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { PointsGranted } from './points-granted';
13
+ /**
14
+ * Information about Amazon Points granted with the purchase of an item, including both quantity and monetary equivalent value.
15
+ */
16
+ export interface ItemPointsCost {
17
+ 'pointsGranted'?: PointsGranted;
18
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { Money } from './money';
13
+ /**
14
+ * Pricing information for the order item.
15
+ */
16
+ export interface ItemPrice {
17
+ 'unitPrice'?: Money;
18
+ /**
19
+ * Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`
20
+ */
21
+ 'priceDesignation'?: string;
22
+ }
@@ -0,0 +1,27 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemProceedsDetailedBreakdown } from './item-proceeds-detailed-breakdown';
13
+ import type { Money } from './money';
14
+ /**
15
+ * Detailed proceeds breakdown for a specific order item.
16
+ */
17
+ export interface ItemProceedsBreakdown {
18
+ /**
19
+ * Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`
20
+ */
21
+ 'type'?: string;
22
+ 'subtotal'?: Money;
23
+ /**
24
+ * Further granular breakdown of the subtotal.
25
+ */
26
+ 'detailedBreakdowns'?: Array<ItemProceedsDetailedBreakdown>;
27
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { Money } from './money';
13
+ /**
14
+ * Further granular breakdown of the subtotal of the proceeds breakdown, only available for TAX and DISCOUNT proceeds type.
15
+ */
16
+ export interface ItemProceedsDetailedBreakdown {
17
+ /**
18
+ * Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`
19
+ */
20
+ 'subtype'?: string;
21
+ 'value'?: Money;
22
+ }
@@ -0,0 +1,23 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemProceedsBreakdown } from './item-proceeds-breakdown';
13
+ import type { Money } from './money';
14
+ /**
15
+ * The money that the seller receives from the sale of this specific item.
16
+ */
17
+ export interface ItemProceeds {
18
+ 'proceedsTotal'?: Money;
19
+ /**
20
+ * The breakdown of proceeds.
21
+ */
22
+ 'breakdowns'?: Array<ItemProceedsBreakdown>;
23
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemCondition } from './item-condition';
13
+ import type { ItemCustomization } from './item-customization';
14
+ import type { ItemPrice } from './item-price';
15
+ /**
16
+ * Product information for an order item.
17
+ */
18
+ export interface ItemProduct {
19
+ /**
20
+ * The Amazon Standard Identification Number (ASIN), which uniquely identifies a product (catalog item).
21
+ */
22
+ 'asin'?: string;
23
+ /**
24
+ * The product name or title as displayed to customers in the marketplace.
25
+ */
26
+ 'title'?: string;
27
+ /**
28
+ * The seller SKU of a product (catalog item). This is a unique number assigned by the seller when listing an item.
29
+ */
30
+ 'sellerSku'?: string;
31
+ 'condition'?: ItemCondition;
32
+ 'price'?: ItemPrice;
33
+ /**
34
+ * Unique serial numbers for products that require individual tracking, typically provided for FBA orders.
35
+ */
36
+ 'serialNumbers'?: Array<string>;
37
+ 'customization'?: ItemCustomization;
38
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * Detailed information about a specific promotional offer applied to an order item.
14
+ */
15
+ export interface ItemPromotionBreakdown {
16
+ /**
17
+ * Unique identifier for the promotion applied to this item.
18
+ */
19
+ 'promotionId'?: string;
20
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemPromotionBreakdown } from './item-promotion-breakdown';
13
+ /**
14
+ * Details about any discounts, coupons, or promotional offers applied to this item.
15
+ */
16
+ export interface ItemPromotion {
17
+ /**
18
+ * A list of promotions applied to the order item.
19
+ */
20
+ 'breakdowns'?: Array<ItemPromotionBreakdown>;
21
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ConstraintType } from './constraint-type';
13
+ /**
14
+ * Special shipping requirements and restrictions that must be observed when shipping an order item.
15
+ */
16
+ export interface ItemShippingConstraints {
17
+ 'palletDelivery'?: ConstraintType;
18
+ 'cashOnDelivery'?: ConstraintType;
19
+ 'signatureConfirmation'?: ConstraintType;
20
+ 'recipientIdentityVerification'?: ConstraintType;
21
+ 'recipientAgeVerification'?: ConstraintType;
22
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { DateTimeRange } from './date-time-range';
13
+ import type { ItemInternationalShipping } from './item-international-shipping';
14
+ import type { ItemShippingConstraints } from './item-shipping-constraints';
15
+ /**
16
+ * Information related to the shipping and delivery process for an order item.
17
+ */
18
+ export interface ItemShipping {
19
+ 'scheduledDeliveryWindow'?: DateTimeRange;
20
+ 'shippingConstraints'?: ItemShippingConstraints;
21
+ 'internationalShipping'?: ItemInternationalShipping;
22
+ }
@@ -0,0 +1,34 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { Measurement } from './measurement';
13
+ /**
14
+ * Alternative product that can be substituted for an original order item when it becomes unavailable during fulfillment.
15
+ */
16
+ export interface ItemSubstitutionOption {
17
+ /**
18
+ * Amazon Standard Identification Number of the substitute product.
19
+ */
20
+ 'asin'?: string;
21
+ /**
22
+ * Number of units of the substitute item to be selected if substitution occurs.
23
+ */
24
+ 'quantityOrdered'?: number;
25
+ /**
26
+ * The item\'s seller stock keeping unit (SKU).
27
+ */
28
+ 'sellerSku'?: string;
29
+ /**
30
+ * Product name or title of the substitute item as displayed to customers.
31
+ */
32
+ 'title'?: string;
33
+ 'measurement'?: Measurement;
34
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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 type { ItemSubstitutionOption } from './item-substitution-option';
13
+ /**
14
+ * Substitution preference for an order item when it becomes unavailable during fulfillment.
15
+ */
16
+ export interface ItemSubstitutionPreference {
17
+ /**
18
+ * Source and nature of the substitution preferences for this item.
19
+ */
20
+ 'substitutionType': ItemSubstitutionPreferenceSubstitutionTypeEnum;
21
+ /**
22
+ * List of alternative products that can be substituted for the original item if it becomes unavailable.
23
+ */
24
+ 'substitutionOptions'?: Array<ItemSubstitutionOption>;
25
+ }
26
+ export declare const ItemSubstitutionPreferenceSubstitutionTypeEnum: {
27
+ readonly CustomerPreference: "CUSTOMER_PREFERENCE";
28
+ readonly AmazonRecommended: "AMAZON_RECOMMENDED";
29
+ readonly DoNotSubstitute: "DO_NOT_SUBSTITUTE";
30
+ };
31
+ export type ItemSubstitutionPreferenceSubstitutionTypeEnum = typeof ItemSubstitutionPreferenceSubstitutionTypeEnum[keyof typeof ItemSubstitutionPreferenceSubstitutionTypeEnum];
@@ -0,0 +1,51 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * Specifies the unit of measure and quantity for items that are sold by weight, volume, length, or other measurements rather than simple count.
14
+ */
15
+ export interface Measurement {
16
+ /**
17
+ * The specific unit of measurement used to quantify this item.
18
+ */
19
+ 'unit': MeasurementUnitEnum;
20
+ /**
21
+ * The numerical quantity or amount being measured in the specified unit.
22
+ */
23
+ 'value': number;
24
+ }
25
+ export declare const MeasurementUnitEnum: {
26
+ readonly Ounces: "OUNCES";
27
+ readonly Pounds: "POUNDS";
28
+ readonly Kilograms: "KILOGRAMS";
29
+ readonly Grams: "GRAMS";
30
+ readonly Milligrams: "MILLIGRAMS";
31
+ readonly Inches: "INCHES";
32
+ readonly Feet: "FEET";
33
+ readonly Meters: "METERS";
34
+ readonly Centimeters: "CENTIMETERS";
35
+ readonly Millimeters: "MILLIMETERS";
36
+ readonly SquareMeters: "SQUARE_METERS";
37
+ readonly SquareCentimeters: "SQUARE_CENTIMETERS";
38
+ readonly SquareFeet: "SQUARE_FEET";
39
+ readonly SquareInches: "SQUARE_INCHES";
40
+ readonly Gallons: "GALLONS";
41
+ readonly Pints: "PINTS";
42
+ readonly Quarts: "QUARTS";
43
+ readonly FluidOunces: "FLUID_OUNCES";
44
+ readonly Liters: "LITERS";
45
+ readonly CubicMeters: "CUBIC_METERS";
46
+ readonly CubicFeet: "CUBIC_FEET";
47
+ readonly CubicInches: "CUBIC_INCHES";
48
+ readonly CubicCentimeters: "CUBIC_CENTIMETERS";
49
+ readonly Count: "COUNT";
50
+ };
51
+ export type MeasurementUnitEnum = typeof MeasurementUnitEnum[keyof typeof MeasurementUnitEnum];
@@ -0,0 +1,56 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * The physical address of the merchant.
14
+ */
15
+ export interface MerchantAddress {
16
+ /**
17
+ * The name of the business or facility at this address.
18
+ */
19
+ 'name'?: string;
20
+ /**
21
+ * The primary street address of the merchant\'s location.
22
+ */
23
+ 'addressLine1'?: string;
24
+ /**
25
+ * Additional address information.
26
+ */
27
+ 'addressLine2'?: string;
28
+ /**
29
+ * Additional address information.
30
+ */
31
+ 'addressLine3'?: string;
32
+ /**
33
+ * The city of the address.
34
+ */
35
+ 'city'?: string;
36
+ /**
37
+ * The district or county of the address.
38
+ */
39
+ 'districtOrCounty'?: string;
40
+ /**
41
+ * The state, province, or region of the address.
42
+ */
43
+ 'stateOrRegion'?: string;
44
+ /**
45
+ * The municipality of the address.
46
+ */
47
+ 'municipality'?: string;
48
+ /**
49
+ * The postal code or ZIP code of the address.
50
+ */
51
+ 'postalCode'?: string;
52
+ /**
53
+ * The two-letter country code for the address, in ISO 3166-1 format.
54
+ */
55
+ 'countryCode'?: string;
56
+ }
@@ -0,0 +1,28 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * Error response returned when the request is unsuccessful.
14
+ */
15
+ export interface ModelError {
16
+ /**
17
+ * An error code that identifies the type of error that occurred.
18
+ */
19
+ 'code': string;
20
+ /**
21
+ * A message that describes the error condition.
22
+ */
23
+ 'message': string;
24
+ /**
25
+ * Additional details that can help the caller understand or fix the issue.
26
+ */
27
+ 'details'?: string;
28
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * The Selling Partner API for Orders
3
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders: - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
4
+ *
5
+ * The version of the OpenAPI document: 2026-01-01
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
+ /**
13
+ * An amount of money, including units in the form of currency.
14
+ */
15
+ export interface Money {
16
+ /**
17
+ * A decimal number with no loss of precision. Follows RFC 7159 for number representation.
18
+ */
19
+ 'amount': string;
20
+ /**
21
+ * The three-letter currency code that identifies the currency type, following ISO 4217 international standards.
22
+ */
23
+ 'currencyCode': string;
24
+ }