@sp-api-sdk/amazon-warehousing-and-distribution-api-2024-05-09 5.1.0 → 5.2.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.
- package/README.md +4 -5
- package/dist/index.cjs +2265 -1928
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1821 -2220
- package/dist/index.d.ts +1821 -2220
- package/dist/index.js +2207 -1857
- package/dist/index.js.map +1 -1
- package/package.json +14 -6
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
7
6
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
14
13
|
* Do not edit the class manually.
|
|
15
14
|
*/
|
|
16
15
|
interface AWSv4Configuration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
26
25
|
}
|
|
27
26
|
interface ConfigurationParameters {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
27
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
+
username?: string;
|
|
29
|
+
password?: string;
|
|
30
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
32
|
+
basePath?: string;
|
|
33
|
+
serverIndex?: number;
|
|
34
|
+
baseOptions?: any;
|
|
35
|
+
formDataCtor?: new () => any;
|
|
37
36
|
}
|
|
38
37
|
declare class Configuration {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
105
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
-
* https://openapi-generator.tech
|
|
112
|
-
* Do not edit the class manually.
|
|
113
|
-
*/
|
|
114
|
-
|
|
38
|
+
/**
|
|
39
|
+
* parameter for apiKey security
|
|
40
|
+
* @param name security name
|
|
41
|
+
*/
|
|
42
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
43
|
+
/**
|
|
44
|
+
* parameter for basic security
|
|
45
|
+
*/
|
|
46
|
+
username?: string;
|
|
47
|
+
/**
|
|
48
|
+
* parameter for basic security
|
|
49
|
+
*/
|
|
50
|
+
password?: string;
|
|
51
|
+
/**
|
|
52
|
+
* parameter for oauth2 security
|
|
53
|
+
* @param name security name
|
|
54
|
+
* @param scopes oauth2 scope
|
|
55
|
+
*/
|
|
56
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
57
|
+
/**
|
|
58
|
+
* parameter for aws4 signature security
|
|
59
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
60
|
+
* @param {string} options.region - aws region
|
|
61
|
+
* @param {string} options.service - name of the service.
|
|
62
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
63
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
64
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
65
|
+
* @memberof Configuration
|
|
66
|
+
*/
|
|
67
|
+
awsv4?: AWSv4Configuration;
|
|
68
|
+
/**
|
|
69
|
+
* override base path
|
|
70
|
+
*/
|
|
71
|
+
basePath?: string;
|
|
72
|
+
/**
|
|
73
|
+
* override server index
|
|
74
|
+
*/
|
|
75
|
+
serverIndex?: number;
|
|
76
|
+
/**
|
|
77
|
+
* base options for axios calls
|
|
78
|
+
*/
|
|
79
|
+
baseOptions?: any;
|
|
80
|
+
/**
|
|
81
|
+
* The FormData constructor that will be used to create multipart form data
|
|
82
|
+
* requests. You can inject this here so that execution environments that
|
|
83
|
+
* do not support the FormData class can still run the generated client.
|
|
84
|
+
*
|
|
85
|
+
* @type {new () => FormData}
|
|
86
|
+
*/
|
|
87
|
+
formDataCtor?: new () => any;
|
|
88
|
+
constructor(param?: ConfigurationParameters);
|
|
89
|
+
/**
|
|
90
|
+
* Check if the given MIME is a JSON MIME.
|
|
91
|
+
* JSON MIME examples:
|
|
92
|
+
* application/json
|
|
93
|
+
* application/json; charset=UTF8
|
|
94
|
+
* APPLICATION/JSON
|
|
95
|
+
* application/vnd.company+json
|
|
96
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
97
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
98
|
+
*/
|
|
99
|
+
isJsonMime(mime: string): boolean;
|
|
100
|
+
}
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
112
|
}
|
|
125
|
-
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/address.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
128
117
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -138,52 +127,53 @@ declare class BaseAPI {
|
|
|
138
127
|
* Shipping address that represents the origin or destination location.
|
|
139
128
|
*/
|
|
140
129
|
interface Address {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
}
|
|
186
|
-
|
|
130
|
+
/**
|
|
131
|
+
* First line of the address text.
|
|
132
|
+
*/
|
|
133
|
+
'addressLine1': string;
|
|
134
|
+
/**
|
|
135
|
+
* Optional second line of the address text.
|
|
136
|
+
*/
|
|
137
|
+
'addressLine2'?: string;
|
|
138
|
+
/**
|
|
139
|
+
* Optional third line of the address text.
|
|
140
|
+
*/
|
|
141
|
+
'addressLine3'?: string;
|
|
142
|
+
/**
|
|
143
|
+
* Optional city where this address is located.
|
|
144
|
+
*/
|
|
145
|
+
'city'?: string;
|
|
146
|
+
/**
|
|
147
|
+
* Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.
|
|
148
|
+
*/
|
|
149
|
+
'countryCode': string;
|
|
150
|
+
/**
|
|
151
|
+
* Optional county where this address is located.
|
|
152
|
+
*/
|
|
153
|
+
'county'?: string;
|
|
154
|
+
/**
|
|
155
|
+
* Optional district where this address is located.
|
|
156
|
+
*/
|
|
157
|
+
'district'?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Name of the person, business, or institution at this address.
|
|
160
|
+
*/
|
|
161
|
+
'name': string;
|
|
162
|
+
/**
|
|
163
|
+
* Optional E.164-formatted phone number for an available contact at this address.
|
|
164
|
+
*/
|
|
165
|
+
'phoneNumber'?: string;
|
|
166
|
+
/**
|
|
167
|
+
* Optional postal code where this address is located.
|
|
168
|
+
*/
|
|
169
|
+
'postalCode'?: string;
|
|
170
|
+
/**
|
|
171
|
+
* State or region where this address is located. Note that this is contextual to the specified country code.
|
|
172
|
+
*/
|
|
173
|
+
'stateOrRegion': string;
|
|
174
|
+
}
|
|
175
|
+
//#endregion
|
|
176
|
+
//#region src/api-model/models/carrier-code-type.d.ts
|
|
187
177
|
/**
|
|
188
178
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
189
179
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -199,33 +189,23 @@ interface Address {
|
|
|
199
189
|
* Denotes the type for the carrier.
|
|
200
190
|
*/
|
|
201
191
|
declare const CarrierCodeType: {
|
|
202
|
-
|
|
192
|
+
readonly Scac: "SCAC";
|
|
203
193
|
};
|
|
204
194
|
type CarrierCodeType = typeof CarrierCodeType[keyof typeof CarrierCodeType];
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
208
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
209
|
-
*
|
|
210
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
214
|
-
* https://openapi-generator.tech
|
|
215
|
-
* Do not edit the class manually.
|
|
216
|
-
*/
|
|
217
|
-
|
|
195
|
+
//#endregion
|
|
196
|
+
//#region src/api-model/models/carrier-code.d.ts
|
|
218
197
|
/**
|
|
219
198
|
* Identifies the carrier that will deliver the shipment.
|
|
220
199
|
*/
|
|
221
200
|
interface CarrierCode {
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
201
|
+
'carrierCodeType'?: CarrierCodeType;
|
|
202
|
+
/**
|
|
203
|
+
* Value of the carrier code.
|
|
204
|
+
*/
|
|
205
|
+
'carrierCodeValue'?: string;
|
|
227
206
|
}
|
|
228
|
-
|
|
207
|
+
//#endregion
|
|
208
|
+
//#region src/api-model/models/confirmation-mode.d.ts
|
|
229
209
|
/**
|
|
230
210
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
231
211
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -241,38 +221,28 @@ interface CarrierCode {
|
|
|
241
221
|
* Confirmation Modes supported for Replenishment order creation. By default, the confirmation mode will be set to MANUAL.
|
|
242
222
|
*/
|
|
243
223
|
declare const ConfirmationMode: {
|
|
244
|
-
|
|
245
|
-
|
|
224
|
+
readonly Auto: "AUTO";
|
|
225
|
+
readonly Manual: "MANUAL";
|
|
246
226
|
};
|
|
247
227
|
type ConfirmationMode = typeof ConfirmationMode[keyof typeof ConfirmationMode];
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
251
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
252
|
-
*
|
|
253
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
257
|
-
* https://openapi-generator.tech
|
|
258
|
-
* Do not edit the class manually.
|
|
259
|
-
*/
|
|
260
|
-
|
|
228
|
+
//#endregion
|
|
229
|
+
//#region src/api-model/models/destination-details.d.ts
|
|
261
230
|
/**
|
|
262
231
|
* Destination details of an inbound order based on the assigned region and DC for the order.
|
|
263
232
|
*/
|
|
264
233
|
interface DestinationDetails {
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
}
|
|
275
|
-
|
|
234
|
+
'destinationAddress'?: Address;
|
|
235
|
+
/**
|
|
236
|
+
* Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]
|
|
237
|
+
*/
|
|
238
|
+
'destinationRegion'?: string;
|
|
239
|
+
/**
|
|
240
|
+
* Unique ID of the confirmed shipment being shipped to the assigned destination. This will be available only after an inbound order is confirmed and can be used to track the shipment.
|
|
241
|
+
*/
|
|
242
|
+
'shipmentId'?: string;
|
|
243
|
+
}
|
|
244
|
+
//#endregion
|
|
245
|
+
//#region src/api-model/models/dimension-unit-of-measurement.d.ts
|
|
276
246
|
/**
|
|
277
247
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
278
248
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -288,11 +258,12 @@ interface DestinationDetails {
|
|
|
288
258
|
* Unit of measurement for package dimensions.
|
|
289
259
|
*/
|
|
290
260
|
declare const DimensionUnitOfMeasurement: {
|
|
291
|
-
|
|
292
|
-
|
|
261
|
+
readonly Inches: "INCHES";
|
|
262
|
+
readonly Centimeters: "CENTIMETERS";
|
|
293
263
|
};
|
|
294
264
|
type DimensionUnitOfMeasurement = typeof DimensionUnitOfMeasurement[keyof typeof DimensionUnitOfMeasurement];
|
|
295
|
-
|
|
265
|
+
//#endregion
|
|
266
|
+
//#region src/api-model/models/distribution-ineligible-reason.d.ts
|
|
296
267
|
/**
|
|
297
268
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
298
269
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -308,43 +279,33 @@ type DimensionUnitOfMeasurement = typeof DimensionUnitOfMeasurement[keyof typeof
|
|
|
308
279
|
* Execution errors associated with the replenishment order. This field will be populated if the order failed validation.
|
|
309
280
|
*/
|
|
310
281
|
interface DistributionIneligibleReason {
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
327
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
328
|
-
*
|
|
329
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
333
|
-
* https://openapi-generator.tech
|
|
334
|
-
* Do not edit the class manually.
|
|
335
|
-
*/
|
|
336
|
-
|
|
282
|
+
/**
|
|
283
|
+
* Failure code details of the error.
|
|
284
|
+
*/
|
|
285
|
+
'failureCode': string;
|
|
286
|
+
/**
|
|
287
|
+
* Failure reasons of the error.
|
|
288
|
+
*/
|
|
289
|
+
'failureReasons': Array<string>;
|
|
290
|
+
/**
|
|
291
|
+
* SKU associated with the error.
|
|
292
|
+
*/
|
|
293
|
+
'sku'?: string;
|
|
294
|
+
}
|
|
295
|
+
//#endregion
|
|
296
|
+
//#region src/api-model/models/distribution-package-quantity.d.ts
|
|
337
297
|
/**
|
|
338
298
|
* Represents a distribution package with its respective quantity.
|
|
339
299
|
*/
|
|
340
300
|
interface DistributionPackageQuantity {
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
301
|
+
/**
|
|
302
|
+
* Number of cases or pallets with the same package configuration.
|
|
303
|
+
*/
|
|
304
|
+
'count': number;
|
|
305
|
+
'distributionPackage': DistributionPackage;
|
|
346
306
|
}
|
|
347
|
-
|
|
307
|
+
//#endregion
|
|
308
|
+
//#region src/api-model/models/label-owner.d.ts
|
|
348
309
|
/**
|
|
349
310
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
350
311
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -360,11 +321,12 @@ interface DistributionPackageQuantity {
|
|
|
360
321
|
* The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.
|
|
361
322
|
*/
|
|
362
323
|
declare const LabelOwner: {
|
|
363
|
-
|
|
364
|
-
|
|
324
|
+
readonly Amazon: "AMAZON";
|
|
325
|
+
readonly Self: "SELF";
|
|
365
326
|
};
|
|
366
327
|
type LabelOwner = typeof LabelOwner[keyof typeof LabelOwner];
|
|
367
|
-
|
|
328
|
+
//#endregion
|
|
329
|
+
//#region src/api-model/models/prep-category.d.ts
|
|
368
330
|
/**
|
|
369
331
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
370
332
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -380,23 +342,24 @@ type LabelOwner = typeof LabelOwner[keyof typeof LabelOwner];
|
|
|
380
342
|
* The preparation category for shipping an item to Amazon\'s fulfillment network.
|
|
381
343
|
*/
|
|
382
344
|
declare const PrepCategory: {
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
345
|
+
readonly Adult: "ADULT";
|
|
346
|
+
readonly Baby: "BABY";
|
|
347
|
+
readonly FcProvided: "FC_PROVIDED";
|
|
348
|
+
readonly Fragile: "FRAGILE";
|
|
349
|
+
readonly Granular: "GRANULAR";
|
|
350
|
+
readonly Hanger: "HANGER";
|
|
351
|
+
readonly Liquid: "LIQUID";
|
|
352
|
+
readonly Perforated: "PERFORATED";
|
|
353
|
+
readonly Set: "SET";
|
|
354
|
+
readonly Sharp: "SHARP";
|
|
355
|
+
readonly Small: "SMALL";
|
|
356
|
+
readonly Textile: "TEXTILE";
|
|
357
|
+
readonly NoPrep: "NO_PREP";
|
|
358
|
+
readonly Unknown: "UNKNOWN";
|
|
397
359
|
};
|
|
398
360
|
type PrepCategory = typeof PrepCategory[keyof typeof PrepCategory];
|
|
399
|
-
|
|
361
|
+
//#endregion
|
|
362
|
+
//#region src/api-model/models/prep-owner.d.ts
|
|
400
363
|
/**
|
|
401
364
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
402
365
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -412,59 +375,38 @@ type PrepCategory = typeof PrepCategory[keyof typeof PrepCategory];
|
|
|
412
375
|
* The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.
|
|
413
376
|
*/
|
|
414
377
|
declare const PrepOwner: {
|
|
415
|
-
|
|
416
|
-
|
|
378
|
+
readonly Amazon: "AMAZON";
|
|
379
|
+
readonly Self: "SELF";
|
|
417
380
|
};
|
|
418
381
|
type PrepOwner = typeof PrepOwner[keyof typeof PrepOwner];
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
422
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
423
|
-
*
|
|
424
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
428
|
-
* https://openapi-generator.tech
|
|
429
|
-
* Do not edit the class manually.
|
|
430
|
-
*/
|
|
431
|
-
|
|
382
|
+
//#endregion
|
|
383
|
+
//#region src/api-model/models/prep-instruction.d.ts
|
|
432
384
|
/**
|
|
433
385
|
* Information pertaining to the preparation of inbound products.
|
|
434
386
|
*/
|
|
435
387
|
interface PrepInstruction {
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
388
|
+
'prepOwner'?: PrepOwner;
|
|
389
|
+
/**
|
|
390
|
+
* The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.
|
|
391
|
+
*/
|
|
392
|
+
'prepType'?: string;
|
|
441
393
|
}
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
445
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
446
|
-
*
|
|
447
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
451
|
-
* https://openapi-generator.tech
|
|
452
|
-
* Do not edit the class manually.
|
|
453
|
-
*/
|
|
454
|
-
|
|
394
|
+
//#endregion
|
|
395
|
+
//#region src/api-model/models/prep-details.d.ts
|
|
455
396
|
/**
|
|
456
397
|
* The preparation details for a product. This contains the prep category, prep owner, and label owner. Prep instructions are generated based on the specified category.
|
|
457
398
|
*/
|
|
458
399
|
interface PrepDetails {
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
400
|
+
'labelOwner'?: LabelOwner;
|
|
401
|
+
'prepCategory'?: PrepCategory;
|
|
402
|
+
/**
|
|
403
|
+
* Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.
|
|
404
|
+
*/
|
|
405
|
+
'prepInstructions'?: Array<PrepInstruction>;
|
|
406
|
+
'prepOwner'?: PrepOwner;
|
|
466
407
|
}
|
|
467
|
-
|
|
408
|
+
//#endregion
|
|
409
|
+
//#region src/api-model/models/product-attribute.d.ts
|
|
468
410
|
/**
|
|
469
411
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
470
412
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -480,77 +422,56 @@ interface PrepDetails {
|
|
|
480
422
|
* Product instance attribute that is not described at the SKU level in the catalog.
|
|
481
423
|
*/
|
|
482
424
|
interface ProductAttribute {
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
}
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
495
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
496
|
-
*
|
|
497
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
501
|
-
* https://openapi-generator.tech
|
|
502
|
-
* Do not edit the class manually.
|
|
503
|
-
*/
|
|
504
|
-
|
|
425
|
+
/**
|
|
426
|
+
* Product attribute name.
|
|
427
|
+
*/
|
|
428
|
+
'name'?: string;
|
|
429
|
+
/**
|
|
430
|
+
* Product attribute value.
|
|
431
|
+
*/
|
|
432
|
+
'value'?: string;
|
|
433
|
+
}
|
|
434
|
+
//#endregion
|
|
435
|
+
//#region src/api-model/models/product-quantity.d.ts
|
|
505
436
|
/**
|
|
506
437
|
* Represents a product with the SKU details and the corresponding quantity.
|
|
507
438
|
*/
|
|
508
439
|
interface ProductQuantity {
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
}
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
530
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
531
|
-
*
|
|
532
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
536
|
-
* https://openapi-generator.tech
|
|
537
|
-
* Do not edit the class manually.
|
|
538
|
-
*/
|
|
539
|
-
|
|
440
|
+
/**
|
|
441
|
+
* Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.
|
|
442
|
+
*/
|
|
443
|
+
'attributes'?: Array<ProductAttribute>;
|
|
444
|
+
/**
|
|
445
|
+
* Product quantity.
|
|
446
|
+
*/
|
|
447
|
+
'quantity': number;
|
|
448
|
+
/**
|
|
449
|
+
* The seller or merchant SKU.
|
|
450
|
+
*/
|
|
451
|
+
'sku': string;
|
|
452
|
+
/**
|
|
453
|
+
* The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
454
|
+
*/
|
|
455
|
+
'expiration'?: string;
|
|
456
|
+
'prepDetails'?: PrepDetails;
|
|
457
|
+
}
|
|
458
|
+
//#endregion
|
|
459
|
+
//#region src/api-model/models/distribution-package-contents.d.ts
|
|
540
460
|
/**
|
|
541
461
|
* Represents the contents inside a package, which can be products or a nested package.
|
|
542
462
|
*/
|
|
543
463
|
interface DistributionPackageContents {
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
464
|
+
/**
|
|
465
|
+
* This is required only when `DistributionPackageType=PALLET`.
|
|
466
|
+
*/
|
|
467
|
+
'packages'?: Array<DistributionPackageQuantity>;
|
|
468
|
+
/**
|
|
469
|
+
* This is required only when `DistributionPackageType=CASE`.
|
|
470
|
+
*/
|
|
471
|
+
'products'?: Array<ProductQuantity>;
|
|
552
472
|
}
|
|
553
|
-
|
|
473
|
+
//#endregion
|
|
474
|
+
//#region src/api-model/models/distribution-package-type.d.ts
|
|
554
475
|
/**
|
|
555
476
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
556
477
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -566,42 +487,32 @@ interface DistributionPackageContents {
|
|
|
566
487
|
* Type of distribution packages.
|
|
567
488
|
*/
|
|
568
489
|
declare const DistributionPackageType: {
|
|
569
|
-
|
|
570
|
-
|
|
490
|
+
readonly Case: "CASE";
|
|
491
|
+
readonly Pallet: "PALLET";
|
|
571
492
|
};
|
|
572
493
|
type DistributionPackageType = typeof DistributionPackageType[keyof typeof DistributionPackageType];
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
576
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
577
|
-
*
|
|
578
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
582
|
-
* https://openapi-generator.tech
|
|
583
|
-
* Do not edit the class manually.
|
|
584
|
-
*/
|
|
585
|
-
|
|
494
|
+
//#endregion
|
|
495
|
+
//#region src/api-model/models/package-dimensions.d.ts
|
|
586
496
|
/**
|
|
587
497
|
* Dimensions of the package.
|
|
588
498
|
*/
|
|
589
499
|
interface PackageDimensions {
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
}
|
|
604
|
-
|
|
500
|
+
/**
|
|
501
|
+
* Height of the package.
|
|
502
|
+
*/
|
|
503
|
+
'height': number;
|
|
504
|
+
/**
|
|
505
|
+
* Length of the package.
|
|
506
|
+
*/
|
|
507
|
+
'length': number;
|
|
508
|
+
'unitOfMeasurement': DimensionUnitOfMeasurement;
|
|
509
|
+
/**
|
|
510
|
+
* Width of the package.
|
|
511
|
+
*/
|
|
512
|
+
'width': number;
|
|
513
|
+
}
|
|
514
|
+
//#endregion
|
|
515
|
+
//#region src/api-model/models/volume-unit-of-measurement.d.ts
|
|
605
516
|
/**
|
|
606
517
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
607
518
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -617,35 +528,25 @@ interface PackageDimensions {
|
|
|
617
528
|
* Unit of measurement for the package volume.
|
|
618
529
|
*/
|
|
619
530
|
declare const VolumeUnitOfMeasurement: {
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
531
|
+
readonly CuIn: "CU_IN";
|
|
532
|
+
readonly Cbm: "CBM";
|
|
533
|
+
readonly Cc: "CC";
|
|
623
534
|
};
|
|
624
535
|
type VolumeUnitOfMeasurement = typeof VolumeUnitOfMeasurement[keyof typeof VolumeUnitOfMeasurement];
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
628
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
629
|
-
*
|
|
630
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
631
|
-
*
|
|
632
|
-
*
|
|
633
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
634
|
-
* https://openapi-generator.tech
|
|
635
|
-
* Do not edit the class manually.
|
|
636
|
-
*/
|
|
637
|
-
|
|
536
|
+
//#endregion
|
|
537
|
+
//#region src/api-model/models/package-volume.d.ts
|
|
638
538
|
/**
|
|
639
539
|
* Represents the volume of the package with a unit of measurement.
|
|
640
540
|
*/
|
|
641
541
|
interface PackageVolume {
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
542
|
+
'unitOfMeasurement': VolumeUnitOfMeasurement;
|
|
543
|
+
/**
|
|
544
|
+
* The package volume value.
|
|
545
|
+
*/
|
|
546
|
+
'volume': number;
|
|
647
547
|
}
|
|
648
|
-
|
|
548
|
+
//#endregion
|
|
549
|
+
//#region src/api-model/models/weight-unit-of-measurement.d.ts
|
|
649
550
|
/**
|
|
650
551
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
651
552
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -661,106 +562,63 @@ interface PackageVolume {
|
|
|
661
562
|
* Unit of measurement for the package weight.
|
|
662
563
|
*/
|
|
663
564
|
declare const WeightUnitOfMeasurement: {
|
|
664
|
-
|
|
665
|
-
|
|
565
|
+
readonly Pounds: "POUNDS";
|
|
566
|
+
readonly Kilograms: "KILOGRAMS";
|
|
666
567
|
};
|
|
667
568
|
type WeightUnitOfMeasurement = typeof WeightUnitOfMeasurement[keyof typeof WeightUnitOfMeasurement];
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
671
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
672
|
-
*
|
|
673
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
674
|
-
*
|
|
675
|
-
*
|
|
676
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
677
|
-
* https://openapi-generator.tech
|
|
678
|
-
* Do not edit the class manually.
|
|
679
|
-
*/
|
|
680
|
-
|
|
569
|
+
//#endregion
|
|
570
|
+
//#region src/api-model/models/package-weight.d.ts
|
|
681
571
|
/**
|
|
682
572
|
* Represents the weight of the package with a unit of measurement.
|
|
683
573
|
*/
|
|
684
574
|
interface PackageWeight {
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
575
|
+
'unitOfMeasurement': WeightUnitOfMeasurement;
|
|
576
|
+
/**
|
|
577
|
+
* The package weight value.
|
|
578
|
+
*/
|
|
579
|
+
'weight': number;
|
|
690
580
|
}
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
694
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
695
|
-
*
|
|
696
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
700
|
-
* https://openapi-generator.tech
|
|
701
|
-
* Do not edit the class manually.
|
|
702
|
-
*/
|
|
703
|
-
|
|
581
|
+
//#endregion
|
|
582
|
+
//#region src/api-model/models/measurement-data.d.ts
|
|
704
583
|
/**
|
|
705
584
|
* Package weight and dimension.
|
|
706
585
|
*/
|
|
707
586
|
interface MeasurementData {
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
587
|
+
'dimensions'?: PackageDimensions;
|
|
588
|
+
'volume'?: PackageVolume;
|
|
589
|
+
'weight': PackageWeight;
|
|
711
590
|
}
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
715
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
716
|
-
*
|
|
717
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
721
|
-
* https://openapi-generator.tech
|
|
722
|
-
* Do not edit the class manually.
|
|
723
|
-
*/
|
|
724
|
-
|
|
591
|
+
//#endregion
|
|
592
|
+
//#region src/api-model/models/distribution-package.d.ts
|
|
725
593
|
/**
|
|
726
594
|
* Represents an AWD distribution package.
|
|
727
595
|
*/
|
|
728
596
|
interface DistributionPackage {
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
597
|
+
'contents': DistributionPackageContents;
|
|
598
|
+
'measurements': MeasurementData;
|
|
599
|
+
'type': DistributionPackageType;
|
|
732
600
|
}
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
736
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
737
|
-
*
|
|
738
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
742
|
-
* https://openapi-generator.tech
|
|
743
|
-
* Do not edit the class manually.
|
|
744
|
-
*/
|
|
745
|
-
|
|
601
|
+
//#endregion
|
|
602
|
+
//#region src/api-model/models/distribution-product.d.ts
|
|
746
603
|
/**
|
|
747
604
|
* Represents a product with sku details and corresponding quantity
|
|
748
605
|
*/
|
|
749
606
|
interface DistributionProduct {
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
}
|
|
763
|
-
|
|
607
|
+
/**
|
|
608
|
+
* Attributes for this instance of the product, i.e. already-prepped, or other attributes that distinguish the product beyond the SKU.
|
|
609
|
+
*/
|
|
610
|
+
'attributes'?: Array<ProductAttribute>;
|
|
611
|
+
/**
|
|
612
|
+
* Quantity of the product
|
|
613
|
+
*/
|
|
614
|
+
'quantity': number;
|
|
615
|
+
/**
|
|
616
|
+
* The seller/merchant stock keeping unit (SKU).
|
|
617
|
+
*/
|
|
618
|
+
'sku': string;
|
|
619
|
+
}
|
|
620
|
+
//#endregion
|
|
621
|
+
//#region src/api-model/models/error-list.d.ts
|
|
764
622
|
/**
|
|
765
623
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
766
624
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -776,12 +634,13 @@ interface DistributionProduct {
|
|
|
776
634
|
* This exception is thrown when client inputs are invalid.
|
|
777
635
|
*/
|
|
778
636
|
interface ErrorList {
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
637
|
+
/**
|
|
638
|
+
* A list of errors describing the failures.
|
|
639
|
+
*/
|
|
640
|
+
'errors': Array<Error>;
|
|
783
641
|
}
|
|
784
|
-
|
|
642
|
+
//#endregion
|
|
643
|
+
//#region src/api-model/models/expiration-details.d.ts
|
|
785
644
|
/**
|
|
786
645
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
787
646
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -797,16 +656,17 @@ interface ErrorList {
|
|
|
797
656
|
* The expiration details of the inventory. This object will only appear if the details parameter in the request is set to `SHOW`.
|
|
798
657
|
*/
|
|
799
658
|
interface ExpirationDetails {
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
659
|
+
/**
|
|
660
|
+
* The expiration date of the SKU.
|
|
661
|
+
*/
|
|
662
|
+
'expiration'?: string;
|
|
663
|
+
/**
|
|
664
|
+
* The quantity that is present in AWD.
|
|
665
|
+
*/
|
|
666
|
+
'onhandQuantity'?: number;
|
|
808
667
|
}
|
|
809
|
-
|
|
668
|
+
//#endregion
|
|
669
|
+
//#region src/api-model/models/format-type.d.ts
|
|
810
670
|
/**
|
|
811
671
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
812
672
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -822,10 +682,11 @@ interface ExpirationDetails {
|
|
|
822
682
|
* The label format type extension.
|
|
823
683
|
*/
|
|
824
684
|
declare const FormatType: {
|
|
825
|
-
|
|
685
|
+
readonly Pdf: "PDF";
|
|
826
686
|
};
|
|
827
687
|
type FormatType = typeof FormatType[keyof typeof FormatType];
|
|
828
|
-
|
|
688
|
+
//#endregion
|
|
689
|
+
//#region src/api-model/models/inbound-eligibility-status.d.ts
|
|
829
690
|
/**
|
|
830
691
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
831
692
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -841,11 +702,12 @@ type FormatType = typeof FormatType[keyof typeof FormatType];
|
|
|
841
702
|
* Enum denoting the package inbound eligibility.
|
|
842
703
|
*/
|
|
843
704
|
declare const InboundEligibilityStatus: {
|
|
844
|
-
|
|
845
|
-
|
|
705
|
+
readonly Eligible: "ELIGIBLE";
|
|
706
|
+
readonly Ineligible: "INELIGIBLE";
|
|
846
707
|
};
|
|
847
708
|
type InboundEligibilityStatus = typeof InboundEligibilityStatus[keyof typeof InboundEligibilityStatus];
|
|
848
|
-
|
|
709
|
+
//#endregion
|
|
710
|
+
//#region src/api-model/models/order-ineligibility-reason.d.ts
|
|
849
711
|
/**
|
|
850
712
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
851
713
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -861,16 +723,17 @@ type InboundEligibilityStatus = typeof InboundEligibilityStatus[keyof typeof Inb
|
|
|
861
723
|
* Represents one ineligibility reason for the order (there can be multiple reasons).
|
|
862
724
|
*/
|
|
863
725
|
interface OrderIneligibilityReason {
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
726
|
+
/**
|
|
727
|
+
* Code for the order ineligibility.
|
|
728
|
+
*/
|
|
729
|
+
'code': string;
|
|
730
|
+
/**
|
|
731
|
+
* Description detailing the ineligibility reason of the order.
|
|
732
|
+
*/
|
|
733
|
+
'description': string;
|
|
872
734
|
}
|
|
873
|
-
|
|
735
|
+
//#endregion
|
|
736
|
+
//#region src/api-model/models/sku-ineligibility-reason.d.ts
|
|
874
737
|
/**
|
|
875
738
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
876
739
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -886,71 +749,50 @@ interface OrderIneligibilityReason {
|
|
|
886
749
|
* Represents the ineligibility reason for one SKU.
|
|
887
750
|
*/
|
|
888
751
|
interface SkuIneligibilityReason {
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
}
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
901
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
902
|
-
*
|
|
903
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
907
|
-
* https://openapi-generator.tech
|
|
908
|
-
* Do not edit the class manually.
|
|
909
|
-
*/
|
|
910
|
-
|
|
752
|
+
/**
|
|
753
|
+
* Code for the SKU ineligibility.
|
|
754
|
+
*/
|
|
755
|
+
'code': string;
|
|
756
|
+
/**
|
|
757
|
+
* Detailed description of the SKU ineligibility.
|
|
758
|
+
*/
|
|
759
|
+
'description': string;
|
|
760
|
+
}
|
|
761
|
+
//#endregion
|
|
762
|
+
//#region src/api-model/models/sku-eligibility.d.ts
|
|
911
763
|
/**
|
|
912
764
|
* Represents eligibility of one SKU.
|
|
913
765
|
*/
|
|
914
766
|
interface SkuEligibility {
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
767
|
+
/**
|
|
768
|
+
* If not eligible, these are list of error codes and descriptions.
|
|
769
|
+
*/
|
|
770
|
+
'ineligibilityReasons'?: Array<SkuIneligibilityReason>;
|
|
771
|
+
'packageQuantity': DistributionPackageQuantity;
|
|
772
|
+
'status': InboundEligibilityStatus;
|
|
921
773
|
}
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
925
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
926
|
-
*
|
|
927
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
928
|
-
*
|
|
929
|
-
*
|
|
930
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
931
|
-
* https://openapi-generator.tech
|
|
932
|
-
* Do not edit the class manually.
|
|
933
|
-
*/
|
|
934
|
-
|
|
774
|
+
//#endregion
|
|
775
|
+
//#region src/api-model/models/inbound-eligibility.d.ts
|
|
935
776
|
/**
|
|
936
777
|
* Represents the eligibility status of the inbound packages.
|
|
937
778
|
*/
|
|
938
779
|
interface InboundEligibility {
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
}
|
|
953
|
-
|
|
780
|
+
/**
|
|
781
|
+
* If there are order level eligibility issues, then this list will contain those error codes and descriptions.
|
|
782
|
+
*/
|
|
783
|
+
'ineligibilityReasons'?: Array<OrderIneligibilityReason>;
|
|
784
|
+
/**
|
|
785
|
+
* Details on SKU eligibility for each inbound package.
|
|
786
|
+
*/
|
|
787
|
+
'packagesToInbound': Array<SkuEligibility>;
|
|
788
|
+
/**
|
|
789
|
+
* Timestamp when the eligibility check is performed.
|
|
790
|
+
*/
|
|
791
|
+
'previewedAt': string;
|
|
792
|
+
'status': InboundEligibilityStatus;
|
|
793
|
+
}
|
|
794
|
+
//#endregion
|
|
795
|
+
//#region src/api-model/models/inbound-preferences.d.ts
|
|
954
796
|
/**
|
|
955
797
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
956
798
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -966,12 +808,13 @@ interface InboundEligibility {
|
|
|
966
808
|
* Preferences that can be passed in context of an inbound order
|
|
967
809
|
*/
|
|
968
810
|
interface InboundPreferences {
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
811
|
+
/**
|
|
812
|
+
* Pass a preferred region so that the inbound order can be shipped to an AWD warehouse located in that region. This doesn\'t guarantee the order to be assigned in the specified destination region as it depends on warehouse capacity availability. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]
|
|
813
|
+
*/
|
|
814
|
+
'destinationRegion'?: string;
|
|
973
815
|
}
|
|
974
|
-
|
|
816
|
+
//#endregion
|
|
817
|
+
//#region src/api-model/models/inbound-status.d.ts
|
|
975
818
|
/**
|
|
976
819
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
977
820
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -987,85 +830,64 @@ interface InboundPreferences {
|
|
|
987
830
|
* The supported statuses for an inbound order.
|
|
988
831
|
*/
|
|
989
832
|
declare const InboundStatus: {
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
833
|
+
readonly Draft: "DRAFT";
|
|
834
|
+
readonly Validating: "VALIDATING";
|
|
835
|
+
readonly Confirmed: "CONFIRMED";
|
|
836
|
+
readonly Closed: "CLOSED";
|
|
837
|
+
readonly Expired: "EXPIRED";
|
|
838
|
+
readonly Cancelled: "CANCELLED";
|
|
996
839
|
};
|
|
997
840
|
type InboundStatus = typeof InboundStatus[keyof typeof InboundStatus];
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1001
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1002
|
-
*
|
|
1003
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1004
|
-
*
|
|
1005
|
-
*
|
|
1006
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1007
|
-
* https://openapi-generator.tech
|
|
1008
|
-
* Do not edit the class manually.
|
|
1009
|
-
*/
|
|
1010
|
-
|
|
841
|
+
//#endregion
|
|
842
|
+
//#region src/api-model/models/inbound-order.d.ts
|
|
1011
843
|
/**
|
|
1012
844
|
* Represents an AWD inbound order.
|
|
1013
845
|
*/
|
|
1014
846
|
interface InboundOrder {
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
}
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1043
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1044
|
-
*
|
|
1045
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1048
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1049
|
-
* https://openapi-generator.tech
|
|
1050
|
-
* Do not edit the class manually.
|
|
1051
|
-
*/
|
|
1052
|
-
|
|
847
|
+
/**
|
|
848
|
+
* Date when this order was created.
|
|
849
|
+
*/
|
|
850
|
+
'createdAt': string;
|
|
851
|
+
'destinationDetails'?: DestinationDetails;
|
|
852
|
+
/**
|
|
853
|
+
* Reference ID that can be used to correlate the order with partner resources.
|
|
854
|
+
*/
|
|
855
|
+
'externalReferenceId'?: string;
|
|
856
|
+
/**
|
|
857
|
+
* Inbound order ID.
|
|
858
|
+
*/
|
|
859
|
+
'orderId': string;
|
|
860
|
+
'orderStatus': InboundStatus;
|
|
861
|
+
'originAddress': Address;
|
|
862
|
+
/**
|
|
863
|
+
* List of packages to be inbounded.
|
|
864
|
+
*/
|
|
865
|
+
'packagesToInbound': Array<DistributionPackageQuantity>;
|
|
866
|
+
'preferences'?: InboundPreferences;
|
|
867
|
+
/**
|
|
868
|
+
* Date when this order was last updated.
|
|
869
|
+
*/
|
|
870
|
+
'updatedAt'?: string;
|
|
871
|
+
}
|
|
872
|
+
//#endregion
|
|
873
|
+
//#region src/api-model/models/inbound-order-creation-data.d.ts
|
|
1053
874
|
/**
|
|
1054
875
|
* Payload for creating an inbound order.
|
|
1055
876
|
*/
|
|
1056
877
|
interface InboundOrderCreationData {
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
}
|
|
1068
|
-
|
|
878
|
+
/**
|
|
879
|
+
* Reference ID that can be used to correlate the order with partner resources.
|
|
880
|
+
*/
|
|
881
|
+
'externalReferenceId'?: string;
|
|
882
|
+
'originAddress': Address;
|
|
883
|
+
/**
|
|
884
|
+
* List of packages to be inbounded.
|
|
885
|
+
*/
|
|
886
|
+
'packagesToInbound': Array<DistributionPackageQuantity>;
|
|
887
|
+
'preferences'?: InboundPreferences;
|
|
888
|
+
}
|
|
889
|
+
//#endregion
|
|
890
|
+
//#region src/api-model/models/inbound-order-reference.d.ts
|
|
1069
891
|
/**
|
|
1070
892
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1071
893
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1081,34 +903,24 @@ interface InboundOrderCreationData {
|
|
|
1081
903
|
* A response that contains the reference identifiers for the newly created or updated inbound order. Consists of an order ID and version.
|
|
1082
904
|
*/
|
|
1083
905
|
interface InboundOrderReference {
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
906
|
+
/**
|
|
907
|
+
* Order ID of the inbound order.
|
|
908
|
+
*/
|
|
909
|
+
'orderId': string;
|
|
1088
910
|
}
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1092
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1093
|
-
*
|
|
1094
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1095
|
-
*
|
|
1096
|
-
*
|
|
1097
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1098
|
-
* https://openapi-generator.tech
|
|
1099
|
-
* Do not edit the class manually.
|
|
1100
|
-
*/
|
|
1101
|
-
|
|
911
|
+
//#endregion
|
|
912
|
+
//#region src/api-model/models/inbound-packages.d.ts
|
|
1102
913
|
/**
|
|
1103
914
|
* Represents the packages to inbound.
|
|
1104
915
|
*/
|
|
1105
916
|
interface InboundPackages {
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
917
|
+
/**
|
|
918
|
+
* List of packages to be inbounded.
|
|
919
|
+
*/
|
|
920
|
+
'packagesToInbound': Array<DistributionPackageQuantity>;
|
|
1110
921
|
}
|
|
1111
|
-
|
|
922
|
+
//#endregion
|
|
923
|
+
//#region src/api-model/models/inbound-shipment-status.d.ts
|
|
1112
924
|
/**
|
|
1113
925
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1114
926
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1124,16 +936,17 @@ interface InboundPackages {
|
|
|
1124
936
|
* Possible shipment statuses used by shipments.
|
|
1125
937
|
*/
|
|
1126
938
|
declare const InboundShipmentStatus: {
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
939
|
+
readonly Created: "CREATED";
|
|
940
|
+
readonly Shipped: "SHIPPED";
|
|
941
|
+
readonly InTransit: "IN_TRANSIT";
|
|
942
|
+
readonly Receiving: "RECEIVING";
|
|
943
|
+
readonly Delivered: "DELIVERED";
|
|
944
|
+
readonly Closed: "CLOSED";
|
|
945
|
+
readonly Cancelled: "CANCELLED";
|
|
1134
946
|
};
|
|
1135
947
|
type InboundShipmentStatus = typeof InboundShipmentStatus[keyof typeof InboundShipmentStatus];
|
|
1136
|
-
|
|
948
|
+
//#endregion
|
|
949
|
+
//#region src/api-model/models/inventory-unit-of-measurement.d.ts
|
|
1137
950
|
/**
|
|
1138
951
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1139
952
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1149,168 +962,125 @@ type InboundShipmentStatus = typeof InboundShipmentStatus[keyof typeof InboundSh
|
|
|
1149
962
|
* Unit of measurement for the inventory.
|
|
1150
963
|
*/
|
|
1151
964
|
declare const InventoryUnitOfMeasurement: {
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
965
|
+
readonly ProductUnits: "PRODUCT_UNITS";
|
|
966
|
+
readonly Cases: "CASES";
|
|
967
|
+
readonly Pallets: "PALLETS";
|
|
1155
968
|
};
|
|
1156
969
|
type InventoryUnitOfMeasurement = typeof InventoryUnitOfMeasurement[keyof typeof InventoryUnitOfMeasurement];
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1160
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1161
|
-
*
|
|
1162
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1163
|
-
*
|
|
1164
|
-
*
|
|
1165
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1166
|
-
* https://openapi-generator.tech
|
|
1167
|
-
* Do not edit the class manually.
|
|
1168
|
-
*/
|
|
1169
|
-
|
|
970
|
+
//#endregion
|
|
971
|
+
//#region src/api-model/models/inventory-quantity.d.ts
|
|
1170
972
|
/**
|
|
1171
973
|
* Quantity of inventory with an associated measurement unit context.
|
|
1172
974
|
*/
|
|
1173
975
|
interface InventoryQuantity {
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
976
|
+
/**
|
|
977
|
+
* Quantity of the respective inventory.
|
|
978
|
+
*/
|
|
979
|
+
'quantity': number;
|
|
980
|
+
'unitOfMeasurement': InventoryUnitOfMeasurement;
|
|
1179
981
|
}
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1183
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1184
|
-
*
|
|
1185
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1186
|
-
*
|
|
1187
|
-
*
|
|
1188
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1189
|
-
* https://openapi-generator.tech
|
|
1190
|
-
* Do not edit the class manually.
|
|
1191
|
-
*/
|
|
1192
|
-
|
|
982
|
+
//#endregion
|
|
983
|
+
//#region src/api-model/models/sku-quantity.d.ts
|
|
1193
984
|
/**
|
|
1194
985
|
* Quantity details for a SKU as part of a shipment
|
|
1195
986
|
*/
|
|
1196
987
|
interface SkuQuantity {
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
988
|
+
'expectedQuantity': InventoryQuantity;
|
|
989
|
+
'receivedQuantity'?: InventoryQuantity;
|
|
990
|
+
/**
|
|
991
|
+
* The merchant stock keeping unit
|
|
992
|
+
*/
|
|
993
|
+
'sku': string;
|
|
1203
994
|
}
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1207
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1208
|
-
*
|
|
1209
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1212
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1213
|
-
* https://openapi-generator.tech
|
|
1214
|
-
* Do not edit the class manually.
|
|
1215
|
-
*/
|
|
1216
|
-
|
|
995
|
+
//#endregion
|
|
996
|
+
//#region src/api-model/models/inbound-shipment.d.ts
|
|
1217
997
|
/**
|
|
1218
998
|
* Represents an AWD inbound shipment.
|
|
1219
999
|
*/
|
|
1220
1000
|
interface InboundShipment {
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
}
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1277
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1278
|
-
*
|
|
1279
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1280
|
-
*
|
|
1281
|
-
*
|
|
1282
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1283
|
-
* https://openapi-generator.tech
|
|
1284
|
-
* Do not edit the class manually.
|
|
1285
|
-
*/
|
|
1286
|
-
|
|
1001
|
+
'carrierCode'?: CarrierCode;
|
|
1002
|
+
/**
|
|
1003
|
+
* Timestamp when the shipment was created. The date is returned in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
1004
|
+
*/
|
|
1005
|
+
'createdAt'?: string;
|
|
1006
|
+
'destinationAddress': Address;
|
|
1007
|
+
/**
|
|
1008
|
+
* Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.
|
|
1009
|
+
*/
|
|
1010
|
+
'externalReferenceId'?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* The AWD inbound order ID that this inbound shipment belongs to.
|
|
1013
|
+
*/
|
|
1014
|
+
'orderId': string;
|
|
1015
|
+
'originAddress': Address;
|
|
1016
|
+
/**
|
|
1017
|
+
* Quantity received (at the receiving end) as part of this shipment.
|
|
1018
|
+
*/
|
|
1019
|
+
'receivedQuantity'?: Array<InventoryQuantity>;
|
|
1020
|
+
/**
|
|
1021
|
+
* Timestamp when the shipment will be shipped.
|
|
1022
|
+
*/
|
|
1023
|
+
'shipBy'?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Packages that are part of this shipment.
|
|
1026
|
+
*/
|
|
1027
|
+
'shipmentContainerQuantities': Array<DistributionPackageQuantity>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Unique shipment ID.
|
|
1030
|
+
*/
|
|
1031
|
+
'shipmentId': string;
|
|
1032
|
+
/**
|
|
1033
|
+
* Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.
|
|
1034
|
+
*/
|
|
1035
|
+
'shipmentSkuQuantities'?: Array<SkuQuantity>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]
|
|
1038
|
+
*/
|
|
1039
|
+
'destinationRegion'?: string;
|
|
1040
|
+
'shipmentStatus': InboundShipmentStatus;
|
|
1041
|
+
/**
|
|
1042
|
+
* Carrier-unique tracking ID for this shipment.
|
|
1043
|
+
*/
|
|
1044
|
+
'trackingId'?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Timestamp when the shipment was updated. The date is returned in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
1047
|
+
*/
|
|
1048
|
+
'updatedAt'?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.
|
|
1051
|
+
*/
|
|
1052
|
+
'warehouseReferenceId'?: string;
|
|
1053
|
+
}
|
|
1054
|
+
//#endregion
|
|
1055
|
+
//#region src/api-model/models/inbound-shipment-summary.d.ts
|
|
1287
1056
|
/**
|
|
1288
1057
|
* Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment.
|
|
1289
1058
|
*/
|
|
1290
1059
|
interface InboundShipmentSummary {
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
}
|
|
1313
|
-
|
|
1060
|
+
/**
|
|
1061
|
+
* Timestamp when the shipment was created.
|
|
1062
|
+
*/
|
|
1063
|
+
'createdAt'?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record.
|
|
1066
|
+
*/
|
|
1067
|
+
'externalReferenceId'?: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* The AWD inbound order ID that this inbound shipment belongs to.
|
|
1070
|
+
*/
|
|
1071
|
+
'orderId': string;
|
|
1072
|
+
/**
|
|
1073
|
+
* A unique shipment ID.
|
|
1074
|
+
*/
|
|
1075
|
+
'shipmentId': string;
|
|
1076
|
+
'shipmentStatus': InboundShipmentStatus;
|
|
1077
|
+
/**
|
|
1078
|
+
* Timestamp when the shipment was updated.
|
|
1079
|
+
*/
|
|
1080
|
+
'updatedAt'?: string;
|
|
1081
|
+
}
|
|
1082
|
+
//#endregion
|
|
1083
|
+
//#region src/api-model/models/inventory-details.d.ts
|
|
1314
1084
|
/**
|
|
1315
1085
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1316
1086
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1326,20 +1096,21 @@ interface InboundShipmentSummary {
|
|
|
1326
1096
|
* Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`.
|
|
1327
1097
|
*/
|
|
1328
1098
|
interface InventoryDetails {
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
}
|
|
1342
|
-
|
|
1099
|
+
/**
|
|
1100
|
+
* Quantity that is available for downstream channel replenishment.
|
|
1101
|
+
*/
|
|
1102
|
+
'availableDistributableQuantity'?: number;
|
|
1103
|
+
/**
|
|
1104
|
+
* Quantity that is in transit from AWD and has not yet been received at FBA.
|
|
1105
|
+
*/
|
|
1106
|
+
'replenishmentQuantity'?: number;
|
|
1107
|
+
/**
|
|
1108
|
+
* Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment.
|
|
1109
|
+
*/
|
|
1110
|
+
'reservedDistributableQuantity'?: number;
|
|
1111
|
+
}
|
|
1112
|
+
//#endregion
|
|
1113
|
+
//#region src/api-model/models/inventory-details-visibility.d.ts
|
|
1343
1114
|
/**
|
|
1344
1115
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1345
1116
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1355,72 +1126,51 @@ interface InventoryDetails {
|
|
|
1355
1126
|
* Enum to specify if returned summaries should include additional summarized inventory details and quantities.
|
|
1356
1127
|
*/
|
|
1357
1128
|
declare const InventoryDetailsVisibility: {
|
|
1358
|
-
|
|
1359
|
-
|
|
1129
|
+
readonly Show: "SHOW";
|
|
1130
|
+
readonly Hide: "HIDE";
|
|
1360
1131
|
};
|
|
1361
1132
|
type InventoryDetailsVisibility = typeof InventoryDetailsVisibility[keyof typeof InventoryDetailsVisibility];
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1365
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1366
|
-
*
|
|
1367
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1370
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1371
|
-
* https://openapi-generator.tech
|
|
1372
|
-
* Do not edit the class manually.
|
|
1373
|
-
*/
|
|
1374
|
-
|
|
1133
|
+
//#endregion
|
|
1134
|
+
//#region src/api-model/models/inventory-summary.d.ts
|
|
1375
1135
|
/**
|
|
1376
1136
|
* Summary of inventory per SKU.
|
|
1377
1137
|
*/
|
|
1378
1138
|
interface InventorySummary {
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
}
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1400
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1401
|
-
*
|
|
1402
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1403
|
-
*
|
|
1404
|
-
*
|
|
1405
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1406
|
-
* https://openapi-generator.tech
|
|
1407
|
-
* Do not edit the class manually.
|
|
1408
|
-
*/
|
|
1409
|
-
|
|
1139
|
+
/**
|
|
1140
|
+
* The expiration details of the inventory. This object will only appear if the `details` parameter in the request is set to `SHOW`.
|
|
1141
|
+
*/
|
|
1142
|
+
'expirationDetails'?: Array<ExpirationDetails>;
|
|
1143
|
+
'inventoryDetails'?: InventoryDetails;
|
|
1144
|
+
/**
|
|
1145
|
+
* The seller or merchant SKU.
|
|
1146
|
+
*/
|
|
1147
|
+
'sku': string;
|
|
1148
|
+
/**
|
|
1149
|
+
* Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center
|
|
1150
|
+
*/
|
|
1151
|
+
'totalInboundQuantity'?: number;
|
|
1152
|
+
/**
|
|
1153
|
+
* Total quantity that is present in AWD distribution centers.
|
|
1154
|
+
*/
|
|
1155
|
+
'totalOnhandQuantity'?: number;
|
|
1156
|
+
}
|
|
1157
|
+
//#endregion
|
|
1158
|
+
//#region src/api-model/models/inventory-listing.d.ts
|
|
1410
1159
|
/**
|
|
1411
1160
|
* AWD inventory payload.
|
|
1412
1161
|
*/
|
|
1413
1162
|
interface InventoryListing {
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1163
|
+
/**
|
|
1164
|
+
* List of inventory summaries.
|
|
1165
|
+
*/
|
|
1166
|
+
'inventory': Array<InventorySummary>;
|
|
1167
|
+
/**
|
|
1168
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1169
|
+
*/
|
|
1170
|
+
'nextToken'?: string;
|
|
1422
1171
|
}
|
|
1423
|
-
|
|
1172
|
+
//#endregion
|
|
1173
|
+
//#region src/api-model/models/label-status.d.ts
|
|
1424
1174
|
/**
|
|
1425
1175
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1426
1176
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1436,13 +1186,14 @@ interface InventoryListing {
|
|
|
1436
1186
|
* The status of your label.
|
|
1437
1187
|
*/
|
|
1438
1188
|
declare const LabelStatus: {
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1189
|
+
readonly Generating: "GENERATING";
|
|
1190
|
+
readonly Generated: "GENERATED";
|
|
1191
|
+
readonly GenerationFailed: "GENERATION_FAILED";
|
|
1192
|
+
readonly NotReady: "NOT_READY";
|
|
1443
1193
|
};
|
|
1444
1194
|
type LabelStatus = typeof LabelStatus[keyof typeof LabelStatus];
|
|
1445
|
-
|
|
1195
|
+
//#endregion
|
|
1196
|
+
//#region src/api-model/models/model-error.d.ts
|
|
1446
1197
|
/**
|
|
1447
1198
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1448
1199
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1458,20 +1209,21 @@ type LabelStatus = typeof LabelStatus[keyof typeof LabelStatus];
|
|
|
1458
1209
|
* Error response returned when the request is unsuccessful.
|
|
1459
1210
|
*/
|
|
1460
1211
|
interface ModelError {
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
}
|
|
1474
|
-
|
|
1212
|
+
/**
|
|
1213
|
+
* An error code that identifies the type of error that occurred.
|
|
1214
|
+
*/
|
|
1215
|
+
'code': string;
|
|
1216
|
+
/**
|
|
1217
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
1218
|
+
*/
|
|
1219
|
+
'details'?: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* A message that describes the error condition.
|
|
1222
|
+
*/
|
|
1223
|
+
'message': string;
|
|
1224
|
+
}
|
|
1225
|
+
//#endregion
|
|
1226
|
+
//#region src/api-model/models/order-preference.d.ts
|
|
1475
1227
|
/**
|
|
1476
1228
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1477
1229
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1487,10 +1239,11 @@ interface ModelError {
|
|
|
1487
1239
|
* Supported preferences for the distribution order.
|
|
1488
1240
|
*/
|
|
1489
1241
|
declare const OrderPreference: {
|
|
1490
|
-
|
|
1242
|
+
readonly PartialOrder: "PARTIAL_ORDER";
|
|
1491
1243
|
};
|
|
1492
1244
|
type OrderPreference = typeof OrderPreference[keyof typeof OrderPreference];
|
|
1493
|
-
|
|
1245
|
+
//#endregion
|
|
1246
|
+
//#region src/api-model/models/order-preference-value.d.ts
|
|
1494
1247
|
/**
|
|
1495
1248
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1496
1249
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1506,31 +1259,21 @@ type OrderPreference = typeof OrderPreference[keyof typeof OrderPreference];
|
|
|
1506
1259
|
* Value for the order preference.
|
|
1507
1260
|
*/
|
|
1508
1261
|
declare const OrderPreferenceValue: {
|
|
1509
|
-
|
|
1510
|
-
|
|
1262
|
+
readonly Set: "SET";
|
|
1263
|
+
readonly Unset: "UNSET";
|
|
1511
1264
|
};
|
|
1512
1265
|
type OrderPreferenceValue = typeof OrderPreferenceValue[keyof typeof OrderPreferenceValue];
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1516
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1517
|
-
*
|
|
1518
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1519
|
-
*
|
|
1520
|
-
*
|
|
1521
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1522
|
-
* https://openapi-generator.tech
|
|
1523
|
-
* Do not edit the class manually.
|
|
1524
|
-
*/
|
|
1525
|
-
|
|
1266
|
+
//#endregion
|
|
1267
|
+
//#region src/api-model/models/order-attribute.d.ts
|
|
1526
1268
|
/**
|
|
1527
1269
|
* Consists of the order preference and corresponding preference value.
|
|
1528
1270
|
*/
|
|
1529
1271
|
interface OrderAttribute {
|
|
1530
|
-
|
|
1531
|
-
|
|
1272
|
+
'orderPreference': OrderPreference;
|
|
1273
|
+
'orderPreferenceValue': OrderPreferenceValue;
|
|
1532
1274
|
}
|
|
1533
|
-
|
|
1275
|
+
//#endregion
|
|
1276
|
+
//#region src/api-model/models/outbound-execution-error.d.ts
|
|
1534
1277
|
/**
|
|
1535
1278
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1536
1279
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1546,20 +1289,21 @@ interface OrderAttribute {
|
|
|
1546
1289
|
* Execution errors associated with the outbound order. This field will be populated if the order failed validation.
|
|
1547
1290
|
*/
|
|
1548
1291
|
interface OutboundExecutionError {
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
}
|
|
1562
|
-
|
|
1292
|
+
/**
|
|
1293
|
+
* Failure code details for the error.
|
|
1294
|
+
*/
|
|
1295
|
+
'failureCode': string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Failure reasons for the error.
|
|
1298
|
+
*/
|
|
1299
|
+
'failureReasons': Array<string>;
|
|
1300
|
+
/**
|
|
1301
|
+
* MSKU associated with the error.
|
|
1302
|
+
*/
|
|
1303
|
+
'sku'?: string;
|
|
1304
|
+
}
|
|
1305
|
+
//#endregion
|
|
1306
|
+
//#region src/api-model/models/outbound-shipment-status.d.ts
|
|
1563
1307
|
/**
|
|
1564
1308
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1565
1309
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1575,62 +1319,52 @@ interface OutboundExecutionError {
|
|
|
1575
1319
|
* Possible shipment statuses for outbound shipments.
|
|
1576
1320
|
*/
|
|
1577
1321
|
declare const OutboundShipmentStatus: {
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1322
|
+
readonly Created: "CREATED";
|
|
1323
|
+
readonly InTransit: "IN_TRANSIT";
|
|
1324
|
+
readonly Delivered: "DELIVERED";
|
|
1325
|
+
readonly Receiving: "RECEIVING";
|
|
1326
|
+
readonly Received: "RECEIVED";
|
|
1327
|
+
readonly Closed: "CLOSED";
|
|
1328
|
+
readonly Cancelled: "CANCELLED";
|
|
1329
|
+
readonly Failed: "FAILED";
|
|
1586
1330
|
};
|
|
1587
1331
|
type OutboundShipmentStatus = typeof OutboundShipmentStatus[keyof typeof OutboundShipmentStatus];
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1591
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1592
|
-
*
|
|
1593
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1594
|
-
*
|
|
1595
|
-
*
|
|
1596
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1597
|
-
* https://openapi-generator.tech
|
|
1598
|
-
* Do not edit the class manually.
|
|
1599
|
-
*/
|
|
1600
|
-
|
|
1332
|
+
//#endregion
|
|
1333
|
+
//#region src/api-model/models/outbound-shipment.d.ts
|
|
1601
1334
|
/**
|
|
1602
1335
|
* Represents an AWD outbound shipment.
|
|
1603
1336
|
*/
|
|
1604
1337
|
interface OutboundShipment {
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
}
|
|
1633
|
-
|
|
1338
|
+
/**
|
|
1339
|
+
* Timestamp when the shipment was created.
|
|
1340
|
+
*/
|
|
1341
|
+
'createdAt'?: string;
|
|
1342
|
+
'destinationAddress': Address;
|
|
1343
|
+
/**
|
|
1344
|
+
* Outbound order ID this outbound shipment belongs to.
|
|
1345
|
+
*/
|
|
1346
|
+
'orderId': string;
|
|
1347
|
+
'originAddress': Address;
|
|
1348
|
+
/**
|
|
1349
|
+
* Specific distribution packages that are included in the context of this shipment.
|
|
1350
|
+
*/
|
|
1351
|
+
'shipmentPackageQuantities'?: Array<DistributionPackageQuantity>;
|
|
1352
|
+
/**
|
|
1353
|
+
* Unique shipment ID.
|
|
1354
|
+
*/
|
|
1355
|
+
'shipmentId': string;
|
|
1356
|
+
/**
|
|
1357
|
+
* Specific product units that are included in the context of this shipment.
|
|
1358
|
+
*/
|
|
1359
|
+
'shipmentProductQuantities'?: Array<ProductQuantity>;
|
|
1360
|
+
'shipmentStatus': OutboundShipmentStatus;
|
|
1361
|
+
/**
|
|
1362
|
+
* Timestamp when the shipment was updated.
|
|
1363
|
+
*/
|
|
1364
|
+
'updatedAt'?: string;
|
|
1365
|
+
}
|
|
1366
|
+
//#endregion
|
|
1367
|
+
//#region src/api-model/models/outbound-status.d.ts
|
|
1634
1368
|
/**
|
|
1635
1369
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1636
1370
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1646,145 +1380,113 @@ interface OutboundShipment {
|
|
|
1646
1380
|
* Statuses supported for an outbound order.
|
|
1647
1381
|
*/
|
|
1648
1382
|
declare const OutboundStatus: {
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1383
|
+
readonly Confirmed: "CONFIRMED";
|
|
1384
|
+
readonly Draft: "DRAFT";
|
|
1385
|
+
readonly Eligible: "ELIGIBLE";
|
|
1386
|
+
readonly Executing: "EXECUTING";
|
|
1387
|
+
readonly Failure: "FAILURE";
|
|
1388
|
+
readonly Ineligible: "INELIGIBLE";
|
|
1389
|
+
readonly InventoryOutbound: "INVENTORY_OUTBOUND";
|
|
1390
|
+
readonly Success: "SUCCESS";
|
|
1391
|
+
readonly Validating: "VALIDATING";
|
|
1658
1392
|
};
|
|
1659
1393
|
type OutboundStatus = typeof OutboundStatus[keyof typeof OutboundStatus];
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1663
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1664
|
-
*
|
|
1665
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1668
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1669
|
-
* https://openapi-generator.tech
|
|
1670
|
-
* Do not edit the class manually.
|
|
1671
|
-
*/
|
|
1672
|
-
|
|
1394
|
+
//#endregion
|
|
1395
|
+
//#region src/api-model/models/outbound-order.d.ts
|
|
1673
1396
|
/**
|
|
1674
1397
|
* Represents an AWD outbound order.
|
|
1675
1398
|
*/
|
|
1676
1399
|
interface OutboundOrder {
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
}
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1734
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1735
|
-
*
|
|
1736
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1737
|
-
*
|
|
1738
|
-
*
|
|
1739
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1740
|
-
* https://openapi-generator.tech
|
|
1741
|
-
* Do not edit the class manually.
|
|
1742
|
-
*/
|
|
1743
|
-
|
|
1400
|
+
/**
|
|
1401
|
+
* Date on which this outbound order was confirmed.
|
|
1402
|
+
*/
|
|
1403
|
+
'confirmedOn'?: string;
|
|
1404
|
+
/**
|
|
1405
|
+
* Date on which this outbound order was created.
|
|
1406
|
+
*/
|
|
1407
|
+
'createdAt'?: string;
|
|
1408
|
+
/**
|
|
1409
|
+
* List of packages that are eligible for outbound.
|
|
1410
|
+
*/
|
|
1411
|
+
'eligiblePackagesToOutbound'?: Array<DistributionPackageQuantity>;
|
|
1412
|
+
/**
|
|
1413
|
+
* List of product units that are eligible for outbound.
|
|
1414
|
+
*/
|
|
1415
|
+
'eligibleProductsToOutbound'?: Array<ProductQuantity>;
|
|
1416
|
+
/**
|
|
1417
|
+
* Execution errors associated with the outbound order. This field will be populated if the order failed validation.
|
|
1418
|
+
*/
|
|
1419
|
+
'executionErrors'?: Array<OutboundExecutionError>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Order ID for the outbound order.
|
|
1422
|
+
*/
|
|
1423
|
+
'orderId': string;
|
|
1424
|
+
/**
|
|
1425
|
+
* Order preferences for this outbound order.
|
|
1426
|
+
*/
|
|
1427
|
+
'orderPreferences'?: Array<OrderAttribute>;
|
|
1428
|
+
'orderStatus': OutboundStatus;
|
|
1429
|
+
/**
|
|
1430
|
+
* List of outbound shipments that are part of this order.
|
|
1431
|
+
*/
|
|
1432
|
+
'outboundShipments': Array<OutboundShipment>;
|
|
1433
|
+
/**
|
|
1434
|
+
* List of packages to be outbound.
|
|
1435
|
+
*/
|
|
1436
|
+
'packagesToOutbound'?: Array<DistributionPackageQuantity>;
|
|
1437
|
+
/**
|
|
1438
|
+
* List of product units to be outbound.
|
|
1439
|
+
*/
|
|
1440
|
+
'productsToOutbound'?: Array<ProductQuantity>;
|
|
1441
|
+
/**
|
|
1442
|
+
* Outbound packages that are shipped after the execution has completed post confirmation.
|
|
1443
|
+
*/
|
|
1444
|
+
'shippedOutboundPackages'?: Array<DistributionPackageQuantity>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Outbound product units that are shipped after the execution has completed post confirmation.
|
|
1447
|
+
*/
|
|
1448
|
+
'shippedOutboundProducts'?: Array<ProductQuantity>;
|
|
1449
|
+
/**
|
|
1450
|
+
* Date on which this outbound order was last updated.
|
|
1451
|
+
*/
|
|
1452
|
+
'updatedAt'?: string;
|
|
1453
|
+
}
|
|
1454
|
+
//#endregion
|
|
1455
|
+
//#region src/api-model/models/outbound-listing.d.ts
|
|
1744
1456
|
/**
|
|
1745
1457
|
* A list of paginated outbound orders filtered by the attributes passed in the request.
|
|
1746
1458
|
*/
|
|
1747
1459
|
interface OutboundListing {
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
}
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1760
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1761
|
-
*
|
|
1762
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1763
|
-
*
|
|
1764
|
-
*
|
|
1765
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1766
|
-
* https://openapi-generator.tech
|
|
1767
|
-
* Do not edit the class manually.
|
|
1768
|
-
*/
|
|
1769
|
-
|
|
1460
|
+
/**
|
|
1461
|
+
* TA token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1462
|
+
*/
|
|
1463
|
+
'nextToken'?: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* List of outbound orders.
|
|
1466
|
+
*/
|
|
1467
|
+
'outboundOrders'?: Array<OutboundOrder>;
|
|
1468
|
+
}
|
|
1469
|
+
//#endregion
|
|
1470
|
+
//#region src/api-model/models/outbound-order-creation-data.d.ts
|
|
1770
1471
|
/**
|
|
1771
1472
|
* Payload for creating an outbound order.
|
|
1772
1473
|
*/
|
|
1773
1474
|
interface OutboundOrderCreationData {
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
}
|
|
1787
|
-
|
|
1475
|
+
/**
|
|
1476
|
+
* Order preferences for the outbound order.
|
|
1477
|
+
*/
|
|
1478
|
+
'orderPreferences'?: Array<OrderAttribute>;
|
|
1479
|
+
/**
|
|
1480
|
+
* List of packages to be outbound.
|
|
1481
|
+
*/
|
|
1482
|
+
'packagesToOutbound'?: Array<DistributionPackageQuantity>;
|
|
1483
|
+
/**
|
|
1484
|
+
* List of product units to be outbound.
|
|
1485
|
+
*/
|
|
1486
|
+
'productsToOutbound'?: Array<ProductQuantity>;
|
|
1487
|
+
}
|
|
1488
|
+
//#endregion
|
|
1489
|
+
//#region src/api-model/models/outbound-order-reference.d.ts
|
|
1788
1490
|
/**
|
|
1789
1491
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1790
1492
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1800,47 +1502,37 @@ interface OutboundOrderCreationData {
|
|
|
1800
1502
|
* A response that contains the reference identifier for the newly created or updated outbound order. This includes an order ID.
|
|
1801
1503
|
*/
|
|
1802
1504
|
interface OutboundOrderReference {
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1505
|
+
/**
|
|
1506
|
+
* outbound order ID.
|
|
1507
|
+
*/
|
|
1508
|
+
'orderId': string;
|
|
1807
1509
|
}
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1811
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1812
|
-
*
|
|
1813
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1814
|
-
*
|
|
1815
|
-
*
|
|
1816
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1817
|
-
* https://openapi-generator.tech
|
|
1818
|
-
* Do not edit the class manually.
|
|
1819
|
-
*/
|
|
1820
|
-
|
|
1510
|
+
//#endregion
|
|
1511
|
+
//#region src/api-model/models/outbound-shipment-summary.d.ts
|
|
1821
1512
|
/**
|
|
1822
1513
|
* Summary of an AWD inbound shipment containing the shipment ID which can be used to fetch the actual shipment
|
|
1823
1514
|
*/
|
|
1824
1515
|
interface OutboundShipmentSummary {
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
}
|
|
1843
|
-
|
|
1516
|
+
/**
|
|
1517
|
+
* Timestamp denoting when the shipment was created
|
|
1518
|
+
*/
|
|
1519
|
+
'createdAt'?: string;
|
|
1520
|
+
/**
|
|
1521
|
+
* Order ID of AWD inbound order this inbound shipment belongs to
|
|
1522
|
+
*/
|
|
1523
|
+
'orderId': string;
|
|
1524
|
+
/**
|
|
1525
|
+
* Unique shipment ID
|
|
1526
|
+
*/
|
|
1527
|
+
'shipmentId': string;
|
|
1528
|
+
'shipmentStatus': OutboundShipmentStatus;
|
|
1529
|
+
/**
|
|
1530
|
+
* Timestamp denoting when the shipment was updated
|
|
1531
|
+
*/
|
|
1532
|
+
'updatedAt'?: string;
|
|
1533
|
+
}
|
|
1534
|
+
//#endregion
|
|
1535
|
+
//#region src/api-model/models/page-type.d.ts
|
|
1844
1536
|
/**
|
|
1845
1537
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1846
1538
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1856,18 +1548,19 @@ interface OutboundShipmentSummary {
|
|
|
1856
1548
|
* Label page type.
|
|
1857
1549
|
*/
|
|
1858
1550
|
declare const PageType: {
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1551
|
+
readonly PlainPaper: "PLAIN_PAPER";
|
|
1552
|
+
readonly LetterPcpFulfillmentlabel: "LETTER_PCP_FULFILLMENTLABEL";
|
|
1553
|
+
readonly Letter2Horizontal: "LETTER_2_HORIZONTAL";
|
|
1554
|
+
readonly Letter2: "LETTER_2";
|
|
1555
|
+
readonly ThermalNoCarrierRotation: "THERMAL_NO_CARRIER_ROTATION";
|
|
1556
|
+
readonly Thermal: "THERMAL";
|
|
1557
|
+
readonly A4Paper: "A4_PAPER";
|
|
1558
|
+
readonly A42Horizontal: "A4_2_HORIZONTAL";
|
|
1559
|
+
readonly ThermalSquare10Cm: "THERMAL_SQUARE_10CM";
|
|
1868
1560
|
};
|
|
1869
1561
|
type PageType = typeof PageType[keyof typeof PageType];
|
|
1870
|
-
|
|
1562
|
+
//#endregion
|
|
1563
|
+
//#region src/api-model/models/replenishment-order-status.d.ts
|
|
1871
1564
|
/**
|
|
1872
1565
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1873
1566
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -1883,141 +1576,98 @@ type PageType = typeof PageType[keyof typeof PageType];
|
|
|
1883
1576
|
* Statuses supported for an replenishment order.
|
|
1884
1577
|
*/
|
|
1885
1578
|
declare const ReplenishmentOrderStatus: {
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1579
|
+
readonly Confirmed: "CONFIRMED";
|
|
1580
|
+
readonly Created: "CREATED";
|
|
1581
|
+
readonly Eligible: "ELIGIBLE";
|
|
1582
|
+
readonly Executing: "EXECUTING";
|
|
1583
|
+
readonly Failure: "FAILURE";
|
|
1584
|
+
readonly Ineligible: "INELIGIBLE";
|
|
1585
|
+
readonly InventoryOutbound: "INVENTORY_OUTBOUND";
|
|
1586
|
+
readonly Success: "SUCCESS";
|
|
1587
|
+
readonly Validating: "VALIDATING";
|
|
1895
1588
|
};
|
|
1896
1589
|
type ReplenishmentOrderStatus = typeof ReplenishmentOrderStatus[keyof typeof ReplenishmentOrderStatus];
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1900
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1901
|
-
*
|
|
1902
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1903
|
-
*
|
|
1904
|
-
*
|
|
1905
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1906
|
-
* https://openapi-generator.tech
|
|
1907
|
-
* Do not edit the class manually.
|
|
1908
|
-
*/
|
|
1909
|
-
|
|
1590
|
+
//#endregion
|
|
1591
|
+
//#region src/api-model/models/replenishment-order.d.ts
|
|
1910
1592
|
/**
|
|
1911
1593
|
* Represents an AWD replenishment order.
|
|
1912
1594
|
*/
|
|
1913
1595
|
interface ReplenishmentOrder {
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
1942
|
-
|
|
1943
|
-
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
}
|
|
1952
|
-
|
|
1953
|
-
|
|
1954
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1955
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1956
|
-
*
|
|
1957
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1960
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1961
|
-
* https://openapi-generator.tech
|
|
1962
|
-
* Do not edit the class manually.
|
|
1963
|
-
*/
|
|
1964
|
-
|
|
1596
|
+
/**
|
|
1597
|
+
* Date on which this replenishment order was confirmed.
|
|
1598
|
+
*/
|
|
1599
|
+
'confirmedOn'?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* Date on which this replenishment order was created.
|
|
1602
|
+
*/
|
|
1603
|
+
'createdAt'?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* Distribution errors associated with the order related to the products or packages to replenish. This field will be populated if the order has products or packages which failed validation.
|
|
1606
|
+
*/
|
|
1607
|
+
'distributionIneligibleReasons'?: Array<DistributionIneligibleReason>;
|
|
1608
|
+
/**
|
|
1609
|
+
* List of product units that are eligible for replenishment.
|
|
1610
|
+
*/
|
|
1611
|
+
'eligibleProducts'?: Array<DistributionProduct>;
|
|
1612
|
+
/**
|
|
1613
|
+
* Order Id of the replenishment order.
|
|
1614
|
+
*/
|
|
1615
|
+
'orderId': string;
|
|
1616
|
+
'status': ReplenishmentOrderStatus;
|
|
1617
|
+
/**
|
|
1618
|
+
* List of outbound shipments that are part of this order.
|
|
1619
|
+
*/
|
|
1620
|
+
'outboundShipments': Array<OutboundShipmentSummary>;
|
|
1621
|
+
/**
|
|
1622
|
+
* Requested amount of single product units to be replenished.
|
|
1623
|
+
*/
|
|
1624
|
+
'products'?: Array<DistributionProduct>;
|
|
1625
|
+
/**
|
|
1626
|
+
* Outbound product units that are shipped after the execution has completed post confirmation.
|
|
1627
|
+
*/
|
|
1628
|
+
'shippedProducts'?: Array<DistributionProduct>;
|
|
1629
|
+
/**
|
|
1630
|
+
* Date on which this replenishment order was last updated.
|
|
1631
|
+
*/
|
|
1632
|
+
'updatedAt'?: string;
|
|
1633
|
+
}
|
|
1634
|
+
//#endregion
|
|
1635
|
+
//#region src/api-model/models/replenishment-preferences.d.ts
|
|
1965
1636
|
/**
|
|
1966
1637
|
* Preferences that can be passed in context of a replenishment order
|
|
1967
1638
|
*/
|
|
1968
1639
|
interface ReplenishmentPreferences {
|
|
1969
|
-
|
|
1640
|
+
'confirmation'?: ConfirmationMode;
|
|
1970
1641
|
}
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1974
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1975
|
-
*
|
|
1976
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
1977
|
-
*
|
|
1978
|
-
*
|
|
1979
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1980
|
-
* https://openapi-generator.tech
|
|
1981
|
-
* Do not edit the class manually.
|
|
1982
|
-
*/
|
|
1983
|
-
|
|
1642
|
+
//#endregion
|
|
1643
|
+
//#region src/api-model/models/replenishment-order-creation-data.d.ts
|
|
1984
1644
|
/**
|
|
1985
1645
|
* This structure represents the payload for creating an AFN Replenishment Order. By default, all replenishment orders created support Partial order preferences.
|
|
1986
1646
|
*/
|
|
1987
1647
|
interface ReplenishmentOrderCreationData {
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1648
|
+
'preferences'?: ReplenishmentPreferences;
|
|
1649
|
+
/**
|
|
1650
|
+
* Requested amount of single product units to be replenished.
|
|
1651
|
+
*/
|
|
1652
|
+
'products'?: Array<DistributionProduct>;
|
|
1993
1653
|
}
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
1997
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
1998
|
-
*
|
|
1999
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
2000
|
-
*
|
|
2001
|
-
*
|
|
2002
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2003
|
-
* https://openapi-generator.tech
|
|
2004
|
-
* Do not edit the class manually.
|
|
2005
|
-
*/
|
|
2006
|
-
|
|
1654
|
+
//#endregion
|
|
1655
|
+
//#region src/api-model/models/replenishment-order-listing.d.ts
|
|
2007
1656
|
/**
|
|
2008
1657
|
* A list of paginated replenishment orders filtered by the attributes passed in the request.
|
|
2009
1658
|
*/
|
|
2010
1659
|
interface ReplenishmentOrderListing {
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
1660
|
+
/**
|
|
1661
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1662
|
+
*/
|
|
1663
|
+
'nextToken'?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* List of replenishment orders.
|
|
1666
|
+
*/
|
|
1667
|
+
'orders'?: Array<ReplenishmentOrder>;
|
|
2019
1668
|
}
|
|
2020
|
-
|
|
1669
|
+
//#endregion
|
|
1670
|
+
//#region src/api-model/models/replenishment-order-reference.d.ts
|
|
2021
1671
|
/**
|
|
2022
1672
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2023
1673
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -2033,84 +1683,52 @@ interface ReplenishmentOrderListing {
|
|
|
2033
1683
|
* Response containing the reference identifier for the newly created/updated replenishment order consisting of the order ID.
|
|
2034
1684
|
*/
|
|
2035
1685
|
interface ReplenishmentOrderReference {
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
|
|
1686
|
+
/**
|
|
1687
|
+
* Order ID of the Replenishment order.
|
|
1688
|
+
*/
|
|
1689
|
+
'orderId': string;
|
|
2040
1690
|
}
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2044
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
2045
|
-
*
|
|
2046
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
2047
|
-
*
|
|
2048
|
-
*
|
|
2049
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2050
|
-
* https://openapi-generator.tech
|
|
2051
|
-
* Do not edit the class manually.
|
|
2052
|
-
*/
|
|
2053
|
-
|
|
1691
|
+
//#endregion
|
|
1692
|
+
//#region src/api-model/models/shipment-label-page-types.d.ts
|
|
2054
1693
|
/**
|
|
2055
1694
|
* Shipment label page types.
|
|
2056
1695
|
*/
|
|
2057
1696
|
interface ShipmentLabelPageTypes {
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
|
-
|
|
1697
|
+
'labelStatus': LabelStatus;
|
|
1698
|
+
/**
|
|
1699
|
+
* List of available page types.
|
|
1700
|
+
*/
|
|
1701
|
+
'pageTypes'?: Array<PageType>;
|
|
2063
1702
|
}
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2067
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
2068
|
-
*
|
|
2069
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
2070
|
-
*
|
|
2071
|
-
*
|
|
2072
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2073
|
-
* https://openapi-generator.tech
|
|
2074
|
-
* Do not edit the class manually.
|
|
2075
|
-
*/
|
|
2076
|
-
|
|
1703
|
+
//#endregion
|
|
1704
|
+
//#region src/api-model/models/shipment-labels.d.ts
|
|
2077
1705
|
/**
|
|
2078
1706
|
* Shipment labels.
|
|
2079
1707
|
*/
|
|
2080
1708
|
interface ShipmentLabels {
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
1709
|
+
/**
|
|
1710
|
+
* The URL to download shipment labels. The URL is active for 600 seconds from generation.
|
|
1711
|
+
*/
|
|
1712
|
+
'labelDownloadURL'?: string;
|
|
1713
|
+
'labelStatus': LabelStatus;
|
|
2086
1714
|
}
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2090
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
2091
|
-
*
|
|
2092
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
2093
|
-
*
|
|
2094
|
-
*
|
|
2095
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2096
|
-
* https://openapi-generator.tech
|
|
2097
|
-
* Do not edit the class manually.
|
|
2098
|
-
*/
|
|
2099
|
-
|
|
1715
|
+
//#endregion
|
|
1716
|
+
//#region src/api-model/models/shipment-listing.d.ts
|
|
2100
1717
|
/**
|
|
2101
1718
|
* A list of inbound shipment summaries filtered by the attributes specified in the request.
|
|
2102
1719
|
*/
|
|
2103
1720
|
interface ShipmentListing {
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
1721
|
+
/**
|
|
1722
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1723
|
+
*/
|
|
1724
|
+
'nextToken'?: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* List of inbound shipment summaries.
|
|
1727
|
+
*/
|
|
1728
|
+
'shipments'?: Array<InboundShipmentSummary>;
|
|
2112
1729
|
}
|
|
2113
|
-
|
|
1730
|
+
//#endregion
|
|
1731
|
+
//#region src/api-model/models/shipment-sortable-field.d.ts
|
|
2114
1732
|
/**
|
|
2115
1733
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2116
1734
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -2126,11 +1744,12 @@ interface ShipmentListing {
|
|
|
2126
1744
|
* Denotes the field name on which the shipments are to be sorted.
|
|
2127
1745
|
*/
|
|
2128
1746
|
declare const ShipmentSortableField: {
|
|
2129
|
-
|
|
2130
|
-
|
|
1747
|
+
readonly UpdatedAt: "UPDATED_AT";
|
|
1748
|
+
readonly CreatedAt: "CREATED_AT";
|
|
2131
1749
|
};
|
|
2132
1750
|
type ShipmentSortableField = typeof ShipmentSortableField[keyof typeof ShipmentSortableField];
|
|
2133
|
-
|
|
1751
|
+
//#endregion
|
|
1752
|
+
//#region src/api-model/models/sku-quantities-visibility.d.ts
|
|
2134
1753
|
/**
|
|
2135
1754
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2136
1755
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -2146,11 +1765,12 @@ type ShipmentSortableField = typeof ShipmentSortableField[keyof typeof ShipmentS
|
|
|
2146
1765
|
* Enum to specify if returned shipment should include SKU quantity details
|
|
2147
1766
|
*/
|
|
2148
1767
|
declare const SkuQuantitiesVisibility: {
|
|
2149
|
-
|
|
2150
|
-
|
|
1768
|
+
readonly Show: "SHOW";
|
|
1769
|
+
readonly Hide: "HIDE";
|
|
2151
1770
|
};
|
|
2152
1771
|
type SkuQuantitiesVisibility = typeof SkuQuantitiesVisibility[keyof typeof SkuQuantitiesVisibility];
|
|
2153
|
-
|
|
1772
|
+
//#endregion
|
|
1773
|
+
//#region src/api-model/models/sort-order.d.ts
|
|
2154
1774
|
/**
|
|
2155
1775
|
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2156
1776
|
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
@@ -2166,1054 +1786,1035 @@ type SkuQuantitiesVisibility = typeof SkuQuantitiesVisibility[keyof typeof SkuQu
|
|
|
2166
1786
|
* Sort order for a collection of items. For example, order or shipment.
|
|
2167
1787
|
*/
|
|
2168
1788
|
declare const SortOrder: {
|
|
2169
|
-
|
|
2170
|
-
|
|
1789
|
+
readonly Ascending: "ASCENDING";
|
|
1790
|
+
readonly Descending: "DESCENDING";
|
|
2171
1791
|
};
|
|
2172
1792
|
type SortOrder = typeof SortOrder[keyof typeof SortOrder];
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2176
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
2177
|
-
*
|
|
2178
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2181
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2182
|
-
* https://openapi-generator.tech
|
|
2183
|
-
* Do not edit the class manually.
|
|
2184
|
-
*/
|
|
2185
|
-
|
|
1793
|
+
//#endregion
|
|
1794
|
+
//#region src/api-model/models/tracking-details.d.ts
|
|
2186
1795
|
/**
|
|
2187
1796
|
* Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment.
|
|
2188
1797
|
*/
|
|
2189
1798
|
interface TrackingDetails {
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
1799
|
+
'carrierCode'?: CarrierCode;
|
|
1800
|
+
/**
|
|
1801
|
+
* The identifier that is received from transportation to uniquely identify a booking.
|
|
1802
|
+
*/
|
|
1803
|
+
'bookingId': string;
|
|
2195
1804
|
}
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
2199
|
-
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
2200
|
-
*
|
|
2201
|
-
* The version of the OpenAPI document: 2024-05-09
|
|
2202
|
-
*
|
|
2203
|
-
*
|
|
2204
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2205
|
-
* https://openapi-generator.tech
|
|
2206
|
-
* Do not edit the class manually.
|
|
2207
|
-
*/
|
|
2208
|
-
|
|
1805
|
+
//#endregion
|
|
1806
|
+
//#region src/api-model/models/transportation-details.d.ts
|
|
2209
1807
|
/**
|
|
2210
1808
|
* Transportation details for the shipment.
|
|
2211
1809
|
*/
|
|
2212
1810
|
interface TransportationDetails {
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
1811
|
+
/**
|
|
1812
|
+
* Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment.
|
|
1813
|
+
*/
|
|
1814
|
+
'trackingDetails': Array<TrackingDetails>;
|
|
2217
1815
|
}
|
|
2218
|
-
|
|
1816
|
+
//#endregion
|
|
1817
|
+
//#region src/api-model/api/amazon-warehousing-and-distribution-api.d.ts
|
|
2219
1818
|
/**
|
|
2220
1819
|
* AmazonWarehousingAndDistributionApi - axios parameter creator
|
|
2221
1820
|
*/
|
|
2222
1821
|
declare const AmazonWarehousingAndDistributionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
1822
|
+
/**
|
|
1823
|
+
* Cancels an AWD Inbound order and its associated shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1824
|
+
* @param {string} orderId The ID of the inbound order you want to cancel.
|
|
1825
|
+
* @param {*} [options] Override http request option.
|
|
1826
|
+
* @throws {RequiredError}
|
|
1827
|
+
*/
|
|
1828
|
+
cancelInbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1829
|
+
/**
|
|
1830
|
+
* Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1831
|
+
* @param {InboundPackages} body Represents the packages you want to inbound.
|
|
1832
|
+
* @param {*} [options] Override http request option.
|
|
1833
|
+
* @throws {RequiredError}
|
|
1834
|
+
*/
|
|
1835
|
+
checkInboundEligibility: (body: InboundPackages, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1836
|
+
/**
|
|
1837
|
+
* Confirms an AWD inbound order in `DRAFT` status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1838
|
+
* @param {string} orderId The ID of the inbound order that you want to confirm.
|
|
1839
|
+
* @param {*} [options] Override http request option.
|
|
1840
|
+
* @throws {RequiredError}
|
|
1841
|
+
*/
|
|
1842
|
+
confirmInbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1843
|
+
/**
|
|
1844
|
+
* Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination node. You can confirm the order only if it\'s in an`ELIGIBLE` state. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1845
|
+
* @param {string} orderId ID for the outbound order you want to confirm.
|
|
1846
|
+
* @param {*} [options] Override http request option.
|
|
1847
|
+
* @throws {RequiredError}
|
|
1848
|
+
*/
|
|
1849
|
+
confirmOutbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1850
|
+
/**
|
|
1851
|
+
* Confirms an AWD replenishment order in ELIGIBLE state with a set of shipments containing items that are needed to be replenished to an FBA node. Order can only be confirmed in ELIGIBLE state.
|
|
1852
|
+
* @param {string} orderId ID of the replenishment order to be confirmed.
|
|
1853
|
+
* @param {*} [options] Override http request option.
|
|
1854
|
+
* @throws {RequiredError}
|
|
1855
|
+
*/
|
|
1856
|
+
confirmReplenishmentOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1857
|
+
/**
|
|
1858
|
+
* Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1859
|
+
* @param {InboundOrderCreationData} body Payload for creating an inbound order.
|
|
1860
|
+
* @param {*} [options] Override http request option.
|
|
1861
|
+
* @throws {RequiredError}
|
|
1862
|
+
*/
|
|
1863
|
+
createInbound: (body: InboundOrderCreationData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1864
|
+
/**
|
|
1865
|
+
* Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1866
|
+
* @param {OutboundOrderCreationData} body Payload for creating an outbound order.
|
|
1867
|
+
* @param {*} [options] Override http request option.
|
|
1868
|
+
* @throws {RequiredError}
|
|
1869
|
+
*/
|
|
1870
|
+
createOutbound: (body: OutboundOrderCreationData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Creates an AWD replenishment order with given products to replenish. The API will return the order ID of the newly created order and also start an async validation check on the products to e. The order status will transition to ELIGIBLE/INELIGIBLE status from VALIDATING post validation check
|
|
1873
|
+
* @param {ReplenishmentOrderCreationData} body Payload for creating a replenishment order.
|
|
1874
|
+
* @param {*} [options] Override http request option.
|
|
1875
|
+
* @throws {RequiredError}
|
|
1876
|
+
*/
|
|
1877
|
+
createReplenishmentOrder: (body: ReplenishmentOrderCreationData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1878
|
+
/**
|
|
1879
|
+
* Retrieves an AWD inbound order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1880
|
+
* @param {string} orderId The ID of the inbound order that you want to retrieve.
|
|
1881
|
+
* @param {*} [options] Override http request option.
|
|
1882
|
+
* @throws {RequiredError}
|
|
1883
|
+
*/
|
|
1884
|
+
getInbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1885
|
+
/**
|
|
1886
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
1887
|
+
* @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded.
|
|
1888
|
+
* @param {GetInboundShipmentSkuQuantitiesEnum} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
|
|
1889
|
+
* @param {*} [options] Override http request option.
|
|
1890
|
+
* @throws {RequiredError}
|
|
1891
|
+
*/
|
|
1892
|
+
getInboundShipment: (shipmentId: string, skuQuantities?: GetInboundShipmentSkuQuantitiesEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1893
|
+
/**
|
|
1894
|
+
* Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the label URL is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1895
|
+
* @param {string} shipmentId ID for the shipment.
|
|
1896
|
+
* @param {GetInboundShipmentLabelsPageTypeEnum} [pageType] Page type for the generated labels. The default is `PLAIN_PAPER`.
|
|
1897
|
+
* @param {GetInboundShipmentLabelsFormatTypeEnum} [formatType] The format type of the output file that contains your labels. The default format type is `PDF`.
|
|
1898
|
+
* @param {*} [options] Override http request option.
|
|
1899
|
+
* @throws {RequiredError}
|
|
1900
|
+
*/
|
|
1901
|
+
getInboundShipmentLabels: (shipmentId: string, pageType?: GetInboundShipmentLabelsPageTypeEnum, formatType?: GetInboundShipmentLabelsFormatTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1902
|
+
/**
|
|
1903
|
+
* Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the pageTypes are available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1904
|
+
* @param {string} shipmentId ID for the shipment.
|
|
1905
|
+
* @param {*} [options] Override http request option.
|
|
1906
|
+
* @throws {RequiredError}
|
|
1907
|
+
*/
|
|
1908
|
+
getLabelPageTypes: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1909
|
+
/**
|
|
1910
|
+
* Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination channel. If the order is not eligible, the validation errors field is included in the order response. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1911
|
+
* @param {string} orderId ID for the outbound order to be retrieved.
|
|
1912
|
+
* @param {*} [options] Override http request option.
|
|
1913
|
+
* @throws {RequiredError}
|
|
1914
|
+
*/
|
|
1915
|
+
getOutbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1916
|
+
/**
|
|
1917
|
+
* Retrieves an AWD Replenishment order with a set of shipments containing items that is/was planned to be replenished into an FBA node.
|
|
1918
|
+
* @param {string} orderId ID of the replenishment order to be retrieved.
|
|
1919
|
+
* @param {*} [options] Override http request option.
|
|
1920
|
+
* @throws {RequiredError}
|
|
1921
|
+
*/
|
|
1922
|
+
getReplenishmentOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1923
|
+
/**
|
|
1924
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1925
|
+
* @param {ListInboundShipmentsSortByEnum} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT.
|
|
1926
|
+
* @param {ListInboundShipmentsSortOrderEnum} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
|
|
1927
|
+
* @param {ListInboundShipmentsShipmentStatusEnum} [shipmentStatus] Filter by inbound shipment status.
|
|
1928
|
+
* @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
1929
|
+
* @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
1930
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
1931
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1932
|
+
* @param {*} [options] Override http request option.
|
|
1933
|
+
* @throws {RequiredError}
|
|
1934
|
+
*/
|
|
1935
|
+
listInboundShipments: (sortBy?: ListInboundShipmentsSortByEnum, sortOrder?: ListInboundShipmentsSortOrderEnum, shipmentStatus?: ListInboundShipmentsShipmentStatusEnum, updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1936
|
+
/**
|
|
1937
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1938
|
+
* @param {string} [sku] Filter by seller or merchant SKU for the item.
|
|
1939
|
+
* @param {ListInventorySortOrderEnum} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
1940
|
+
* @param {ListInventoryDetailsEnum} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
|
|
1941
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1942
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
1943
|
+
* @param {*} [options] Override http request option.
|
|
1944
|
+
* @throws {RequiredError}
|
|
1945
|
+
*/
|
|
1946
|
+
listInventory: (sku?: string, sortOrder?: ListInventorySortOrderEnum, details?: ListInventoryDetailsEnum, nextToken?: string, maxResults?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1947
|
+
/**
|
|
1948
|
+
* Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are sorted by the `updatedAt` attribute in descending order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1949
|
+
* @param {string} [updatedAfter] Get the outbound orders updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
1950
|
+
* @param {string} [updatedBefore] Get the outbound orders updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
1951
|
+
* @param {ListOutboundsSortOrderEnum} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
1952
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
1953
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1954
|
+
* @param {*} [options] Override http request option.
|
|
1955
|
+
* @throws {RequiredError}
|
|
1956
|
+
*/
|
|
1957
|
+
listOutbounds: (updatedAfter?: string, updatedBefore?: string, sortOrder?: ListOutboundsSortOrderEnum, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order.
|
|
1960
|
+
* @param {string} [updatedAfter] Get the replenishment orders updated after certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.
|
|
1961
|
+
* @param {string} [updatedBefore] Get the replenishment orders updated before certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.
|
|
1962
|
+
* @param {ListReplenishmentOrdersSortOrderEnum} [sortOrder] Sort the response in ASCENDING or DESCENDING order. The default sort order is DESCENDING.
|
|
1963
|
+
* @param {number} [maxResults] Maximum results to be returned in a single response.
|
|
1964
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1965
|
+
* @param {*} [options] Override http request option.
|
|
1966
|
+
* @throws {RequiredError}
|
|
1967
|
+
*/
|
|
1968
|
+
listReplenishmentOrders: (updatedAfter?: string, updatedBefore?: string, sortOrder?: ListReplenishmentOrdersSortOrderEnum, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1969
|
+
/**
|
|
1970
|
+
* Updates an AWD inbound order that is in `DRAFT` status and not yet confirmed. Use this operation to update the `packagesToInbound`, `originAddress` and `preferences` attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1971
|
+
* @param {string} orderId The ID of the inbound order that you want to update.
|
|
1972
|
+
* @param {InboundOrder} body Represents an AWD inbound order.
|
|
1973
|
+
* @param {*} [options] Override http request option.
|
|
1974
|
+
* @throws {RequiredError}
|
|
1975
|
+
*/
|
|
1976
|
+
updateInbound: (orderId: string, body: InboundOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1977
|
+
/**
|
|
1978
|
+
* Updates transport details for an AWD shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1979
|
+
* @param {string} shipmentId The shipment ID.
|
|
1980
|
+
* @param {TransportationDetails} body Transportation details for the shipment.
|
|
1981
|
+
* @param {*} [options] Override http request option.
|
|
1982
|
+
* @throws {RequiredError}
|
|
1983
|
+
*/
|
|
1984
|
+
updateInboundShipmentTransportDetails: (shipmentId: string, body: TransportationDetails, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1985
|
+
/**
|
|
1986
|
+
* Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on `productsToOutbound` and `orderPreferences` attributes only. Any updates will restart the outbound order validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1987
|
+
* @param {string} orderId ID for the outbound order to be updated.
|
|
1988
|
+
* @param {OutboundOrder} body Represents an AWD outbound order.
|
|
1989
|
+
* @param {*} [options] Override http request option.
|
|
1990
|
+
* @throws {RequiredError}
|
|
1991
|
+
*/
|
|
1992
|
+
updateOutbound: (orderId: string, body: OutboundOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2394
1993
|
};
|
|
2395
1994
|
/**
|
|
2396
1995
|
* AmazonWarehousingAndDistributionApi - functional programming interface
|
|
2397
1996
|
*/
|
|
2398
1997
|
declare const AmazonWarehousingAndDistributionApiFp: (configuration?: Configuration) => {
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
|
|
1998
|
+
/**
|
|
1999
|
+
* Cancels an AWD Inbound order and its associated shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2000
|
+
* @param {string} orderId The ID of the inbound order you want to cancel.
|
|
2001
|
+
* @param {*} [options] Override http request option.
|
|
2002
|
+
* @throws {RequiredError}
|
|
2003
|
+
*/
|
|
2004
|
+
cancelInbound(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2005
|
+
/**
|
|
2006
|
+
* Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2007
|
+
* @param {InboundPackages} body Represents the packages you want to inbound.
|
|
2008
|
+
* @param {*} [options] Override http request option.
|
|
2009
|
+
* @throws {RequiredError}
|
|
2010
|
+
*/
|
|
2011
|
+
checkInboundEligibility(body: InboundPackages, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundEligibility>>;
|
|
2012
|
+
/**
|
|
2013
|
+
* Confirms an AWD inbound order in `DRAFT` status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2014
|
+
* @param {string} orderId The ID of the inbound order that you want to confirm.
|
|
2015
|
+
* @param {*} [options] Override http request option.
|
|
2016
|
+
* @throws {RequiredError}
|
|
2017
|
+
*/
|
|
2018
|
+
confirmInbound(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2019
|
+
/**
|
|
2020
|
+
* Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination node. You can confirm the order only if it\'s in an`ELIGIBLE` state. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2021
|
+
* @param {string} orderId ID for the outbound order you want to confirm.
|
|
2022
|
+
* @param {*} [options] Override http request option.
|
|
2023
|
+
* @throws {RequiredError}
|
|
2024
|
+
*/
|
|
2025
|
+
confirmOutbound(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2026
|
+
/**
|
|
2027
|
+
* Confirms an AWD replenishment order in ELIGIBLE state with a set of shipments containing items that are needed to be replenished to an FBA node. Order can only be confirmed in ELIGIBLE state.
|
|
2028
|
+
* @param {string} orderId ID of the replenishment order to be confirmed.
|
|
2029
|
+
* @param {*} [options] Override http request option.
|
|
2030
|
+
* @throws {RequiredError}
|
|
2031
|
+
*/
|
|
2032
|
+
confirmReplenishmentOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2033
|
+
/**
|
|
2034
|
+
* Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2035
|
+
* @param {InboundOrderCreationData} body Payload for creating an inbound order.
|
|
2036
|
+
* @param {*} [options] Override http request option.
|
|
2037
|
+
* @throws {RequiredError}
|
|
2038
|
+
*/
|
|
2039
|
+
createInbound(body: InboundOrderCreationData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundOrderReference>>;
|
|
2040
|
+
/**
|
|
2041
|
+
* Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2042
|
+
* @param {OutboundOrderCreationData} body Payload for creating an outbound order.
|
|
2043
|
+
* @param {*} [options] Override http request option.
|
|
2044
|
+
* @throws {RequiredError}
|
|
2045
|
+
*/
|
|
2046
|
+
createOutbound(body: OutboundOrderCreationData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundOrderReference>>;
|
|
2047
|
+
/**
|
|
2048
|
+
* Creates an AWD replenishment order with given products to replenish. The API will return the order ID of the newly created order and also start an async validation check on the products to e. The order status will transition to ELIGIBLE/INELIGIBLE status from VALIDATING post validation check
|
|
2049
|
+
* @param {ReplenishmentOrderCreationData} body Payload for creating a replenishment order.
|
|
2050
|
+
* @param {*} [options] Override http request option.
|
|
2051
|
+
* @throws {RequiredError}
|
|
2052
|
+
*/
|
|
2053
|
+
createReplenishmentOrder(body: ReplenishmentOrderCreationData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReplenishmentOrderReference>>;
|
|
2054
|
+
/**
|
|
2055
|
+
* Retrieves an AWD inbound order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2056
|
+
* @param {string} orderId The ID of the inbound order that you want to retrieve.
|
|
2057
|
+
* @param {*} [options] Override http request option.
|
|
2058
|
+
* @throws {RequiredError}
|
|
2059
|
+
*/
|
|
2060
|
+
getInbound(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundOrder>>;
|
|
2061
|
+
/**
|
|
2062
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
2063
|
+
* @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded.
|
|
2064
|
+
* @param {GetInboundShipmentSkuQuantitiesEnum} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
|
|
2065
|
+
* @param {*} [options] Override http request option.
|
|
2066
|
+
* @throws {RequiredError}
|
|
2067
|
+
*/
|
|
2068
|
+
getInboundShipment(shipmentId: string, skuQuantities?: GetInboundShipmentSkuQuantitiesEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundShipment>>;
|
|
2069
|
+
/**
|
|
2070
|
+
* Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the label URL is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2071
|
+
* @param {string} shipmentId ID for the shipment.
|
|
2072
|
+
* @param {GetInboundShipmentLabelsPageTypeEnum} [pageType] Page type for the generated labels. The default is `PLAIN_PAPER`.
|
|
2073
|
+
* @param {GetInboundShipmentLabelsFormatTypeEnum} [formatType] The format type of the output file that contains your labels. The default format type is `PDF`.
|
|
2074
|
+
* @param {*} [options] Override http request option.
|
|
2075
|
+
* @throws {RequiredError}
|
|
2076
|
+
*/
|
|
2077
|
+
getInboundShipmentLabels(shipmentId: string, pageType?: GetInboundShipmentLabelsPageTypeEnum, formatType?: GetInboundShipmentLabelsFormatTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentLabels>>;
|
|
2078
|
+
/**
|
|
2079
|
+
* Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the pageTypes are available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2080
|
+
* @param {string} shipmentId ID for the shipment.
|
|
2081
|
+
* @param {*} [options] Override http request option.
|
|
2082
|
+
* @throws {RequiredError}
|
|
2083
|
+
*/
|
|
2084
|
+
getLabelPageTypes(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentLabelPageTypes>>;
|
|
2085
|
+
/**
|
|
2086
|
+
* Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination channel. If the order is not eligible, the validation errors field is included in the order response. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2087
|
+
* @param {string} orderId ID for the outbound order to be retrieved.
|
|
2088
|
+
* @param {*} [options] Override http request option.
|
|
2089
|
+
* @throws {RequiredError}
|
|
2090
|
+
*/
|
|
2091
|
+
getOutbound(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundOrder>>;
|
|
2092
|
+
/**
|
|
2093
|
+
* Retrieves an AWD Replenishment order with a set of shipments containing items that is/was planned to be replenished into an FBA node.
|
|
2094
|
+
* @param {string} orderId ID of the replenishment order to be retrieved.
|
|
2095
|
+
* @param {*} [options] Override http request option.
|
|
2096
|
+
* @throws {RequiredError}
|
|
2097
|
+
*/
|
|
2098
|
+
getReplenishmentOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReplenishmentOrder>>;
|
|
2099
|
+
/**
|
|
2100
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2101
|
+
* @param {ListInboundShipmentsSortByEnum} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT.
|
|
2102
|
+
* @param {ListInboundShipmentsSortOrderEnum} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
|
|
2103
|
+
* @param {ListInboundShipmentsShipmentStatusEnum} [shipmentStatus] Filter by inbound shipment status.
|
|
2104
|
+
* @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2105
|
+
* @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2106
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
2107
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2108
|
+
* @param {*} [options] Override http request option.
|
|
2109
|
+
* @throws {RequiredError}
|
|
2110
|
+
*/
|
|
2111
|
+
listInboundShipments(sortBy?: ListInboundShipmentsSortByEnum, sortOrder?: ListInboundShipmentsSortOrderEnum, shipmentStatus?: ListInboundShipmentsShipmentStatusEnum, updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentListing>>;
|
|
2112
|
+
/**
|
|
2113
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2114
|
+
* @param {string} [sku] Filter by seller or merchant SKU for the item.
|
|
2115
|
+
* @param {ListInventorySortOrderEnum} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
2116
|
+
* @param {ListInventoryDetailsEnum} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
|
|
2117
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2118
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
2119
|
+
* @param {*} [options] Override http request option.
|
|
2120
|
+
* @throws {RequiredError}
|
|
2121
|
+
*/
|
|
2122
|
+
listInventory(sku?: string, sortOrder?: ListInventorySortOrderEnum, details?: ListInventoryDetailsEnum, nextToken?: string, maxResults?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventoryListing>>;
|
|
2123
|
+
/**
|
|
2124
|
+
* Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are sorted by the `updatedAt` attribute in descending order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2125
|
+
* @param {string} [updatedAfter] Get the outbound orders updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2126
|
+
* @param {string} [updatedBefore] Get the outbound orders updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2127
|
+
* @param {ListOutboundsSortOrderEnum} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
2128
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
2129
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2130
|
+
* @param {*} [options] Override http request option.
|
|
2131
|
+
* @throws {RequiredError}
|
|
2132
|
+
*/
|
|
2133
|
+
listOutbounds(updatedAfter?: string, updatedBefore?: string, sortOrder?: ListOutboundsSortOrderEnum, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundListing>>;
|
|
2134
|
+
/**
|
|
2135
|
+
* Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order.
|
|
2136
|
+
* @param {string} [updatedAfter] Get the replenishment orders updated after certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.
|
|
2137
|
+
* @param {string} [updatedBefore] Get the replenishment orders updated before certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.
|
|
2138
|
+
* @param {ListReplenishmentOrdersSortOrderEnum} [sortOrder] Sort the response in ASCENDING or DESCENDING order. The default sort order is DESCENDING.
|
|
2139
|
+
* @param {number} [maxResults] Maximum results to be returned in a single response.
|
|
2140
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2141
|
+
* @param {*} [options] Override http request option.
|
|
2142
|
+
* @throws {RequiredError}
|
|
2143
|
+
*/
|
|
2144
|
+
listReplenishmentOrders(updatedAfter?: string, updatedBefore?: string, sortOrder?: ListReplenishmentOrdersSortOrderEnum, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReplenishmentOrderListing>>;
|
|
2145
|
+
/**
|
|
2146
|
+
* Updates an AWD inbound order that is in `DRAFT` status and not yet confirmed. Use this operation to update the `packagesToInbound`, `originAddress` and `preferences` attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2147
|
+
* @param {string} orderId The ID of the inbound order that you want to update.
|
|
2148
|
+
* @param {InboundOrder} body Represents an AWD inbound order.
|
|
2149
|
+
* @param {*} [options] Override http request option.
|
|
2150
|
+
* @throws {RequiredError}
|
|
2151
|
+
*/
|
|
2152
|
+
updateInbound(orderId: string, body: InboundOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2153
|
+
/**
|
|
2154
|
+
* Updates transport details for an AWD shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2155
|
+
* @param {string} shipmentId The shipment ID.
|
|
2156
|
+
* @param {TransportationDetails} body Transportation details for the shipment.
|
|
2157
|
+
* @param {*} [options] Override http request option.
|
|
2158
|
+
* @throws {RequiredError}
|
|
2159
|
+
*/
|
|
2160
|
+
updateInboundShipmentTransportDetails(shipmentId: string, body: TransportationDetails, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2161
|
+
/**
|
|
2162
|
+
* Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on `productsToOutbound` and `orderPreferences` attributes only. Any updates will restart the outbound order validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2163
|
+
* @param {string} orderId ID for the outbound order to be updated.
|
|
2164
|
+
* @param {OutboundOrder} body Represents an AWD outbound order.
|
|
2165
|
+
* @param {*} [options] Override http request option.
|
|
2166
|
+
* @throws {RequiredError}
|
|
2167
|
+
*/
|
|
2168
|
+
updateOutbound(orderId: string, body: OutboundOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundOrderReference>>;
|
|
2570
2169
|
};
|
|
2571
2170
|
/**
|
|
2572
2171
|
* AmazonWarehousingAndDistributionApi - factory interface
|
|
2573
2172
|
*/
|
|
2574
2173
|
declare const AmazonWarehousingAndDistributionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
|
|
2586
|
-
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
|
|
2590
|
-
|
|
2591
|
-
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
|
|
2595
|
-
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
|
|
2613
|
-
|
|
2614
|
-
|
|
2615
|
-
|
|
2616
|
-
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
|
|
2669
|
-
|
|
2670
|
-
|
|
2671
|
-
|
|
2672
|
-
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
|
|
2685
|
-
|
|
2686
|
-
|
|
2687
|
-
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
|
|
2692
|
-
|
|
2693
|
-
|
|
2694
|
-
|
|
2695
|
-
|
|
2696
|
-
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2174
|
+
/**
|
|
2175
|
+
* Cancels an AWD Inbound order and its associated shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2176
|
+
* @param {AmazonWarehousingAndDistributionApiCancelInboundRequest} requestParameters Request parameters.
|
|
2177
|
+
* @param {*} [options] Override http request option.
|
|
2178
|
+
* @throws {RequiredError}
|
|
2179
|
+
*/
|
|
2180
|
+
cancelInbound(requestParameters: AmazonWarehousingAndDistributionApiCancelInboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2181
|
+
/**
|
|
2182
|
+
* Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2183
|
+
* @param {AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest} requestParameters Request parameters.
|
|
2184
|
+
* @param {*} [options] Override http request option.
|
|
2185
|
+
* @throws {RequiredError}
|
|
2186
|
+
*/
|
|
2187
|
+
checkInboundEligibility(requestParameters: AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundEligibility>;
|
|
2188
|
+
/**
|
|
2189
|
+
* Confirms an AWD inbound order in `DRAFT` status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2190
|
+
* @param {AmazonWarehousingAndDistributionApiConfirmInboundRequest} requestParameters Request parameters.
|
|
2191
|
+
* @param {*} [options] Override http request option.
|
|
2192
|
+
* @throws {RequiredError}
|
|
2193
|
+
*/
|
|
2194
|
+
confirmInbound(requestParameters: AmazonWarehousingAndDistributionApiConfirmInboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2195
|
+
/**
|
|
2196
|
+
* Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination node. You can confirm the order only if it\'s in an`ELIGIBLE` state. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2197
|
+
* @param {AmazonWarehousingAndDistributionApiConfirmOutboundRequest} requestParameters Request parameters.
|
|
2198
|
+
* @param {*} [options] Override http request option.
|
|
2199
|
+
* @throws {RequiredError}
|
|
2200
|
+
*/
|
|
2201
|
+
confirmOutbound(requestParameters: AmazonWarehousingAndDistributionApiConfirmOutboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2202
|
+
/**
|
|
2203
|
+
* Confirms an AWD replenishment order in ELIGIBLE state with a set of shipments containing items that are needed to be replenished to an FBA node. Order can only be confirmed in ELIGIBLE state.
|
|
2204
|
+
* @param {AmazonWarehousingAndDistributionApiConfirmReplenishmentOrderRequest} requestParameters Request parameters.
|
|
2205
|
+
* @param {*} [options] Override http request option.
|
|
2206
|
+
* @throws {RequiredError}
|
|
2207
|
+
*/
|
|
2208
|
+
confirmReplenishmentOrder(requestParameters: AmazonWarehousingAndDistributionApiConfirmReplenishmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2209
|
+
/**
|
|
2210
|
+
* Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2211
|
+
* @param {AmazonWarehousingAndDistributionApiCreateInboundRequest} requestParameters Request parameters.
|
|
2212
|
+
* @param {*} [options] Override http request option.
|
|
2213
|
+
* @throws {RequiredError}
|
|
2214
|
+
*/
|
|
2215
|
+
createInbound(requestParameters: AmazonWarehousingAndDistributionApiCreateInboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundOrderReference>;
|
|
2216
|
+
/**
|
|
2217
|
+
* Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2218
|
+
* @param {AmazonWarehousingAndDistributionApiCreateOutboundRequest} requestParameters Request parameters.
|
|
2219
|
+
* @param {*} [options] Override http request option.
|
|
2220
|
+
* @throws {RequiredError}
|
|
2221
|
+
*/
|
|
2222
|
+
createOutbound(requestParameters: AmazonWarehousingAndDistributionApiCreateOutboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<OutboundOrderReference>;
|
|
2223
|
+
/**
|
|
2224
|
+
* Creates an AWD replenishment order with given products to replenish. The API will return the order ID of the newly created order and also start an async validation check on the products to e. The order status will transition to ELIGIBLE/INELIGIBLE status from VALIDATING post validation check
|
|
2225
|
+
* @param {AmazonWarehousingAndDistributionApiCreateReplenishmentOrderRequest} requestParameters Request parameters.
|
|
2226
|
+
* @param {*} [options] Override http request option.
|
|
2227
|
+
* @throws {RequiredError}
|
|
2228
|
+
*/
|
|
2229
|
+
createReplenishmentOrder(requestParameters: AmazonWarehousingAndDistributionApiCreateReplenishmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReplenishmentOrderReference>;
|
|
2230
|
+
/**
|
|
2231
|
+
* Retrieves an AWD inbound order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2232
|
+
* @param {AmazonWarehousingAndDistributionApiGetInboundRequest} requestParameters Request parameters.
|
|
2233
|
+
* @param {*} [options] Override http request option.
|
|
2234
|
+
* @throws {RequiredError}
|
|
2235
|
+
*/
|
|
2236
|
+
getInbound(requestParameters: AmazonWarehousingAndDistributionApiGetInboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundOrder>;
|
|
2237
|
+
/**
|
|
2238
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
2239
|
+
* @param {AmazonWarehousingAndDistributionApiGetInboundShipmentRequest} requestParameters Request parameters.
|
|
2240
|
+
* @param {*} [options] Override http request option.
|
|
2241
|
+
* @throws {RequiredError}
|
|
2242
|
+
*/
|
|
2243
|
+
getInboundShipment(requestParameters: AmazonWarehousingAndDistributionApiGetInboundShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundShipment>;
|
|
2244
|
+
/**
|
|
2245
|
+
* Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the label URL is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2246
|
+
* @param {AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest} requestParameters Request parameters.
|
|
2247
|
+
* @param {*} [options] Override http request option.
|
|
2248
|
+
* @throws {RequiredError}
|
|
2249
|
+
*/
|
|
2250
|
+
getInboundShipmentLabels(requestParameters: AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentLabels>;
|
|
2251
|
+
/**
|
|
2252
|
+
* Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the pageTypes are available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2253
|
+
* @param {AmazonWarehousingAndDistributionApiGetLabelPageTypesRequest} requestParameters Request parameters.
|
|
2254
|
+
* @param {*} [options] Override http request option.
|
|
2255
|
+
* @throws {RequiredError}
|
|
2256
|
+
*/
|
|
2257
|
+
getLabelPageTypes(requestParameters: AmazonWarehousingAndDistributionApiGetLabelPageTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentLabelPageTypes>;
|
|
2258
|
+
/**
|
|
2259
|
+
* Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination channel. If the order is not eligible, the validation errors field is included in the order response. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2260
|
+
* @param {AmazonWarehousingAndDistributionApiGetOutboundRequest} requestParameters Request parameters.
|
|
2261
|
+
* @param {*} [options] Override http request option.
|
|
2262
|
+
* @throws {RequiredError}
|
|
2263
|
+
*/
|
|
2264
|
+
getOutbound(requestParameters: AmazonWarehousingAndDistributionApiGetOutboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<OutboundOrder>;
|
|
2265
|
+
/**
|
|
2266
|
+
* Retrieves an AWD Replenishment order with a set of shipments containing items that is/was planned to be replenished into an FBA node.
|
|
2267
|
+
* @param {AmazonWarehousingAndDistributionApiGetReplenishmentOrderRequest} requestParameters Request parameters.
|
|
2268
|
+
* @param {*} [options] Override http request option.
|
|
2269
|
+
* @throws {RequiredError}
|
|
2270
|
+
*/
|
|
2271
|
+
getReplenishmentOrder(requestParameters: AmazonWarehousingAndDistributionApiGetReplenishmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReplenishmentOrder>;
|
|
2272
|
+
/**
|
|
2273
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2274
|
+
* @param {AmazonWarehousingAndDistributionApiListInboundShipmentsRequest} requestParameters Request parameters.
|
|
2275
|
+
* @param {*} [options] Override http request option.
|
|
2276
|
+
* @throws {RequiredError}
|
|
2277
|
+
*/
|
|
2278
|
+
listInboundShipments(requestParameters?: AmazonWarehousingAndDistributionApiListInboundShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentListing>;
|
|
2279
|
+
/**
|
|
2280
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2281
|
+
* @param {AmazonWarehousingAndDistributionApiListInventoryRequest} requestParameters Request parameters.
|
|
2282
|
+
* @param {*} [options] Override http request option.
|
|
2283
|
+
* @throws {RequiredError}
|
|
2284
|
+
*/
|
|
2285
|
+
listInventory(requestParameters?: AmazonWarehousingAndDistributionApiListInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<InventoryListing>;
|
|
2286
|
+
/**
|
|
2287
|
+
* Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are sorted by the `updatedAt` attribute in descending order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2288
|
+
* @param {AmazonWarehousingAndDistributionApiListOutboundsRequest} requestParameters Request parameters.
|
|
2289
|
+
* @param {*} [options] Override http request option.
|
|
2290
|
+
* @throws {RequiredError}
|
|
2291
|
+
*/
|
|
2292
|
+
listOutbounds(requestParameters?: AmazonWarehousingAndDistributionApiListOutboundsRequest, options?: RawAxiosRequestConfig): AxiosPromise<OutboundListing>;
|
|
2293
|
+
/**
|
|
2294
|
+
* Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order.
|
|
2295
|
+
* @param {AmazonWarehousingAndDistributionApiListReplenishmentOrdersRequest} requestParameters Request parameters.
|
|
2296
|
+
* @param {*} [options] Override http request option.
|
|
2297
|
+
* @throws {RequiredError}
|
|
2298
|
+
*/
|
|
2299
|
+
listReplenishmentOrders(requestParameters?: AmazonWarehousingAndDistributionApiListReplenishmentOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReplenishmentOrderListing>;
|
|
2300
|
+
/**
|
|
2301
|
+
* Updates an AWD inbound order that is in `DRAFT` status and not yet confirmed. Use this operation to update the `packagesToInbound`, `originAddress` and `preferences` attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2302
|
+
* @param {AmazonWarehousingAndDistributionApiUpdateInboundRequest} requestParameters Request parameters.
|
|
2303
|
+
* @param {*} [options] Override http request option.
|
|
2304
|
+
* @throws {RequiredError}
|
|
2305
|
+
*/
|
|
2306
|
+
updateInbound(requestParameters: AmazonWarehousingAndDistributionApiUpdateInboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2307
|
+
/**
|
|
2308
|
+
* Updates transport details for an AWD shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2309
|
+
* @param {AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest} requestParameters Request parameters.
|
|
2310
|
+
* @param {*} [options] Override http request option.
|
|
2311
|
+
* @throws {RequiredError}
|
|
2312
|
+
*/
|
|
2313
|
+
updateInboundShipmentTransportDetails(requestParameters: AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2314
|
+
/**
|
|
2315
|
+
* Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on `productsToOutbound` and `orderPreferences` attributes only. Any updates will restart the outbound order validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2316
|
+
* @param {AmazonWarehousingAndDistributionApiUpdateOutboundRequest} requestParameters Request parameters.
|
|
2317
|
+
* @param {*} [options] Override http request option.
|
|
2318
|
+
* @throws {RequiredError}
|
|
2319
|
+
*/
|
|
2320
|
+
updateOutbound(requestParameters: AmazonWarehousingAndDistributionApiUpdateOutboundRequest, options?: RawAxiosRequestConfig): AxiosPromise<OutboundOrderReference>;
|
|
2722
2321
|
};
|
|
2723
2322
|
/**
|
|
2724
2323
|
* Request parameters for cancelInbound operation in AmazonWarehousingAndDistributionApi.
|
|
2725
2324
|
*/
|
|
2726
2325
|
interface AmazonWarehousingAndDistributionApiCancelInboundRequest {
|
|
2727
|
-
|
|
2728
|
-
|
|
2729
|
-
|
|
2730
|
-
|
|
2326
|
+
/**
|
|
2327
|
+
* The ID of the inbound order you want to cancel.
|
|
2328
|
+
*/
|
|
2329
|
+
readonly orderId: string;
|
|
2731
2330
|
}
|
|
2732
2331
|
/**
|
|
2733
2332
|
* Request parameters for checkInboundEligibility operation in AmazonWarehousingAndDistributionApi.
|
|
2734
2333
|
*/
|
|
2735
2334
|
interface AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest {
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
|
|
2335
|
+
/**
|
|
2336
|
+
* Represents the packages you want to inbound.
|
|
2337
|
+
*/
|
|
2338
|
+
readonly body: InboundPackages;
|
|
2740
2339
|
}
|
|
2741
2340
|
/**
|
|
2742
2341
|
* Request parameters for confirmInbound operation in AmazonWarehousingAndDistributionApi.
|
|
2743
2342
|
*/
|
|
2744
2343
|
interface AmazonWarehousingAndDistributionApiConfirmInboundRequest {
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2344
|
+
/**
|
|
2345
|
+
* The ID of the inbound order that you want to confirm.
|
|
2346
|
+
*/
|
|
2347
|
+
readonly orderId: string;
|
|
2749
2348
|
}
|
|
2750
2349
|
/**
|
|
2751
2350
|
* Request parameters for confirmOutbound operation in AmazonWarehousingAndDistributionApi.
|
|
2752
2351
|
*/
|
|
2753
2352
|
interface AmazonWarehousingAndDistributionApiConfirmOutboundRequest {
|
|
2754
|
-
|
|
2755
|
-
|
|
2756
|
-
|
|
2757
|
-
|
|
2353
|
+
/**
|
|
2354
|
+
* ID for the outbound order you want to confirm.
|
|
2355
|
+
*/
|
|
2356
|
+
readonly orderId: string;
|
|
2758
2357
|
}
|
|
2759
2358
|
/**
|
|
2760
2359
|
* Request parameters for confirmReplenishmentOrder operation in AmazonWarehousingAndDistributionApi.
|
|
2761
2360
|
*/
|
|
2762
2361
|
interface AmazonWarehousingAndDistributionApiConfirmReplenishmentOrderRequest {
|
|
2763
|
-
|
|
2764
|
-
|
|
2765
|
-
|
|
2766
|
-
|
|
2362
|
+
/**
|
|
2363
|
+
* ID of the replenishment order to be confirmed.
|
|
2364
|
+
*/
|
|
2365
|
+
readonly orderId: string;
|
|
2767
2366
|
}
|
|
2768
2367
|
/**
|
|
2769
2368
|
* Request parameters for createInbound operation in AmazonWarehousingAndDistributionApi.
|
|
2770
2369
|
*/
|
|
2771
2370
|
interface AmazonWarehousingAndDistributionApiCreateInboundRequest {
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2371
|
+
/**
|
|
2372
|
+
* Payload for creating an inbound order.
|
|
2373
|
+
*/
|
|
2374
|
+
readonly body: InboundOrderCreationData;
|
|
2776
2375
|
}
|
|
2777
2376
|
/**
|
|
2778
2377
|
* Request parameters for createOutbound operation in AmazonWarehousingAndDistributionApi.
|
|
2779
2378
|
*/
|
|
2780
2379
|
interface AmazonWarehousingAndDistributionApiCreateOutboundRequest {
|
|
2781
|
-
|
|
2782
|
-
|
|
2783
|
-
|
|
2784
|
-
|
|
2380
|
+
/**
|
|
2381
|
+
* Payload for creating an outbound order.
|
|
2382
|
+
*/
|
|
2383
|
+
readonly body: OutboundOrderCreationData;
|
|
2785
2384
|
}
|
|
2786
2385
|
/**
|
|
2787
2386
|
* Request parameters for createReplenishmentOrder operation in AmazonWarehousingAndDistributionApi.
|
|
2788
2387
|
*/
|
|
2789
2388
|
interface AmazonWarehousingAndDistributionApiCreateReplenishmentOrderRequest {
|
|
2790
|
-
|
|
2791
|
-
|
|
2792
|
-
|
|
2793
|
-
|
|
2389
|
+
/**
|
|
2390
|
+
* Payload for creating a replenishment order.
|
|
2391
|
+
*/
|
|
2392
|
+
readonly body: ReplenishmentOrderCreationData;
|
|
2794
2393
|
}
|
|
2795
2394
|
/**
|
|
2796
2395
|
* Request parameters for getInbound operation in AmazonWarehousingAndDistributionApi.
|
|
2797
2396
|
*/
|
|
2798
2397
|
interface AmazonWarehousingAndDistributionApiGetInboundRequest {
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2398
|
+
/**
|
|
2399
|
+
* The ID of the inbound order that you want to retrieve.
|
|
2400
|
+
*/
|
|
2401
|
+
readonly orderId: string;
|
|
2803
2402
|
}
|
|
2804
2403
|
/**
|
|
2805
2404
|
* Request parameters for getInboundShipment operation in AmazonWarehousingAndDistributionApi.
|
|
2806
2405
|
*/
|
|
2807
2406
|
interface AmazonWarehousingAndDistributionApiGetInboundShipmentRequest {
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
|
|
2407
|
+
/**
|
|
2408
|
+
* ID for the shipment. A shipment contains the cases being inbounded.
|
|
2409
|
+
*/
|
|
2410
|
+
readonly shipmentId: string;
|
|
2411
|
+
/**
|
|
2412
|
+
* If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
|
|
2413
|
+
*/
|
|
2414
|
+
readonly skuQuantities?: GetInboundShipmentSkuQuantitiesEnum;
|
|
2816
2415
|
}
|
|
2817
2416
|
/**
|
|
2818
2417
|
* Request parameters for getInboundShipmentLabels operation in AmazonWarehousingAndDistributionApi.
|
|
2819
2418
|
*/
|
|
2820
2419
|
interface AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest {
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2420
|
+
/**
|
|
2421
|
+
* ID for the shipment.
|
|
2422
|
+
*/
|
|
2423
|
+
readonly shipmentId: string;
|
|
2424
|
+
/**
|
|
2425
|
+
* Page type for the generated labels. The default is `PLAIN_PAPER`.
|
|
2426
|
+
*/
|
|
2427
|
+
readonly pageType?: GetInboundShipmentLabelsPageTypeEnum;
|
|
2428
|
+
/**
|
|
2429
|
+
* The format type of the output file that contains your labels. The default format type is `PDF`.
|
|
2430
|
+
*/
|
|
2431
|
+
readonly formatType?: GetInboundShipmentLabelsFormatTypeEnum;
|
|
2833
2432
|
}
|
|
2834
2433
|
/**
|
|
2835
2434
|
* Request parameters for getLabelPageTypes operation in AmazonWarehousingAndDistributionApi.
|
|
2836
2435
|
*/
|
|
2837
2436
|
interface AmazonWarehousingAndDistributionApiGetLabelPageTypesRequest {
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2437
|
+
/**
|
|
2438
|
+
* ID for the shipment.
|
|
2439
|
+
*/
|
|
2440
|
+
readonly shipmentId: string;
|
|
2842
2441
|
}
|
|
2843
2442
|
/**
|
|
2844
2443
|
* Request parameters for getOutbound operation in AmazonWarehousingAndDistributionApi.
|
|
2845
2444
|
*/
|
|
2846
2445
|
interface AmazonWarehousingAndDistributionApiGetOutboundRequest {
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
|
|
2446
|
+
/**
|
|
2447
|
+
* ID for the outbound order to be retrieved.
|
|
2448
|
+
*/
|
|
2449
|
+
readonly orderId: string;
|
|
2851
2450
|
}
|
|
2852
2451
|
/**
|
|
2853
2452
|
* Request parameters for getReplenishmentOrder operation in AmazonWarehousingAndDistributionApi.
|
|
2854
2453
|
*/
|
|
2855
2454
|
interface AmazonWarehousingAndDistributionApiGetReplenishmentOrderRequest {
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2455
|
+
/**
|
|
2456
|
+
* ID of the replenishment order to be retrieved.
|
|
2457
|
+
*/
|
|
2458
|
+
readonly orderId: string;
|
|
2860
2459
|
}
|
|
2861
2460
|
/**
|
|
2862
2461
|
* Request parameters for listInboundShipments operation in AmazonWarehousingAndDistributionApi.
|
|
2863
2462
|
*/
|
|
2864
2463
|
interface AmazonWarehousingAndDistributionApiListInboundShipmentsRequest {
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
|
-
|
|
2464
|
+
/**
|
|
2465
|
+
* Field to sort results by. By default, the response will be sorted by UPDATED_AT.
|
|
2466
|
+
*/
|
|
2467
|
+
readonly sortBy?: ListInboundShipmentsSortByEnum;
|
|
2468
|
+
/**
|
|
2469
|
+
* Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
|
|
2470
|
+
*/
|
|
2471
|
+
readonly sortOrder?: ListInboundShipmentsSortOrderEnum;
|
|
2472
|
+
/**
|
|
2473
|
+
* Filter by inbound shipment status.
|
|
2474
|
+
*/
|
|
2475
|
+
readonly shipmentStatus?: ListInboundShipmentsShipmentStatusEnum;
|
|
2476
|
+
/**
|
|
2477
|
+
* List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2478
|
+
*/
|
|
2479
|
+
readonly updatedAfter?: string;
|
|
2480
|
+
/**
|
|
2481
|
+
* List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2482
|
+
*/
|
|
2483
|
+
readonly updatedBefore?: string;
|
|
2484
|
+
/**
|
|
2485
|
+
* Maximum number of results to return.
|
|
2486
|
+
*/
|
|
2487
|
+
readonly maxResults?: number;
|
|
2488
|
+
/**
|
|
2489
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2490
|
+
*/
|
|
2491
|
+
readonly nextToken?: string;
|
|
2893
2492
|
}
|
|
2894
2493
|
/**
|
|
2895
2494
|
* Request parameters for listInventory operation in AmazonWarehousingAndDistributionApi.
|
|
2896
2495
|
*/
|
|
2897
2496
|
interface AmazonWarehousingAndDistributionApiListInventoryRequest {
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2497
|
+
/**
|
|
2498
|
+
* Filter by seller or merchant SKU for the item.
|
|
2499
|
+
*/
|
|
2500
|
+
readonly sku?: string;
|
|
2501
|
+
/**
|
|
2502
|
+
* Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
2503
|
+
*/
|
|
2504
|
+
readonly sortOrder?: ListInventorySortOrderEnum;
|
|
2505
|
+
/**
|
|
2506
|
+
* Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
|
|
2507
|
+
*/
|
|
2508
|
+
readonly details?: ListInventoryDetailsEnum;
|
|
2509
|
+
/**
|
|
2510
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2511
|
+
*/
|
|
2512
|
+
readonly nextToken?: string;
|
|
2513
|
+
/**
|
|
2514
|
+
* Maximum number of results to return.
|
|
2515
|
+
*/
|
|
2516
|
+
readonly maxResults?: number;
|
|
2918
2517
|
}
|
|
2919
2518
|
/**
|
|
2920
2519
|
* Request parameters for listOutbounds operation in AmazonWarehousingAndDistributionApi.
|
|
2921
2520
|
*/
|
|
2922
2521
|
interface AmazonWarehousingAndDistributionApiListOutboundsRequest {
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
|
|
2937
|
-
|
|
2938
|
-
|
|
2939
|
-
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
|
|
2522
|
+
/**
|
|
2523
|
+
* Get the outbound orders updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2524
|
+
*/
|
|
2525
|
+
readonly updatedAfter?: string;
|
|
2526
|
+
/**
|
|
2527
|
+
* Get the outbound orders updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
2528
|
+
*/
|
|
2529
|
+
readonly updatedBefore?: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
2532
|
+
*/
|
|
2533
|
+
readonly sortOrder?: ListOutboundsSortOrderEnum;
|
|
2534
|
+
/**
|
|
2535
|
+
* Maximum number of results to return.
|
|
2536
|
+
*/
|
|
2537
|
+
readonly maxResults?: number;
|
|
2538
|
+
/**
|
|
2539
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2540
|
+
*/
|
|
2541
|
+
readonly nextToken?: string;
|
|
2943
2542
|
}
|
|
2944
2543
|
/**
|
|
2945
2544
|
* Request parameters for listReplenishmentOrders operation in AmazonWarehousingAndDistributionApi.
|
|
2946
2545
|
*/
|
|
2947
2546
|
interface AmazonWarehousingAndDistributionApiListReplenishmentOrdersRequest {
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
|
|
2958
|
-
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
2967
|
-
|
|
2547
|
+
/**
|
|
2548
|
+
* Get the replenishment orders updated after certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.
|
|
2549
|
+
*/
|
|
2550
|
+
readonly updatedAfter?: string;
|
|
2551
|
+
/**
|
|
2552
|
+
* Get the replenishment orders updated before certain time (Inclusive) Date should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.
|
|
2553
|
+
*/
|
|
2554
|
+
readonly updatedBefore?: string;
|
|
2555
|
+
/**
|
|
2556
|
+
* Sort the response in ASCENDING or DESCENDING order. The default sort order is DESCENDING.
|
|
2557
|
+
*/
|
|
2558
|
+
readonly sortOrder?: ListReplenishmentOrdersSortOrderEnum;
|
|
2559
|
+
/**
|
|
2560
|
+
* Maximum results to be returned in a single response.
|
|
2561
|
+
*/
|
|
2562
|
+
readonly maxResults?: number;
|
|
2563
|
+
/**
|
|
2564
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
2565
|
+
*/
|
|
2566
|
+
readonly nextToken?: string;
|
|
2968
2567
|
}
|
|
2969
2568
|
/**
|
|
2970
2569
|
* Request parameters for updateInbound operation in AmazonWarehousingAndDistributionApi.
|
|
2971
2570
|
*/
|
|
2972
2571
|
interface AmazonWarehousingAndDistributionApiUpdateInboundRequest {
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2572
|
+
/**
|
|
2573
|
+
* The ID of the inbound order that you want to update.
|
|
2574
|
+
*/
|
|
2575
|
+
readonly orderId: string;
|
|
2576
|
+
/**
|
|
2577
|
+
* Represents an AWD inbound order.
|
|
2578
|
+
*/
|
|
2579
|
+
readonly body: InboundOrder;
|
|
2981
2580
|
}
|
|
2982
2581
|
/**
|
|
2983
2582
|
* Request parameters for updateInboundShipmentTransportDetails operation in AmazonWarehousingAndDistributionApi.
|
|
2984
2583
|
*/
|
|
2985
2584
|
interface AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest {
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2585
|
+
/**
|
|
2586
|
+
* The shipment ID.
|
|
2587
|
+
*/
|
|
2588
|
+
readonly shipmentId: string;
|
|
2589
|
+
/**
|
|
2590
|
+
* Transportation details for the shipment.
|
|
2591
|
+
*/
|
|
2592
|
+
readonly body: TransportationDetails;
|
|
2994
2593
|
}
|
|
2995
2594
|
/**
|
|
2996
2595
|
* Request parameters for updateOutbound operation in AmazonWarehousingAndDistributionApi.
|
|
2997
2596
|
*/
|
|
2998
2597
|
interface AmazonWarehousingAndDistributionApiUpdateOutboundRequest {
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
2598
|
+
/**
|
|
2599
|
+
* ID for the outbound order to be updated.
|
|
2600
|
+
*/
|
|
2601
|
+
readonly orderId: string;
|
|
2602
|
+
/**
|
|
2603
|
+
* Represents an AWD outbound order.
|
|
2604
|
+
*/
|
|
2605
|
+
readonly body: OutboundOrder;
|
|
3007
2606
|
}
|
|
3008
2607
|
/**
|
|
3009
2608
|
* AmazonWarehousingAndDistributionApi - object-oriented interface
|
|
3010
2609
|
*/
|
|
3011
2610
|
declare class AmazonWarehousingAndDistributionApi extends BaseAPI {
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
|
|
3089
|
-
|
|
3090
|
-
|
|
3091
|
-
|
|
3092
|
-
|
|
3093
|
-
|
|
3094
|
-
|
|
3095
|
-
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
|
|
3103
|
-
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3111
|
-
|
|
3112
|
-
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
|
|
3131
|
-
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
2611
|
+
/**
|
|
2612
|
+
* Cancels an AWD Inbound order and its associated shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2613
|
+
* @param {AmazonWarehousingAndDistributionApiCancelInboundRequest} requestParameters Request parameters.
|
|
2614
|
+
* @param {*} [options] Override http request option.
|
|
2615
|
+
* @throws {RequiredError}
|
|
2616
|
+
*/
|
|
2617
|
+
cancelInbound(requestParameters: AmazonWarehousingAndDistributionApiCancelInboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2618
|
+
/**
|
|
2619
|
+
* Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2620
|
+
* @param {AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest} requestParameters Request parameters.
|
|
2621
|
+
* @param {*} [options] Override http request option.
|
|
2622
|
+
* @throws {RequiredError}
|
|
2623
|
+
*/
|
|
2624
|
+
checkInboundEligibility(requestParameters: AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundEligibility, any, {}>>;
|
|
2625
|
+
/**
|
|
2626
|
+
* Confirms an AWD inbound order in `DRAFT` status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2627
|
+
* @param {AmazonWarehousingAndDistributionApiConfirmInboundRequest} requestParameters Request parameters.
|
|
2628
|
+
* @param {*} [options] Override http request option.
|
|
2629
|
+
* @throws {RequiredError}
|
|
2630
|
+
*/
|
|
2631
|
+
confirmInbound(requestParameters: AmazonWarehousingAndDistributionApiConfirmInboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2632
|
+
/**
|
|
2633
|
+
* Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination node. You can confirm the order only if it\'s in an`ELIGIBLE` state. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2634
|
+
* @param {AmazonWarehousingAndDistributionApiConfirmOutboundRequest} requestParameters Request parameters.
|
|
2635
|
+
* @param {*} [options] Override http request option.
|
|
2636
|
+
* @throws {RequiredError}
|
|
2637
|
+
*/
|
|
2638
|
+
confirmOutbound(requestParameters: AmazonWarehousingAndDistributionApiConfirmOutboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2639
|
+
/**
|
|
2640
|
+
* Confirms an AWD replenishment order in ELIGIBLE state with a set of shipments containing items that are needed to be replenished to an FBA node. Order can only be confirmed in ELIGIBLE state.
|
|
2641
|
+
* @param {AmazonWarehousingAndDistributionApiConfirmReplenishmentOrderRequest} requestParameters Request parameters.
|
|
2642
|
+
* @param {*} [options] Override http request option.
|
|
2643
|
+
* @throws {RequiredError}
|
|
2644
|
+
*/
|
|
2645
|
+
confirmReplenishmentOrder(requestParameters: AmazonWarehousingAndDistributionApiConfirmReplenishmentOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2646
|
+
/**
|
|
2647
|
+
* Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2648
|
+
* @param {AmazonWarehousingAndDistributionApiCreateInboundRequest} requestParameters Request parameters.
|
|
2649
|
+
* @param {*} [options] Override http request option.
|
|
2650
|
+
* @throws {RequiredError}
|
|
2651
|
+
*/
|
|
2652
|
+
createInbound(requestParameters: AmazonWarehousingAndDistributionApiCreateInboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundOrderReference, any, {}>>;
|
|
2653
|
+
/**
|
|
2654
|
+
* Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2655
|
+
* @param {AmazonWarehousingAndDistributionApiCreateOutboundRequest} requestParameters Request parameters.
|
|
2656
|
+
* @param {*} [options] Override http request option.
|
|
2657
|
+
* @throws {RequiredError}
|
|
2658
|
+
*/
|
|
2659
|
+
createOutbound(requestParameters: AmazonWarehousingAndDistributionApiCreateOutboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundOrderReference, any, {}>>;
|
|
2660
|
+
/**
|
|
2661
|
+
* Creates an AWD replenishment order with given products to replenish. The API will return the order ID of the newly created order and also start an async validation check on the products to e. The order status will transition to ELIGIBLE/INELIGIBLE status from VALIDATING post validation check
|
|
2662
|
+
* @param {AmazonWarehousingAndDistributionApiCreateReplenishmentOrderRequest} requestParameters Request parameters.
|
|
2663
|
+
* @param {*} [options] Override http request option.
|
|
2664
|
+
* @throws {RequiredError}
|
|
2665
|
+
*/
|
|
2666
|
+
createReplenishmentOrder(requestParameters: AmazonWarehousingAndDistributionApiCreateReplenishmentOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReplenishmentOrderReference, any, {}>>;
|
|
2667
|
+
/**
|
|
2668
|
+
* Retrieves an AWD inbound order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2669
|
+
* @param {AmazonWarehousingAndDistributionApiGetInboundRequest} requestParameters Request parameters.
|
|
2670
|
+
* @param {*} [options] Override http request option.
|
|
2671
|
+
* @throws {RequiredError}
|
|
2672
|
+
*/
|
|
2673
|
+
getInbound(requestParameters: AmazonWarehousingAndDistributionApiGetInboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundOrder, any, {}>>;
|
|
2674
|
+
/**
|
|
2675
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
2676
|
+
* @param {AmazonWarehousingAndDistributionApiGetInboundShipmentRequest} requestParameters Request parameters.
|
|
2677
|
+
* @param {*} [options] Override http request option.
|
|
2678
|
+
* @throws {RequiredError}
|
|
2679
|
+
*/
|
|
2680
|
+
getInboundShipment(requestParameters: AmazonWarehousingAndDistributionApiGetInboundShipmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundShipment, any, {}>>;
|
|
2681
|
+
/**
|
|
2682
|
+
* Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the label URL is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2683
|
+
* @param {AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest} requestParameters Request parameters.
|
|
2684
|
+
* @param {*} [options] Override http request option.
|
|
2685
|
+
* @throws {RequiredError}
|
|
2686
|
+
*/
|
|
2687
|
+
getInboundShipmentLabels(requestParameters: AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentLabels, any, {}>>;
|
|
2688
|
+
/**
|
|
2689
|
+
* Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the pageTypes are available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2690
|
+
* @param {AmazonWarehousingAndDistributionApiGetLabelPageTypesRequest} requestParameters Request parameters.
|
|
2691
|
+
* @param {*} [options] Override http request option.
|
|
2692
|
+
* @throws {RequiredError}
|
|
2693
|
+
*/
|
|
2694
|
+
getLabelPageTypes(requestParameters: AmazonWarehousingAndDistributionApiGetLabelPageTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentLabelPageTypes, any, {}>>;
|
|
2695
|
+
/**
|
|
2696
|
+
* Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination channel. If the order is not eligible, the validation errors field is included in the order response. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2697
|
+
* @param {AmazonWarehousingAndDistributionApiGetOutboundRequest} requestParameters Request parameters.
|
|
2698
|
+
* @param {*} [options] Override http request option.
|
|
2699
|
+
* @throws {RequiredError}
|
|
2700
|
+
*/
|
|
2701
|
+
getOutbound(requestParameters: AmazonWarehousingAndDistributionApiGetOutboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundOrder, any, {}>>;
|
|
2702
|
+
/**
|
|
2703
|
+
* Retrieves an AWD Replenishment order with a set of shipments containing items that is/was planned to be replenished into an FBA node.
|
|
2704
|
+
* @param {AmazonWarehousingAndDistributionApiGetReplenishmentOrderRequest} requestParameters Request parameters.
|
|
2705
|
+
* @param {*} [options] Override http request option.
|
|
2706
|
+
* @throws {RequiredError}
|
|
2707
|
+
*/
|
|
2708
|
+
getReplenishmentOrder(requestParameters: AmazonWarehousingAndDistributionApiGetReplenishmentOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReplenishmentOrder, any, {}>>;
|
|
2709
|
+
/**
|
|
2710
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2711
|
+
* @param {AmazonWarehousingAndDistributionApiListInboundShipmentsRequest} requestParameters Request parameters.
|
|
2712
|
+
* @param {*} [options] Override http request option.
|
|
2713
|
+
* @throws {RequiredError}
|
|
2714
|
+
*/
|
|
2715
|
+
listInboundShipments(requestParameters?: AmazonWarehousingAndDistributionApiListInboundShipmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentListing, any, {}>>;
|
|
2716
|
+
/**
|
|
2717
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2718
|
+
* @param {AmazonWarehousingAndDistributionApiListInventoryRequest} requestParameters Request parameters.
|
|
2719
|
+
* @param {*} [options] Override http request option.
|
|
2720
|
+
* @throws {RequiredError}
|
|
2721
|
+
*/
|
|
2722
|
+
listInventory(requestParameters?: AmazonWarehousingAndDistributionApiListInventoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InventoryListing, any, {}>>;
|
|
2723
|
+
/**
|
|
2724
|
+
* Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are sorted by the `updatedAt` attribute in descending order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2725
|
+
* @param {AmazonWarehousingAndDistributionApiListOutboundsRequest} requestParameters Request parameters.
|
|
2726
|
+
* @param {*} [options] Override http request option.
|
|
2727
|
+
* @throws {RequiredError}
|
|
2728
|
+
*/
|
|
2729
|
+
listOutbounds(requestParameters?: AmazonWarehousingAndDistributionApiListOutboundsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundListing, any, {}>>;
|
|
2730
|
+
/**
|
|
2731
|
+
* Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order.
|
|
2732
|
+
* @param {AmazonWarehousingAndDistributionApiListReplenishmentOrdersRequest} requestParameters Request parameters.
|
|
2733
|
+
* @param {*} [options] Override http request option.
|
|
2734
|
+
* @throws {RequiredError}
|
|
2735
|
+
*/
|
|
2736
|
+
listReplenishmentOrders(requestParameters?: AmazonWarehousingAndDistributionApiListReplenishmentOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReplenishmentOrderListing, any, {}>>;
|
|
2737
|
+
/**
|
|
2738
|
+
* Updates an AWD inbound order that is in `DRAFT` status and not yet confirmed. Use this operation to update the `packagesToInbound`, `originAddress` and `preferences` attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2739
|
+
* @param {AmazonWarehousingAndDistributionApiUpdateInboundRequest} requestParameters Request parameters.
|
|
2740
|
+
* @param {*} [options] Override http request option.
|
|
2741
|
+
* @throws {RequiredError}
|
|
2742
|
+
*/
|
|
2743
|
+
updateInbound(requestParameters: AmazonWarehousingAndDistributionApiUpdateInboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2744
|
+
/**
|
|
2745
|
+
* Updates transport details for an AWD shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2746
|
+
* @param {AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest} requestParameters Request parameters.
|
|
2747
|
+
* @param {*} [options] Override http request option.
|
|
2748
|
+
* @throws {RequiredError}
|
|
2749
|
+
*/
|
|
2750
|
+
updateInboundShipmentTransportDetails(requestParameters: AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2751
|
+
/**
|
|
2752
|
+
* Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on `productsToOutbound` and `orderPreferences` attributes only. Any updates will restart the outbound order validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2753
|
+
* @param {AmazonWarehousingAndDistributionApiUpdateOutboundRequest} requestParameters Request parameters.
|
|
2754
|
+
* @param {*} [options] Override http request option.
|
|
2755
|
+
* @throws {RequiredError}
|
|
2756
|
+
*/
|
|
2757
|
+
updateOutbound(requestParameters: AmazonWarehousingAndDistributionApiUpdateOutboundRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundOrderReference, any, {}>>;
|
|
3159
2758
|
}
|
|
3160
2759
|
declare const GetInboundShipmentSkuQuantitiesEnum: {
|
|
3161
|
-
|
|
3162
|
-
|
|
2760
|
+
readonly Show: "SHOW";
|
|
2761
|
+
readonly Hide: "HIDE";
|
|
3163
2762
|
};
|
|
3164
2763
|
type GetInboundShipmentSkuQuantitiesEnum = typeof GetInboundShipmentSkuQuantitiesEnum[keyof typeof GetInboundShipmentSkuQuantitiesEnum];
|
|
3165
2764
|
declare const GetInboundShipmentLabelsPageTypeEnum: {
|
|
3166
|
-
|
|
2765
|
+
readonly PlainPaper: "PLAIN_PAPER";
|
|
3167
2766
|
};
|
|
3168
2767
|
type GetInboundShipmentLabelsPageTypeEnum = typeof GetInboundShipmentLabelsPageTypeEnum[keyof typeof GetInboundShipmentLabelsPageTypeEnum];
|
|
3169
2768
|
declare const GetInboundShipmentLabelsFormatTypeEnum: {
|
|
3170
|
-
|
|
2769
|
+
readonly Pdf: "PDF";
|
|
3171
2770
|
};
|
|
3172
2771
|
type GetInboundShipmentLabelsFormatTypeEnum = typeof GetInboundShipmentLabelsFormatTypeEnum[keyof typeof GetInboundShipmentLabelsFormatTypeEnum];
|
|
3173
2772
|
declare const ListInboundShipmentsSortByEnum: {
|
|
3174
|
-
|
|
3175
|
-
|
|
2773
|
+
readonly UpdatedAt: "UPDATED_AT";
|
|
2774
|
+
readonly CreatedAt: "CREATED_AT";
|
|
3176
2775
|
};
|
|
3177
2776
|
type ListInboundShipmentsSortByEnum = typeof ListInboundShipmentsSortByEnum[keyof typeof ListInboundShipmentsSortByEnum];
|
|
3178
2777
|
declare const ListInboundShipmentsSortOrderEnum: {
|
|
3179
|
-
|
|
3180
|
-
|
|
2778
|
+
readonly Ascending: "ASCENDING";
|
|
2779
|
+
readonly Descending: "DESCENDING";
|
|
3181
2780
|
};
|
|
3182
2781
|
type ListInboundShipmentsSortOrderEnum = typeof ListInboundShipmentsSortOrderEnum[keyof typeof ListInboundShipmentsSortOrderEnum];
|
|
3183
2782
|
declare const ListInboundShipmentsShipmentStatusEnum: {
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
2783
|
+
readonly Created: "CREATED";
|
|
2784
|
+
readonly Shipped: "SHIPPED";
|
|
2785
|
+
readonly InTransit: "IN_TRANSIT";
|
|
2786
|
+
readonly Receiving: "RECEIVING";
|
|
2787
|
+
readonly Delivered: "DELIVERED";
|
|
2788
|
+
readonly Closed: "CLOSED";
|
|
2789
|
+
readonly Cancelled: "CANCELLED";
|
|
3191
2790
|
};
|
|
3192
2791
|
type ListInboundShipmentsShipmentStatusEnum = typeof ListInboundShipmentsShipmentStatusEnum[keyof typeof ListInboundShipmentsShipmentStatusEnum];
|
|
3193
2792
|
declare const ListInventorySortOrderEnum: {
|
|
3194
|
-
|
|
3195
|
-
|
|
2793
|
+
readonly Ascending: "ASCENDING";
|
|
2794
|
+
readonly Descending: "DESCENDING";
|
|
3196
2795
|
};
|
|
3197
2796
|
type ListInventorySortOrderEnum = typeof ListInventorySortOrderEnum[keyof typeof ListInventorySortOrderEnum];
|
|
3198
2797
|
declare const ListInventoryDetailsEnum: {
|
|
3199
|
-
|
|
3200
|
-
|
|
2798
|
+
readonly Show: "SHOW";
|
|
2799
|
+
readonly Hide: "HIDE";
|
|
3201
2800
|
};
|
|
3202
2801
|
type ListInventoryDetailsEnum = typeof ListInventoryDetailsEnum[keyof typeof ListInventoryDetailsEnum];
|
|
3203
2802
|
declare const ListOutboundsSortOrderEnum: {
|
|
3204
|
-
|
|
3205
|
-
|
|
2803
|
+
readonly Ascending: "ASCENDING";
|
|
2804
|
+
readonly Descending: "DESCENDING";
|
|
3206
2805
|
};
|
|
3207
2806
|
type ListOutboundsSortOrderEnum = typeof ListOutboundsSortOrderEnum[keyof typeof ListOutboundsSortOrderEnum];
|
|
3208
2807
|
declare const ListReplenishmentOrdersSortOrderEnum: {
|
|
3209
|
-
|
|
3210
|
-
|
|
2808
|
+
readonly Ascending: "ASCENDING";
|
|
2809
|
+
readonly Descending: "DESCENDING";
|
|
3211
2810
|
};
|
|
3212
2811
|
type ListReplenishmentOrdersSortOrderEnum = typeof ListReplenishmentOrdersSortOrderEnum[keyof typeof ListReplenishmentOrdersSortOrderEnum];
|
|
3213
|
-
|
|
2812
|
+
//#endregion
|
|
2813
|
+
//#region src/client.d.ts
|
|
3214
2814
|
declare const clientRateLimits: RateLimit[];
|
|
3215
2815
|
declare class AmazonWarehousingAndDistributionApiClient extends AmazonWarehousingAndDistributionApi {
|
|
3216
|
-
|
|
2816
|
+
constructor(configuration: ClientConfiguration);
|
|
3217
2817
|
}
|
|
3218
|
-
|
|
3219
|
-
export {
|
|
2818
|
+
//#endregion
|
|
2819
|
+
export { Address, AmazonWarehousingAndDistributionApi, AmazonWarehousingAndDistributionApiAxiosParamCreator, AmazonWarehousingAndDistributionApiCancelInboundRequest, AmazonWarehousingAndDistributionApiCheckInboundEligibilityRequest, AmazonWarehousingAndDistributionApiClient, AmazonWarehousingAndDistributionApiConfirmInboundRequest, AmazonWarehousingAndDistributionApiConfirmOutboundRequest, AmazonWarehousingAndDistributionApiConfirmReplenishmentOrderRequest, AmazonWarehousingAndDistributionApiCreateInboundRequest, AmazonWarehousingAndDistributionApiCreateOutboundRequest, AmazonWarehousingAndDistributionApiCreateReplenishmentOrderRequest, AmazonWarehousingAndDistributionApiFactory, AmazonWarehousingAndDistributionApiFp, AmazonWarehousingAndDistributionApiGetInboundRequest, AmazonWarehousingAndDistributionApiGetInboundShipmentLabelsRequest, AmazonWarehousingAndDistributionApiGetInboundShipmentRequest, AmazonWarehousingAndDistributionApiGetLabelPageTypesRequest, AmazonWarehousingAndDistributionApiGetOutboundRequest, AmazonWarehousingAndDistributionApiGetReplenishmentOrderRequest, AmazonWarehousingAndDistributionApiListInboundShipmentsRequest, AmazonWarehousingAndDistributionApiListInventoryRequest, AmazonWarehousingAndDistributionApiListOutboundsRequest, AmazonWarehousingAndDistributionApiListReplenishmentOrdersRequest, AmazonWarehousingAndDistributionApiUpdateInboundRequest, AmazonWarehousingAndDistributionApiUpdateInboundShipmentTransportDetailsRequest, AmazonWarehousingAndDistributionApiUpdateOutboundRequest, CarrierCode, CarrierCodeType, ConfirmationMode, DestinationDetails, DimensionUnitOfMeasurement, DistributionIneligibleReason, DistributionPackage, DistributionPackageContents, DistributionPackageQuantity, DistributionPackageType, DistributionProduct, ErrorList, ExpirationDetails, FormatType, GetInboundShipmentLabelsFormatTypeEnum, GetInboundShipmentLabelsPageTypeEnum, GetInboundShipmentSkuQuantitiesEnum, InboundEligibility, InboundEligibilityStatus, InboundOrder, InboundOrderCreationData, InboundOrderReference, InboundPackages, InboundPreferences, InboundShipment, InboundShipmentStatus, InboundShipmentSummary, InboundStatus, InventoryDetails, InventoryDetailsVisibility, InventoryListing, InventoryQuantity, InventorySummary, InventoryUnitOfMeasurement, LabelOwner, LabelStatus, ListInboundShipmentsShipmentStatusEnum, ListInboundShipmentsSortByEnum, ListInboundShipmentsSortOrderEnum, ListInventoryDetailsEnum, ListInventorySortOrderEnum, ListOutboundsSortOrderEnum, ListReplenishmentOrdersSortOrderEnum, MeasurementData, ModelError, OrderAttribute, OrderIneligibilityReason, OrderPreference, OrderPreferenceValue, OutboundExecutionError, OutboundListing, OutboundOrder, OutboundOrderCreationData, OutboundOrderReference, OutboundShipment, OutboundShipmentStatus, OutboundShipmentSummary, OutboundStatus, PackageDimensions, PackageVolume, PackageWeight, PageType, PrepCategory, PrepDetails, PrepInstruction, PrepOwner, ProductAttribute, ProductQuantity, ReplenishmentOrder, ReplenishmentOrderCreationData, ReplenishmentOrderListing, ReplenishmentOrderReference, ReplenishmentOrderStatus, ReplenishmentPreferences, ShipmentLabelPageTypes, ShipmentLabels, ShipmentListing, ShipmentSortableField, SkuEligibility, SkuIneligibilityReason, SkuQuantitiesVisibility, SkuQuantity, SortOrder, TrackingDetails, TransportationDetails, VolumeUnitOfMeasurement, WeightUnitOfMeasurement, clientRateLimits };
|
|
2820
|
+
//# sourceMappingURL=index.d.ts.map
|