@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,98 @@
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
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
23
+ export interface ConfigurationParameters {
24
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
+ username?: string;
26
+ password?: string;
27
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
29
+ basePath?: string;
30
+ serverIndex?: number;
31
+ baseOptions?: any;
32
+ formDataCtor?: new () => any;
33
+ }
34
+ export declare class Configuration {
35
+ /**
36
+ * parameter for apiKey security
37
+ * @param name security name
38
+ */
39
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
+ /**
41
+ * parameter for basic security
42
+ */
43
+ username?: string;
44
+ /**
45
+ * parameter for basic security
46
+ */
47
+ password?: string;
48
+ /**
49
+ * parameter for oauth2 security
50
+ * @param name security name
51
+ * @param scopes oauth2 scope
52
+ */
53
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
62
+ * @memberof Configuration
63
+ */
64
+ awsv4?: AWSv4Configuration;
65
+ /**
66
+ * override base path
67
+ */
68
+ basePath?: string;
69
+ /**
70
+ * override server index
71
+ */
72
+ serverIndex?: number;
73
+ /**
74
+ * base options for axios calls
75
+ */
76
+ baseOptions?: any;
77
+ /**
78
+ * The FormData constructor that will be used to create multipart form data
79
+ * requests. You can inject this here so that execution environments that
80
+ * do not support the FormData class can still run the generated client.
81
+ *
82
+ * @type {new () => FormData}
83
+ */
84
+ formDataCtor?: new () => any;
85
+ constructor(param?: ConfigurationParameters);
86
+ /**
87
+ * Check if the given MIME is a JSON MIME.
88
+ * JSON MIME examples:
89
+ * application/json
90
+ * application/json; charset=UTF8
91
+ * APPLICATION/JSON
92
+ * application/vnd.company+json
93
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
94
+ * @return True if the given MIME is JSON, false otherwise.
95
+ */
96
+ isJsonMime(mime: string): boolean;
97
+ }
98
+ export {};
@@ -0,0 +1,14 @@
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
+ export * from "./api";
13
+ export * from "./configuration";
14
+ export * from "./models";
@@ -0,0 +1,32 @@
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 address components that provide more detailed location information, helping with precise delivery routing. **Note**: Only available with Brazil shipping addresses.
14
+ */
15
+ export interface AddressExtendedFields {
16
+ /**
17
+ * The name of the street.
18
+ */
19
+ 'streetName'?: string;
20
+ /**
21
+ * The house, building, or property number associated with the location\'s street address.
22
+ */
23
+ 'streetNumber'?: string;
24
+ /**
25
+ * The floor number / unit number.
26
+ */
27
+ 'complement'?: string;
28
+ /**
29
+ * The neighborhood. This value is only used in some countries (such as Brazil).
30
+ */
31
+ 'neighborhood'?: string;
32
+ }
@@ -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 alternative identifier that provides a different way to reference the same order.
14
+ */
15
+ export interface Alias {
16
+ /**
17
+ * The alternative identifier value that can be used to reference this order.
18
+ */
19
+ 'aliasId': string;
20
+ /**
21
+ * The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`
22
+ */
23
+ 'aliasType': string;
24
+ }
@@ -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
+ * Another order that has a direct business relationship with the current order, such as replacements or exchanges.
14
+ */
15
+ export interface AssociatedOrder {
16
+ /**
17
+ * The unique identifier of the related order that is associated with the current order.
18
+ */
19
+ 'orderId'?: string;
20
+ /**
21
+ * The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`
22
+ */
23
+ 'associationType'?: string;
24
+ }
@@ -0,0 +1,35 @@
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 { TimeWindow } from './time-window';
13
+ /**
14
+ * Business days and hours when the destination is open for deliveries.
15
+ */
16
+ export interface BusinessHour {
17
+ /**
18
+ * Specific day of the week for which operating hours are being defined.
19
+ */
20
+ 'dayOfWeek'?: BusinessHourDayOfWeekEnum;
21
+ /**
22
+ * Collection of time windows during which the location is available for deliveries on the specified day.
23
+ */
24
+ 'timeWindows'?: Array<TimeWindow>;
25
+ }
26
+ export declare const BusinessHourDayOfWeekEnum: {
27
+ readonly Sun: "SUN";
28
+ readonly Mon: "MON";
29
+ readonly Tue: "TUE";
30
+ readonly Wed: "WED";
31
+ readonly Thu: "THU";
32
+ readonly Fri: "FRI";
33
+ readonly Sat: "SAT";
34
+ };
35
+ export type BusinessHourDayOfWeekEnum = typeof BusinessHourDayOfWeekEnum[keyof typeof BusinessHourDayOfWeekEnum];
@@ -0,0 +1,32 @@
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 the customer who purchased the order.
14
+ */
15
+ export interface Buyer {
16
+ /**
17
+ * The full name of the customer who placed the order.
18
+ */
19
+ 'buyerName'?: string;
20
+ /**
21
+ * The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders.
22
+ */
23
+ 'buyerEmail'?: string;
24
+ /**
25
+ * The name of the company or organization for a business order.
26
+ */
27
+ 'buyerCompanyName'?: string;
28
+ /**
29
+ * The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
30
+ */
31
+ 'buyerPurchaseOrderNumber'?: string;
32
+ }
@@ -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
+ /**
13
+ * Classification of the enforcement level required for shipping and delivery constraints.
14
+ */
15
+ export declare const ConstraintType: {
16
+ readonly Mandatory: "MANDATORY";
17
+ };
18
+ export type ConstraintType = typeof ConstraintType[keyof typeof ConstraintType];
@@ -0,0 +1,70 @@
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 { AddressExtendedFields } from './address-extended-fields';
13
+ /**
14
+ * The physical address of the customer.
15
+ */
16
+ export interface CustomerAddress {
17
+ /**
18
+ * The full name of the person who will receive the delivery at this address.
19
+ */
20
+ 'name'?: string;
21
+ /**
22
+ * The name of the business or organization at this address.
23
+ */
24
+ 'companyName'?: string;
25
+ /**
26
+ * The primary street address.
27
+ */
28
+ 'addressLine1'?: string;
29
+ /**
30
+ * Additional address information.
31
+ */
32
+ 'addressLine2'?: string;
33
+ /**
34
+ * Additional address information.
35
+ */
36
+ 'addressLine3'?: string;
37
+ /**
38
+ * The city of the address.
39
+ */
40
+ 'city'?: string;
41
+ /**
42
+ * The district or county of the address.
43
+ */
44
+ 'districtOrCounty'?: string;
45
+ /**
46
+ * The state, province, or region of the address.
47
+ */
48
+ 'stateOrRegion'?: string;
49
+ /**
50
+ * The municipality of the address.
51
+ */
52
+ 'municipality'?: string;
53
+ /**
54
+ * The postal code, ZIP code, or equivalent mailing code of the address.
55
+ */
56
+ 'postalCode'?: string;
57
+ /**
58
+ * The two-letter country code identifying the country of the address, in ISO 3166-1 format.
59
+ */
60
+ 'countryCode'?: string;
61
+ /**
62
+ * The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date.
63
+ */
64
+ 'phone'?: string;
65
+ 'extendedFields'?: AddressExtendedFields;
66
+ /**
67
+ * The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`
68
+ */
69
+ 'addressType'?: string;
70
+ }
@@ -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
+ * A time period with start and end boundaries.
14
+ */
15
+ export interface DateTimeRange {
16
+ /**
17
+ * The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
18
+ */
19
+ 'earliestDateTime'?: string;
20
+ /**
21
+ * The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
22
+ */
23
+ 'latestDateTime'?: string;
24
+ }
@@ -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 { PreferredDeliveryTime } from './preferred-delivery-time';
13
+ /**
14
+ * Contains all delivery instructions that the customer provides for the shipping address.
15
+ */
16
+ export interface DeliveryPreference {
17
+ /**
18
+ * The drop-off location selected by the customer.
19
+ */
20
+ 'dropOffLocation'?: string;
21
+ /**
22
+ * Building instructions, nearby landmark, or navigation instructions.
23
+ */
24
+ 'addressInstruction'?: string;
25
+ 'deliveryTime'?: PreferredDeliveryTime;
26
+ /**
27
+ * A list of miscellaneous delivery capabilities associated with the shipping address.
28
+ */
29
+ 'deliveryCapabilities'?: Array<string>;
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
+ * A list of error responses returned when a request is unsuccessful.
14
+ */
15
+ export interface ErrorList {
16
+ /**
17
+ * A list of errors.
18
+ */
19
+ 'errors': Array<Error>;
20
+ }
@@ -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 { TimeWindow } from './time-window';
13
+ /**
14
+ * Special dates when normal business hours are modified or suspended, requiring different delivery scheduling.
15
+ */
16
+ export interface ExceptionDate {
17
+ /**
18
+ * Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity.
19
+ */
20
+ 'exceptionDate'?: string;
21
+ /**
22
+ * Operational status of the business on the specified exception date.
23
+ */
24
+ 'exceptionDateType'?: ExceptionDateExceptionDateTypeEnum;
25
+ /**
26
+ * Alternative operating hours that apply specifically to this exception date.
27
+ */
28
+ 'timeWindows'?: Array<TimeWindow>;
29
+ }
30
+ export declare const ExceptionDateExceptionDateTypeEnum: {
31
+ readonly Closed: "CLOSED";
32
+ readonly Open: "OPEN";
33
+ };
34
+ export type ExceptionDateExceptionDateTypeEnum = typeof ExceptionDateExceptionDateTypeEnum[keyof typeof ExceptionDateExceptionDateTypeEnum];
@@ -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
+ * The current fulfillment status of an order, indicating where the order is in the fulfillment process from placement to handover to carrier.
14
+ */
15
+ export declare const FulfillmentStatus: {
16
+ readonly PendingAvailability: "PENDING_AVAILABILITY";
17
+ readonly Pending: "PENDING";
18
+ readonly Unshipped: "UNSHIPPED";
19
+ readonly PartiallyShipped: "PARTIALLY_SHIPPED";
20
+ readonly Shipped: "SHIPPED";
21
+ readonly Cancelled: "CANCELLED";
22
+ readonly Unfulfillable: "UNFULFILLABLE";
23
+ };
24
+ export type FulfillmentStatus = typeof FulfillmentStatus[keyof typeof FulfillmentStatus];
@@ -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 { Order } from './order';
13
+ /**
14
+ * Order details.
15
+ */
16
+ export interface GetOrderResponse {
17
+ 'order': Order;
18
+ }
@@ -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
+ * Gift wrapping and personalization options selected by the customer for an order item.
14
+ */
15
+ export interface GiftOption {
16
+ /**
17
+ * Personal message from the buyer to be included with the gift-wrapped item.
18
+ */
19
+ 'giftMessage'?: string;
20
+ /**
21
+ * Type or quality level of gift wrapping service selected by the customer.
22
+ */
23
+ 'giftWrapLevel'?: string;
24
+ }
@@ -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
+ * The time when the business opens or closes.
14
+ */
15
+ export interface HourMinute {
16
+ /**
17
+ * The hour when the business opens or closes, in 24-hour format (0-23).
18
+ */
19
+ 'hour'?: number;
20
+ /**
21
+ * The minute when the business opens or closes.
22
+ */
23
+ 'minute'?: number;
24
+ }
@@ -0,0 +1,54 @@
1
+ export * from './address-extended-fields';
2
+ export * from './alias';
3
+ export * from './associated-order';
4
+ export * from './business-hour';
5
+ export * from './buyer';
6
+ export * from './constraint-type';
7
+ export * from './customer-address';
8
+ export * from './date-time-range';
9
+ export * from './delivery-preference';
10
+ export * from './error-list';
11
+ export * from './exception-date';
12
+ export * from './fulfillment-status';
13
+ export * from './get-order-response';
14
+ export * from './gift-option';
15
+ export * from './hour-minute';
16
+ export * from './item-cancellation';
17
+ export * from './item-cancellation-request';
18
+ export * from './item-condition';
19
+ export * from './item-customization';
20
+ export * from './item-expense';
21
+ export * from './item-fulfillment';
22
+ export * from './item-international-shipping';
23
+ export * from './item-packing';
24
+ export * from './item-picking';
25
+ export * from './item-points-cost';
26
+ export * from './item-price';
27
+ export * from './item-proceeds';
28
+ export * from './item-proceeds-breakdown';
29
+ export * from './item-proceeds-detailed-breakdown';
30
+ export * from './item-product';
31
+ export * from './item-promotion';
32
+ export * from './item-promotion-breakdown';
33
+ export * from './item-shipping';
34
+ export * from './item-shipping-constraints';
35
+ export * from './item-substitution-option';
36
+ export * from './item-substitution-preference';
37
+ export * from './measurement';
38
+ export * from './merchant-address';
39
+ export * from './model-error';
40
+ export * from './money';
41
+ export * from './order';
42
+ export * from './order-fulfillment';
43
+ export * from './order-item';
44
+ export * from './order-package';
45
+ export * from './order-proceeds';
46
+ export * from './package-item';
47
+ export * from './package-status';
48
+ export * from './pagination';
49
+ export * from './points-granted';
50
+ export * from './preferred-delivery-time';
51
+ export * from './recipient';
52
+ export * from './sales-channel';
53
+ export * from './search-orders-response';
54
+ export * from './time-window';
@@ -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
+ * Detailed information about a cancellation request submitted for a specific order item.
14
+ */
15
+ export interface ItemCancellationRequest {
16
+ /**
17
+ * Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`
18
+ */
19
+ 'requester'?: string;
20
+ /**
21
+ * Explanation provided for why the cancellation was requested.
22
+ */
23
+ 'cancelReason'?: string;
24
+ }
@@ -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 { ItemCancellationRequest } from './item-cancellation-request';
13
+ /**
14
+ * The cancellation information of the order item.
15
+ */
16
+ export interface ItemCancellation {
17
+ 'cancellationRequest'?: ItemCancellationRequest;
18
+ }