@sp-api-sdk/orders-api-v0 1.12.3 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/dist/cjs/src/api-model/api/orders-v0-api.js +45 -45
  2. package/dist/cjs/src/api-model/models/address.js +4 -9
  3. package/dist/cjs/src/api-model/models/index.js +2 -0
  4. package/dist/cjs/src/api-model/models/order-item.js +4 -9
  5. package/dist/cjs/src/api-model/models/order-items-inner.js +15 -0
  6. package/dist/cjs/src/api-model/models/order.js +30 -55
  7. package/dist/cjs/src/api-model/models/regulated-information-field.js +4 -9
  8. package/dist/cjs/src/api-model/models/regulated-order-verification-status.js +0 -13
  9. package/dist/cjs/src/api-model/models/shipment-status.js +5 -6
  10. package/dist/cjs/src/api-model/models/tax-collection.js +6 -16
  11. package/dist/cjs/src/api-model/models/update-verification-status-request-body.js +0 -10
  12. package/dist/cjs/src/api-model/models/verification-status.js +28 -0
  13. package/dist/cjs/src/client.js +19 -12
  14. package/dist/es/src/api-model/api/orders-v0-api.js +45 -45
  15. package/dist/es/src/api-model/models/address.js +4 -9
  16. package/dist/es/src/api-model/models/index.js +2 -0
  17. package/dist/es/src/api-model/models/order-item.js +4 -9
  18. package/dist/es/src/api-model/models/order-items-inner.js +14 -0
  19. package/dist/es/src/api-model/models/order.js +30 -55
  20. package/dist/es/src/api-model/models/regulated-information-field.js +4 -9
  21. package/dist/es/src/api-model/models/regulated-order-verification-status.js +1 -12
  22. package/dist/es/src/api-model/models/shipment-status.js +5 -6
  23. package/dist/es/src/api-model/models/tax-collection.js +6 -16
  24. package/dist/es/src/api-model/models/update-verification-status-request-body.js +1 -9
  25. package/dist/es/src/api-model/models/verification-status.js +25 -0
  26. package/dist/es/src/client.js +19 -12
  27. package/dist/types/src/api-model/api/orders-v0-api.d.ts +70 -70
  28. package/dist/types/src/api-model/base.d.ts +2 -2
  29. package/dist/types/src/api-model/common.d.ts +7 -7
  30. package/dist/types/src/api-model/models/address.d.ts +18 -21
  31. package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +3 -3
  32. package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +1 -1
  33. package/dist/types/src/api-model/models/buyer-info.d.ts +5 -5
  34. package/dist/types/src/api-model/models/buyer-requested-cancel.d.ts +3 -3
  35. package/dist/types/src/api-model/models/buyer-tax-info.d.ts +3 -3
  36. package/dist/types/src/api-model/models/buyer-tax-information.d.ts +4 -4
  37. package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +1 -1
  38. package/dist/types/src/api-model/models/get-order-address-response.d.ts +2 -2
  39. package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +2 -2
  40. package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +2 -2
  41. package/dist/types/src/api-model/models/get-order-items-response.d.ts +2 -2
  42. package/dist/types/src/api-model/models/get-order-regulated-info-response.d.ts +2 -2
  43. package/dist/types/src/api-model/models/get-order-response.d.ts +2 -2
  44. package/dist/types/src/api-model/models/get-orders-response.d.ts +2 -2
  45. package/dist/types/src/api-model/models/index.d.ts +2 -0
  46. package/dist/types/src/api-model/models/item-buyer-info.d.ts +5 -5
  47. package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +1 -1
  48. package/dist/types/src/api-model/models/model-error.d.ts +3 -3
  49. package/dist/types/src/api-model/models/money.d.ts +2 -2
  50. package/dist/types/src/api-model/models/order-address.d.ts +2 -2
  51. package/dist/types/src/api-model/models/order-buyer-info.d.ts +6 -6
  52. package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +6 -6
  53. package/dist/types/src/api-model/models/order-item.d.ts +39 -42
  54. package/dist/types/src/api-model/models/order-items-buyer-info-list.d.ts +3 -3
  55. package/dist/types/src/api-model/models/order-items-inner.d.ts +30 -0
  56. package/dist/types/src/api-model/models/order-items-list.d.ts +3 -3
  57. package/dist/types/src/api-model/models/order-regulated-info.d.ts +4 -4
  58. package/dist/types/src/api-model/models/order.d.ts +86 -95
  59. package/dist/types/src/api-model/models/orders-list.d.ts +4 -4
  60. package/dist/types/src/api-model/models/payment-execution-detail-item.d.ts +2 -2
  61. package/dist/types/src/api-model/models/points-granted-detail.d.ts +2 -2
  62. package/dist/types/src/api-model/models/product-info-detail.d.ts +1 -1
  63. package/dist/types/src/api-model/models/regulated-information-field.d.ts +9 -12
  64. package/dist/types/src/api-model/models/regulated-information.d.ts +1 -1
  65. package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +9 -19
  66. package/dist/types/src/api-model/models/rejection-reason.d.ts +2 -2
  67. package/dist/types/src/api-model/models/shipment-status.d.ts +6 -5
  68. package/dist/types/src/api-model/models/tax-classification.d.ts +2 -2
  69. package/dist/types/src/api-model/models/tax-collection.d.ts +10 -16
  70. package/dist/types/src/api-model/models/update-shipment-status-error-response.d.ts +1 -1
  71. package/dist/types/src/api-model/models/update-shipment-status-request.d.ts +5 -4
  72. package/dist/types/src/api-model/models/update-verification-status-error-response.d.ts +1 -1
  73. package/dist/types/src/api-model/models/update-verification-status-request-body.d.ts +6 -13
  74. package/dist/types/src/api-model/models/update-verification-status-request.d.ts +1 -1
  75. package/dist/types/src/api-model/models/verification-status.d.ts +24 -0
  76. package/package.json +4 -4
@@ -26,211 +26,208 @@ export interface OrderItem {
26
26
  * @type {string}
27
27
  * @memberof OrderItem
28
28
  */
29
- ASIN: string;
29
+ 'ASIN': string;
30
30
  /**
31
31
  * The seller stock keeping unit (SKU) of the item.
32
32
  * @type {string}
33
33
  * @memberof OrderItem
34
34
  */
35
- SellerSKU?: string;
35
+ 'SellerSKU'?: string;
36
36
  /**
37
37
  * An Amazon-defined order item identifier.
38
38
  * @type {string}
39
39
  * @memberof OrderItem
40
40
  */
41
- OrderItemId: string;
41
+ 'OrderItemId': string;
42
42
  /**
43
43
  * The name of the item.
44
44
  * @type {string}
45
45
  * @memberof OrderItem
46
46
  */
47
- Title?: string;
47
+ 'Title'?: string;
48
48
  /**
49
49
  * The number of items in the order.
50
50
  * @type {number}
51
51
  * @memberof OrderItem
52
52
  */
53
- QuantityOrdered: number;
53
+ 'QuantityOrdered': number;
54
54
  /**
55
55
  * The number of items shipped.
56
56
  * @type {number}
57
57
  * @memberof OrderItem
58
58
  */
59
- QuantityShipped?: number;
59
+ 'QuantityShipped'?: number;
60
60
  /**
61
61
  *
62
62
  * @type {ProductInfoDetail}
63
63
  * @memberof OrderItem
64
64
  */
65
- ProductInfo?: ProductInfoDetail;
65
+ 'ProductInfo'?: ProductInfoDetail;
66
66
  /**
67
67
  *
68
68
  * @type {PointsGrantedDetail}
69
69
  * @memberof OrderItem
70
70
  */
71
- PointsGranted?: PointsGrantedDetail;
71
+ 'PointsGranted'?: PointsGrantedDetail;
72
72
  /**
73
73
  *
74
74
  * @type {Money}
75
75
  * @memberof OrderItem
76
76
  */
77
- ItemPrice?: Money;
77
+ 'ItemPrice'?: Money;
78
78
  /**
79
79
  *
80
80
  * @type {Money}
81
81
  * @memberof OrderItem
82
82
  */
83
- ShippingPrice?: Money;
83
+ 'ShippingPrice'?: Money;
84
84
  /**
85
85
  *
86
86
  * @type {Money}
87
87
  * @memberof OrderItem
88
88
  */
89
- ItemTax?: Money;
89
+ 'ItemTax'?: Money;
90
90
  /**
91
91
  *
92
92
  * @type {Money}
93
93
  * @memberof OrderItem
94
94
  */
95
- ShippingTax?: Money;
95
+ 'ShippingTax'?: Money;
96
96
  /**
97
97
  *
98
98
  * @type {Money}
99
99
  * @memberof OrderItem
100
100
  */
101
- ShippingDiscount?: Money;
101
+ 'ShippingDiscount'?: Money;
102
102
  /**
103
103
  *
104
104
  * @type {Money}
105
105
  * @memberof OrderItem
106
106
  */
107
- ShippingDiscountTax?: Money;
107
+ 'ShippingDiscountTax'?: Money;
108
108
  /**
109
109
  *
110
110
  * @type {Money}
111
111
  * @memberof OrderItem
112
112
  */
113
- PromotionDiscount?: Money;
113
+ 'PromotionDiscount'?: Money;
114
114
  /**
115
115
  *
116
116
  * @type {Money}
117
117
  * @memberof OrderItem
118
118
  */
119
- PromotionDiscountTax?: Money;
119
+ 'PromotionDiscountTax'?: Money;
120
120
  /**
121
121
  * A list of promotion identifiers provided by the seller when the promotions were created.
122
122
  * @type {Array<string>}
123
123
  * @memberof OrderItem
124
124
  */
125
- PromotionIds?: Array<string>;
125
+ 'PromotionIds'?: Array<string>;
126
126
  /**
127
127
  *
128
128
  * @type {Money}
129
129
  * @memberof OrderItem
130
130
  */
131
- CODFee?: Money;
131
+ 'CODFee'?: Money;
132
132
  /**
133
133
  *
134
134
  * @type {Money}
135
135
  * @memberof OrderItem
136
136
  */
137
- CODFeeDiscount?: Money;
137
+ 'CODFeeDiscount'?: Money;
138
138
  /**
139
139
  * When true, the item is a gift.
140
140
  * @type {boolean}
141
141
  * @memberof OrderItem
142
142
  */
143
- IsGift?: boolean;
143
+ 'IsGift'?: boolean;
144
144
  /**
145
145
  * The condition of the item as described by the seller.
146
146
  * @type {string}
147
147
  * @memberof OrderItem
148
148
  */
149
- ConditionNote?: string;
149
+ 'ConditionNote'?: string;
150
150
  /**
151
151
  * The condition of the item. Possible values: New, Used, Collectible, Refurbished, Preorder, Club.
152
152
  * @type {string}
153
153
  * @memberof OrderItem
154
154
  */
155
- ConditionId?: string;
155
+ 'ConditionId'?: string;
156
156
  /**
157
157
  * The subcondition of the item. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, Any, Other.
158
158
  * @type {string}
159
159
  * @memberof OrderItem
160
160
  */
161
- ConditionSubtypeId?: string;
161
+ 'ConditionSubtypeId'?: string;
162
162
  /**
163
163
  * The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format.
164
164
  * @type {string}
165
165
  * @memberof OrderItem
166
166
  */
167
- ScheduledDeliveryStartDate?: string;
167
+ 'ScheduledDeliveryStartDate'?: string;
168
168
  /**
169
169
  * The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format.
170
170
  * @type {string}
171
171
  * @memberof OrderItem
172
172
  */
173
- ScheduledDeliveryEndDate?: string;
173
+ 'ScheduledDeliveryEndDate'?: string;
174
174
  /**
175
175
  * Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, see the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). Possible values: BusinessPrice - A special price that is available only for Amazon Business orders.
176
176
  * @type {string}
177
177
  * @memberof OrderItem
178
178
  */
179
- PriceDesignation?: string;
179
+ 'PriceDesignation'?: string;
180
180
  /**
181
181
  *
182
182
  * @type {TaxCollection}
183
183
  * @memberof OrderItem
184
184
  */
185
- TaxCollection?: TaxCollection;
185
+ 'TaxCollection'?: TaxCollection;
186
186
  /**
187
187
  * When true, the product type for this item has a serial number. Returned only for Amazon Easy Ship orders.
188
188
  * @type {boolean}
189
189
  * @memberof OrderItem
190
190
  */
191
- SerialNumberRequired?: boolean;
191
+ 'SerialNumberRequired'?: boolean;
192
192
  /**
193
193
  * When true, transparency codes are required.
194
194
  * @type {boolean}
195
195
  * @memberof OrderItem
196
196
  */
197
- IsTransparency?: boolean;
197
+ 'IsTransparency'?: boolean;
198
198
  /**
199
199
  * The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.
200
200
  * @type {string}
201
201
  * @memberof OrderItem
202
202
  */
203
- IossNumber?: string;
203
+ 'IossNumber'?: string;
204
204
  /**
205
205
  * The store chain store identifier. Linked to a specific store in a store chain.
206
206
  * @type {string}
207
207
  * @memberof OrderItem
208
208
  */
209
- StoreChainStoreId?: string;
209
+ 'StoreChainStoreId'?: string;
210
210
  /**
211
211
  * The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK.
212
212
  * @type {string}
213
213
  * @memberof OrderItem
214
214
  */
215
- DeemedResellerCategory?: OrderItemDeemedResellerCategoryEnum;
215
+ 'DeemedResellerCategory'?: OrderItemDeemedResellerCategoryEnum;
216
216
  /**
217
217
  *
218
218
  * @type {ItemBuyerInfo}
219
219
  * @memberof OrderItem
220
220
  */
221
- BuyerInfo?: ItemBuyerInfo;
221
+ 'BuyerInfo'?: ItemBuyerInfo;
222
222
  /**
223
223
  *
224
224
  * @type {BuyerRequestedCancel}
225
225
  * @memberof OrderItem
226
226
  */
227
- BuyerRequestedCancel?: BuyerRequestedCancel;
228
- }
229
- /**
230
- * @export
231
- * @enum {string}
232
- */
233
- export declare enum OrderItemDeemedResellerCategoryEnum {
234
- Ioss = "IOSS",
235
- Uoss = "UOSS"
227
+ 'BuyerRequestedCancel'?: BuyerRequestedCancel;
236
228
  }
229
+ export declare const OrderItemDeemedResellerCategoryEnum: {
230
+ readonly Ioss: "IOSS";
231
+ readonly Uoss: "UOSS";
232
+ };
233
+ export declare type OrderItemDeemedResellerCategoryEnum = typeof OrderItemDeemedResellerCategoryEnum[keyof typeof OrderItemDeemedResellerCategoryEnum];
@@ -21,17 +21,17 @@ export interface OrderItemsBuyerInfoList {
21
21
  * @type {Array<OrderItemBuyerInfo>}
22
22
  * @memberof OrderItemsBuyerInfoList
23
23
  */
24
- OrderItems: Array<OrderItemBuyerInfo>;
24
+ 'OrderItems': Array<OrderItemBuyerInfo>;
25
25
  /**
26
26
  * When present and not empty, pass this string token in the next request to return the next response page.
27
27
  * @type {string}
28
28
  * @memberof OrderItemsBuyerInfoList
29
29
  */
30
- NextToken?: string;
30
+ 'NextToken'?: string;
31
31
  /**
32
32
  * An Amazon-defined order identifier, in 3-7-7 format.
33
33
  * @type {string}
34
34
  * @memberof OrderItemsBuyerInfoList
35
35
  */
36
- AmazonOrderId: string;
36
+ 'AmazonOrderId': string;
37
37
  }
@@ -0,0 +1,30 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface OrderItemsInner
16
+ */
17
+ export interface OrderItemsInner {
18
+ /**
19
+ * the unique identifier for the order item
20
+ * @type {string}
21
+ * @memberof OrderItemsInner
22
+ */
23
+ 'orderItemId'?: string;
24
+ /**
25
+ * the quantity of items that needs an update of the shipment status
26
+ * @type {number}
27
+ * @memberof OrderItemsInner
28
+ */
29
+ 'quantity'?: number;
30
+ }
@@ -21,17 +21,17 @@ export interface OrderItemsList {
21
21
  * @type {Array<OrderItem>}
22
22
  * @memberof OrderItemsList
23
23
  */
24
- OrderItems: Array<OrderItem>;
24
+ 'OrderItems': Array<OrderItem>;
25
25
  /**
26
26
  * When present and not empty, pass this string token in the next request to return the next response page.
27
27
  * @type {string}
28
28
  * @memberof OrderItemsList
29
29
  */
30
- NextToken?: string;
30
+ 'NextToken'?: string;
31
31
  /**
32
32
  * An Amazon-defined order identifier, in 3-7-7 format.
33
33
  * @type {string}
34
34
  * @memberof OrderItemsList
35
35
  */
36
- AmazonOrderId: string;
36
+ 'AmazonOrderId': string;
37
37
  }
@@ -22,23 +22,23 @@ export interface OrderRegulatedInfo {
22
22
  * @type {string}
23
23
  * @memberof OrderRegulatedInfo
24
24
  */
25
- AmazonOrderId: string;
25
+ 'AmazonOrderId': string;
26
26
  /**
27
27
  *
28
28
  * @type {RegulatedInformation}
29
29
  * @memberof OrderRegulatedInfo
30
30
  */
31
- RegulatedInformation: RegulatedInformation;
31
+ 'RegulatedInformation': RegulatedInformation;
32
32
  /**
33
33
  * Whether the order requires attaching a dosage information label when shipped.
34
34
  * @type {boolean}
35
35
  * @memberof OrderRegulatedInfo
36
36
  */
37
- RequiresDosageLabel: boolean;
37
+ 'RequiresDosageLabel': boolean;
38
38
  /**
39
39
  *
40
40
  * @type {RegulatedOrderVerificationStatus}
41
41
  * @memberof OrderRegulatedInfo
42
42
  */
43
- RegulatedOrderVerificationStatus: RegulatedOrderVerificationStatus;
43
+ 'RegulatedOrderVerificationStatus': RegulatedOrderVerificationStatus;
44
44
  }