@sp-api-sdk/easy-ship-api-2022-03-23 5.0.0 → 5.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -4
- package/dist/index.cjs +679 -606
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +540 -690
- package/dist/index.d.ts +540 -690
- package/dist/index.js +650 -564
- 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
|
* Selling Partner API for Easy Ship
|
|
7
6
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -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
|
-
* Selling Partner API for Easy Ship
|
|
105
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
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/code.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for Easy Ship
|
|
128
117
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -138,20 +127,21 @@ declare class BaseAPI {
|
|
|
138
127
|
* An error code that identifies the type of error that occurred. The error codes listed below are specific to the Easy Ship section.
|
|
139
128
|
*/
|
|
140
129
|
declare const Code: {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
130
|
+
readonly InvalidInput: "InvalidInput";
|
|
131
|
+
readonly InvalidTimeSlotId: "InvalidTimeSlotId";
|
|
132
|
+
readonly ScheduledPackageAlreadyExists: "ScheduledPackageAlreadyExists";
|
|
133
|
+
readonly ScheduleWindowExpired: "ScheduleWindowExpired";
|
|
134
|
+
readonly RetryableAfterGettingNewSlots: "RetryableAfterGettingNewSlots";
|
|
135
|
+
readonly TimeSlotNotAvailable: "TimeSlotNotAvailable";
|
|
136
|
+
readonly ResourceNotFound: "ResourceNotFound";
|
|
137
|
+
readonly InvalidOrderState: "InvalidOrderState";
|
|
138
|
+
readonly RegionNotSupported: "RegionNotSupported";
|
|
139
|
+
readonly OrderNotEligibleForRescheduling: "OrderNotEligibleForRescheduling";
|
|
140
|
+
readonly InternalServerError: "InternalServerError";
|
|
152
141
|
};
|
|
153
142
|
type Code = typeof Code[keyof typeof Code];
|
|
154
|
-
|
|
143
|
+
//#endregion
|
|
144
|
+
//#region src/api-model/models/item.d.ts
|
|
155
145
|
/**
|
|
156
146
|
* Selling Partner API for Easy Ship
|
|
157
147
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -167,16 +157,17 @@ type Code = typeof Code[keyof typeof Code];
|
|
|
167
157
|
* Item identifier and serial number information.
|
|
168
158
|
*/
|
|
169
159
|
interface Item {
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
}
|
|
179
|
-
|
|
160
|
+
/**
|
|
161
|
+
* The Amazon-defined order item identifier.
|
|
162
|
+
*/
|
|
163
|
+
'orderItemId'?: string;
|
|
164
|
+
/**
|
|
165
|
+
* A list of serial numbers for the items associated with the `OrderItemId` value.
|
|
166
|
+
*/
|
|
167
|
+
'orderItemSerialNumbers'?: Array<string>;
|
|
168
|
+
}
|
|
169
|
+
//#endregion
|
|
170
|
+
//#region src/api-model/models/handover-method.d.ts
|
|
180
171
|
/**
|
|
181
172
|
* Selling Partner API for Easy Ship
|
|
182
173
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -192,96 +183,64 @@ interface Item {
|
|
|
192
183
|
* Identifies the method by which a seller will hand a package over to Amazon Logistics.
|
|
193
184
|
*/
|
|
194
185
|
declare const HandoverMethod: {
|
|
195
|
-
|
|
196
|
-
|
|
186
|
+
readonly Pickup: "PICKUP";
|
|
187
|
+
readonly Dropoff: "DROPOFF";
|
|
197
188
|
};
|
|
198
189
|
type HandoverMethod = typeof HandoverMethod[keyof typeof HandoverMethod];
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
* Selling Partner API for Easy Ship
|
|
202
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
203
|
-
*
|
|
204
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
208
|
-
* https://openapi-generator.tech
|
|
209
|
-
* Do not edit the class manually.
|
|
210
|
-
*/
|
|
211
|
-
|
|
190
|
+
//#endregion
|
|
191
|
+
//#region src/api-model/models/time-slot.d.ts
|
|
212
192
|
/**
|
|
213
193
|
* A time window to hand over an Easy Ship package to Amazon Logistics.
|
|
214
194
|
*/
|
|
215
195
|
interface TimeSlot {
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
* Selling Partner API for Easy Ship
|
|
233
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
234
|
-
*
|
|
235
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
239
|
-
* https://openapi-generator.tech
|
|
240
|
-
* Do not edit the class manually.
|
|
241
|
-
*/
|
|
242
|
-
|
|
196
|
+
/**
|
|
197
|
+
* A string of up to 255 characters.
|
|
198
|
+
*/
|
|
199
|
+
'slotId': string;
|
|
200
|
+
/**
|
|
201
|
+
* A datetime value in ISO 8601 format.
|
|
202
|
+
*/
|
|
203
|
+
'startTime'?: string;
|
|
204
|
+
/**
|
|
205
|
+
* A datetime value in ISO 8601 format.
|
|
206
|
+
*/
|
|
207
|
+
'endTime'?: string;
|
|
208
|
+
'handoverMethod'?: HandoverMethod;
|
|
209
|
+
}
|
|
210
|
+
//#endregion
|
|
211
|
+
//#region src/api-model/models/package-details.d.ts
|
|
243
212
|
/**
|
|
244
213
|
* Package details. Includes `packageItems`, `packageTimeSlot`, and `packageIdentifier`.
|
|
245
214
|
*/
|
|
246
215
|
interface PackageDetails {
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
* Selling Partner API for Easy Ship
|
|
260
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
261
|
-
*
|
|
262
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
266
|
-
* https://openapi-generator.tech
|
|
267
|
-
* Do not edit the class manually.
|
|
268
|
-
*/
|
|
269
|
-
|
|
216
|
+
/**
|
|
217
|
+
* A list of items contained in the package.
|
|
218
|
+
*/
|
|
219
|
+
'packageItems'?: Array<Item>;
|
|
220
|
+
'packageTimeSlot': TimeSlot;
|
|
221
|
+
/**
|
|
222
|
+
* Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.
|
|
223
|
+
*/
|
|
224
|
+
'packageIdentifier'?: string;
|
|
225
|
+
}
|
|
226
|
+
//#endregion
|
|
227
|
+
//#region src/api-model/models/create-scheduled-package-request.d.ts
|
|
270
228
|
/**
|
|
271
229
|
* The request schema for the `createScheduledPackage` operation.
|
|
272
230
|
*/
|
|
273
231
|
interface CreateScheduledPackageRequest {
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
}
|
|
284
|
-
|
|
232
|
+
/**
|
|
233
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
234
|
+
*/
|
|
235
|
+
'amazonOrderId': string;
|
|
236
|
+
/**
|
|
237
|
+
* A string of up to 255 characters.
|
|
238
|
+
*/
|
|
239
|
+
'marketplaceId': string;
|
|
240
|
+
'packageDetails': PackageDetails;
|
|
241
|
+
}
|
|
242
|
+
//#endregion
|
|
243
|
+
//#region src/api-model/models/label-format.d.ts
|
|
285
244
|
/**
|
|
286
245
|
* Selling Partner API for Easy Ship
|
|
287
246
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -297,61 +256,40 @@ interface CreateScheduledPackageRequest {
|
|
|
297
256
|
* The file format in which the shipping label will be created.
|
|
298
257
|
*/
|
|
299
258
|
declare const LabelFormat: {
|
|
300
|
-
|
|
301
|
-
|
|
259
|
+
readonly Pdf: "PDF";
|
|
260
|
+
readonly Zpl: "ZPL";
|
|
302
261
|
};
|
|
303
262
|
type LabelFormat = typeof LabelFormat[keyof typeof LabelFormat];
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
* Selling Partner API for Easy Ship
|
|
307
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
308
|
-
*
|
|
309
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
313
|
-
* https://openapi-generator.tech
|
|
314
|
-
* Do not edit the class manually.
|
|
315
|
-
*/
|
|
316
|
-
|
|
263
|
+
//#endregion
|
|
264
|
+
//#region src/api-model/models/order-schedule-details.d.ts
|
|
317
265
|
/**
|
|
318
266
|
* This object allows users to specify an order to be scheduled. Only the amazonOrderId is required.
|
|
319
267
|
*/
|
|
320
268
|
interface OrderScheduleDetails {
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
269
|
+
/**
|
|
270
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
271
|
+
*/
|
|
272
|
+
'amazonOrderId': string;
|
|
273
|
+
'packageDetails'?: PackageDetails;
|
|
326
274
|
}
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
* Selling Partner API for Easy Ship
|
|
330
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
331
|
-
*
|
|
332
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
336
|
-
* https://openapi-generator.tech
|
|
337
|
-
* Do not edit the class manually.
|
|
338
|
-
*/
|
|
339
|
-
|
|
275
|
+
//#endregion
|
|
276
|
+
//#region src/api-model/models/create-scheduled-packages-request.d.ts
|
|
340
277
|
/**
|
|
341
278
|
* The request body for the POST /easyShip/2022-03-23/packages/bulk API.
|
|
342
279
|
*/
|
|
343
280
|
interface CreateScheduledPackagesRequest {
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
}
|
|
354
|
-
|
|
281
|
+
/**
|
|
282
|
+
* A string of up to 255 characters.
|
|
283
|
+
*/
|
|
284
|
+
'marketplaceId': string;
|
|
285
|
+
/**
|
|
286
|
+
* An array allowing users to specify orders to be scheduled.
|
|
287
|
+
*/
|
|
288
|
+
'orderScheduleDetailsList': Array<OrderScheduleDetails>;
|
|
289
|
+
'labelFormat': LabelFormat;
|
|
290
|
+
}
|
|
291
|
+
//#endregion
|
|
292
|
+
//#region src/api-model/models/unit-of-length.d.ts
|
|
355
293
|
/**
|
|
356
294
|
* Selling Partner API for Easy Ship
|
|
357
295
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -367,45 +305,35 @@ interface CreateScheduledPackagesRequest {
|
|
|
367
305
|
* The unit of measurement used to measure the length.
|
|
368
306
|
*/
|
|
369
307
|
declare const UnitOfLength: {
|
|
370
|
-
|
|
308
|
+
readonly Cm: "cm";
|
|
371
309
|
};
|
|
372
310
|
type UnitOfLength = typeof UnitOfLength[keyof typeof UnitOfLength];
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
* Selling Partner API for Easy Ship
|
|
376
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
377
|
-
*
|
|
378
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
382
|
-
* https://openapi-generator.tech
|
|
383
|
-
* Do not edit the class manually.
|
|
384
|
-
*/
|
|
385
|
-
|
|
311
|
+
//#endregion
|
|
312
|
+
//#region src/api-model/models/dimensions.d.ts
|
|
386
313
|
/**
|
|
387
314
|
* The dimensions of the scheduled package.
|
|
388
315
|
*/
|
|
389
316
|
interface Dimensions {
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
}
|
|
408
|
-
|
|
317
|
+
/**
|
|
318
|
+
* The numerical value of the specified dimension.
|
|
319
|
+
*/
|
|
320
|
+
'length'?: number;
|
|
321
|
+
/**
|
|
322
|
+
* The numerical value of the specified dimension.
|
|
323
|
+
*/
|
|
324
|
+
'width'?: number;
|
|
325
|
+
/**
|
|
326
|
+
* The numerical value of the specified dimension.
|
|
327
|
+
*/
|
|
328
|
+
'height'?: number;
|
|
329
|
+
'unit'?: UnitOfLength;
|
|
330
|
+
/**
|
|
331
|
+
* A string of up to 255 characters.
|
|
332
|
+
*/
|
|
333
|
+
'identifier'?: string;
|
|
334
|
+
}
|
|
335
|
+
//#endregion
|
|
336
|
+
//#region src/api-model/models/invoice-data.d.ts
|
|
409
337
|
/**
|
|
410
338
|
* Selling Partner API for Easy Ship
|
|
411
339
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -421,16 +349,17 @@ interface Dimensions {
|
|
|
421
349
|
* Invoice number and date.
|
|
422
350
|
*/
|
|
423
351
|
interface InvoiceData {
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
}
|
|
433
|
-
|
|
352
|
+
/**
|
|
353
|
+
* A string of up to 255 characters.
|
|
354
|
+
*/
|
|
355
|
+
'invoiceNumber': string;
|
|
356
|
+
/**
|
|
357
|
+
* A datetime value in ISO 8601 format.
|
|
358
|
+
*/
|
|
359
|
+
'invoiceDate'?: string;
|
|
360
|
+
}
|
|
361
|
+
//#endregion
|
|
362
|
+
//#region src/api-model/models/package-status.d.ts
|
|
434
363
|
/**
|
|
435
364
|
* Selling Partner API for Easy Ship
|
|
436
365
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -446,21 +375,22 @@ interface InvoiceData {
|
|
|
446
375
|
* The status of the package.
|
|
447
376
|
*/
|
|
448
377
|
declare const PackageStatus: {
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
378
|
+
readonly ReadyForPickup: "ReadyForPickup";
|
|
379
|
+
readonly PickedUp: "PickedUp";
|
|
380
|
+
readonly AtOriginFc: "AtOriginFC";
|
|
381
|
+
readonly AtDestinationFc: "AtDestinationFC";
|
|
382
|
+
readonly Delivered: "Delivered";
|
|
383
|
+
readonly Rejected: "Rejected";
|
|
384
|
+
readonly Undeliverable: "Undeliverable";
|
|
385
|
+
readonly ReturnedToSeller: "ReturnedToSeller";
|
|
386
|
+
readonly LostInTransit: "LostInTransit";
|
|
387
|
+
readonly LabelCanceled: "LabelCanceled";
|
|
388
|
+
readonly DamagedInTransit: "DamagedInTransit";
|
|
389
|
+
readonly OutForDelivery: "OutForDelivery";
|
|
461
390
|
};
|
|
462
391
|
type PackageStatus = typeof PackageStatus[keyof typeof PackageStatus];
|
|
463
|
-
|
|
392
|
+
//#endregion
|
|
393
|
+
//#region src/api-model/models/scheduled-package-id.d.ts
|
|
464
394
|
/**
|
|
465
395
|
* Selling Partner API for Easy Ship
|
|
466
396
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -476,16 +406,17 @@ type PackageStatus = typeof PackageStatus[keyof typeof PackageStatus];
|
|
|
476
406
|
* Identifies the scheduled package to be updated.
|
|
477
407
|
*/
|
|
478
408
|
interface ScheduledPackageId {
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
}
|
|
488
|
-
|
|
409
|
+
/**
|
|
410
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
411
|
+
*/
|
|
412
|
+
'amazonOrderId': string;
|
|
413
|
+
/**
|
|
414
|
+
* An Amazon-defined identifier for the scheduled package.
|
|
415
|
+
*/
|
|
416
|
+
'packageId'?: string;
|
|
417
|
+
}
|
|
418
|
+
//#endregion
|
|
419
|
+
//#region src/api-model/models/tracking-details.d.ts
|
|
489
420
|
/**
|
|
490
421
|
* Selling Partner API for Easy Ship
|
|
491
422
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -501,12 +432,13 @@ interface ScheduledPackageId {
|
|
|
501
432
|
* Representation of tracking metadata.
|
|
502
433
|
*/
|
|
503
434
|
interface TrackingDetails {
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
435
|
+
/**
|
|
436
|
+
* A string of up to 255 characters.
|
|
437
|
+
*/
|
|
438
|
+
'trackingId'?: string;
|
|
508
439
|
}
|
|
509
|
-
|
|
440
|
+
//#endregion
|
|
441
|
+
//#region src/api-model/models/unit-of-weight.d.ts
|
|
510
442
|
/**
|
|
511
443
|
* Selling Partner API for Easy Ship
|
|
512
444
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -522,67 +454,46 @@ interface TrackingDetails {
|
|
|
522
454
|
* The unit of measurement used to measure the weight.
|
|
523
455
|
*/
|
|
524
456
|
declare const UnitOfWeight: {
|
|
525
|
-
|
|
526
|
-
|
|
457
|
+
readonly Grams: "grams";
|
|
458
|
+
readonly G: "g";
|
|
527
459
|
};
|
|
528
460
|
type UnitOfWeight = typeof UnitOfWeight[keyof typeof UnitOfWeight];
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
* Selling Partner API for Easy Ship
|
|
532
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
533
|
-
*
|
|
534
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
538
|
-
* https://openapi-generator.tech
|
|
539
|
-
* Do not edit the class manually.
|
|
540
|
-
*/
|
|
541
|
-
|
|
461
|
+
//#endregion
|
|
462
|
+
//#region src/api-model/models/weight.d.ts
|
|
542
463
|
/**
|
|
543
464
|
* The weight of the scheduled package
|
|
544
465
|
*/
|
|
545
466
|
interface Weight {
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
467
|
+
/**
|
|
468
|
+
* The weight of the package.
|
|
469
|
+
*/
|
|
470
|
+
'value'?: number;
|
|
471
|
+
'unit'?: UnitOfWeight;
|
|
551
472
|
}
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
* Selling Partner API for Easy Ship
|
|
555
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
556
|
-
*
|
|
557
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
561
|
-
* https://openapi-generator.tech
|
|
562
|
-
* Do not edit the class manually.
|
|
563
|
-
*/
|
|
564
|
-
|
|
473
|
+
//#endregion
|
|
474
|
+
//#region src/api-model/models/package.d.ts
|
|
565
475
|
/**
|
|
566
476
|
* This object contains all the details of the scheduled Easy Ship package.
|
|
567
477
|
*/
|
|
568
478
|
interface Package {
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
}
|
|
585
|
-
|
|
479
|
+
'scheduledPackageId': ScheduledPackageId;
|
|
480
|
+
'packageDimensions': Dimensions;
|
|
481
|
+
'packageWeight': Weight;
|
|
482
|
+
/**
|
|
483
|
+
* A list of items contained in the package.
|
|
484
|
+
*/
|
|
485
|
+
'packageItems'?: Array<Item>;
|
|
486
|
+
'packageTimeSlot': TimeSlot;
|
|
487
|
+
/**
|
|
488
|
+
* Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.
|
|
489
|
+
*/
|
|
490
|
+
'packageIdentifier'?: string;
|
|
491
|
+
'invoice'?: InvoiceData;
|
|
492
|
+
'packageStatus'?: PackageStatus;
|
|
493
|
+
'trackingDetails'?: TrackingDetails;
|
|
494
|
+
}
|
|
495
|
+
//#endregion
|
|
496
|
+
//#region src/api-model/models/rejected-order.d.ts
|
|
586
497
|
/**
|
|
587
498
|
* Selling Partner API for Easy Ship
|
|
588
499
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -598,43 +509,33 @@ interface Package {
|
|
|
598
509
|
* A order which we couldn\'t schedule on your behalf. It contains its id, and information on the error.
|
|
599
510
|
*/
|
|
600
511
|
interface RejectedOrder {
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
512
|
+
/**
|
|
513
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
514
|
+
*/
|
|
515
|
+
'amazonOrderId': string;
|
|
516
|
+
'error'?: Error;
|
|
606
517
|
}
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
* Selling Partner API for Easy Ship
|
|
610
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
611
|
-
*
|
|
612
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
616
|
-
* https://openapi-generator.tech
|
|
617
|
-
* Do not edit the class manually.
|
|
618
|
-
*/
|
|
619
|
-
|
|
518
|
+
//#endregion
|
|
519
|
+
//#region src/api-model/models/create-scheduled-packages-response.d.ts
|
|
620
520
|
/**
|
|
621
521
|
* The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn\'t schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace.
|
|
622
522
|
*/
|
|
623
523
|
interface CreateScheduledPackagesResponse {
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
}
|
|
637
|
-
|
|
524
|
+
/**
|
|
525
|
+
* A list of packages. Refer to the `Package` object.
|
|
526
|
+
*/
|
|
527
|
+
'scheduledPackages'?: Array<Package>;
|
|
528
|
+
/**
|
|
529
|
+
* A list of orders we couldn\'t scheduled on your behalf. Each element contains the reason and details on the error.
|
|
530
|
+
*/
|
|
531
|
+
'rejectedOrders'?: Array<RejectedOrder>;
|
|
532
|
+
/**
|
|
533
|
+
* A pre-signed URL for the zip document containing the shipping labels and the documents enabled for your marketplace.
|
|
534
|
+
*/
|
|
535
|
+
'printableDocumentsUrl'?: string;
|
|
536
|
+
}
|
|
537
|
+
//#endregion
|
|
538
|
+
//#region src/api-model/models/error-list.d.ts
|
|
638
539
|
/**
|
|
639
540
|
* Selling Partner API for Easy Ship
|
|
640
541
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -650,66 +551,45 @@ interface CreateScheduledPackagesResponse {
|
|
|
650
551
|
* A list of error responses returned when a request is unsuccessful.
|
|
651
552
|
*/
|
|
652
553
|
interface ErrorList {
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
554
|
+
/**
|
|
555
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
556
|
+
*/
|
|
557
|
+
'errors': Array<Error>;
|
|
657
558
|
}
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
* Selling Partner API for Easy Ship
|
|
661
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
662
|
-
*
|
|
663
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
664
|
-
*
|
|
665
|
-
*
|
|
666
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
667
|
-
* https://openapi-generator.tech
|
|
668
|
-
* Do not edit the class manually.
|
|
669
|
-
*/
|
|
670
|
-
|
|
559
|
+
//#endregion
|
|
560
|
+
//#region src/api-model/models/list-handover-slots-request.d.ts
|
|
671
561
|
/**
|
|
672
562
|
* The request schema for the `listHandoverSlots` operation.
|
|
673
563
|
*/
|
|
674
564
|
interface ListHandoverSlotsRequest {
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
}
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
* Selling Partner API for Easy Ship
|
|
689
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
690
|
-
*
|
|
691
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
692
|
-
*
|
|
693
|
-
*
|
|
694
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
695
|
-
* https://openapi-generator.tech
|
|
696
|
-
* Do not edit the class manually.
|
|
697
|
-
*/
|
|
698
|
-
|
|
565
|
+
/**
|
|
566
|
+
* A string of up to 255 characters.
|
|
567
|
+
*/
|
|
568
|
+
'marketplaceId': string;
|
|
569
|
+
/**
|
|
570
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
571
|
+
*/
|
|
572
|
+
'amazonOrderId': string;
|
|
573
|
+
'packageDimensions': Dimensions;
|
|
574
|
+
'packageWeight': Weight;
|
|
575
|
+
}
|
|
576
|
+
//#endregion
|
|
577
|
+
//#region src/api-model/models/list-handover-slots-response.d.ts
|
|
699
578
|
/**
|
|
700
579
|
* The response schema for the `listHandoverSlots` operation.
|
|
701
580
|
*/
|
|
702
581
|
interface ListHandoverSlotsResponse {
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
}
|
|
712
|
-
|
|
582
|
+
/**
|
|
583
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
584
|
+
*/
|
|
585
|
+
'amazonOrderId': string;
|
|
586
|
+
/**
|
|
587
|
+
* A list of time slots.
|
|
588
|
+
*/
|
|
589
|
+
'timeSlots': Array<TimeSlot>;
|
|
590
|
+
}
|
|
591
|
+
//#endregion
|
|
592
|
+
//#region src/api-model/models/model-error.d.ts
|
|
713
593
|
/**
|
|
714
594
|
* Selling Partner API for Easy Ship
|
|
715
595
|
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
@@ -725,303 +605,273 @@ interface ListHandoverSlotsResponse {
|
|
|
725
605
|
* Error response returned when the request is unsuccessful.
|
|
726
606
|
*/
|
|
727
607
|
interface ModelError {
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
}
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
* Selling Partner API for Easy Ship
|
|
744
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
745
|
-
*
|
|
746
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
747
|
-
*
|
|
748
|
-
*
|
|
749
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
750
|
-
* https://openapi-generator.tech
|
|
751
|
-
* Do not edit the class manually.
|
|
752
|
-
*/
|
|
753
|
-
|
|
608
|
+
/**
|
|
609
|
+
* An error code that identifies the type of error that occurred.
|
|
610
|
+
*/
|
|
611
|
+
'code': string;
|
|
612
|
+
/**
|
|
613
|
+
* A message that describes the error condition.
|
|
614
|
+
*/
|
|
615
|
+
'message': string;
|
|
616
|
+
/**
|
|
617
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
618
|
+
*/
|
|
619
|
+
'details'?: string;
|
|
620
|
+
}
|
|
621
|
+
//#endregion
|
|
622
|
+
//#region src/api-model/models/packages.d.ts
|
|
754
623
|
/**
|
|
755
624
|
* A list of packages.
|
|
756
625
|
*/
|
|
757
626
|
interface Packages {
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
627
|
+
/**
|
|
628
|
+
* A list of packages.
|
|
629
|
+
*/
|
|
630
|
+
'packages': Array<Package>;
|
|
762
631
|
}
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
* Selling Partner API for Easy Ship
|
|
766
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
767
|
-
*
|
|
768
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
769
|
-
*
|
|
770
|
-
*
|
|
771
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
772
|
-
* https://openapi-generator.tech
|
|
773
|
-
* Do not edit the class manually.
|
|
774
|
-
*/
|
|
775
|
-
|
|
632
|
+
//#endregion
|
|
633
|
+
//#region src/api-model/models/update-package-details.d.ts
|
|
776
634
|
/**
|
|
777
635
|
* Request to update the time slot of a package.
|
|
778
636
|
*/
|
|
779
637
|
interface UpdatePackageDetails {
|
|
780
|
-
|
|
781
|
-
|
|
638
|
+
'scheduledPackageId': ScheduledPackageId;
|
|
639
|
+
'packageTimeSlot': TimeSlot;
|
|
782
640
|
}
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
* Selling Partner API for Easy Ship
|
|
786
|
-
* Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
|
|
787
|
-
*
|
|
788
|
-
* The version of the OpenAPI document: 2022-03-23
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
792
|
-
* https://openapi-generator.tech
|
|
793
|
-
* Do not edit the class manually.
|
|
794
|
-
*/
|
|
795
|
-
|
|
641
|
+
//#endregion
|
|
642
|
+
//#region src/api-model/models/update-scheduled-packages-request.d.ts
|
|
796
643
|
/**
|
|
797
644
|
* The request schema for the `updateScheduledPackages` operation.
|
|
798
645
|
*/
|
|
799
646
|
interface UpdateScheduledPackagesRequest {
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
}
|
|
809
|
-
|
|
647
|
+
/**
|
|
648
|
+
* A string of up to 255 characters.
|
|
649
|
+
*/
|
|
650
|
+
'marketplaceId': string;
|
|
651
|
+
/**
|
|
652
|
+
* A list of package update details.
|
|
653
|
+
*/
|
|
654
|
+
'updatePackageDetailsList': Array<UpdatePackageDetails>;
|
|
655
|
+
}
|
|
656
|
+
//#endregion
|
|
657
|
+
//#region src/api-model/api/easy-ship-api.d.ts
|
|
810
658
|
/**
|
|
811
659
|
* EasyShipApi - axios parameter creator
|
|
812
660
|
*/
|
|
813
661
|
declare const EasyShipApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
662
|
+
/**
|
|
663
|
+
* Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
664
|
+
* @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
|
|
665
|
+
* @param {*} [options] Override http request option.
|
|
666
|
+
* @throws {RequiredError}
|
|
667
|
+
*/
|
|
668
|
+
createScheduledPackage: (createScheduledPackageRequest: CreateScheduledPackageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
669
|
+
/**
|
|
670
|
+
* This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
671
|
+
* @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation.
|
|
672
|
+
* @param {*} [options] Override http request option.
|
|
673
|
+
* @throws {RequiredError}
|
|
674
|
+
*/
|
|
675
|
+
createScheduledPackageBulk: (createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
676
|
+
/**
|
|
677
|
+
* Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
678
|
+
* @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
679
|
+
* @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
|
|
680
|
+
* @param {*} [options] Override http request option.
|
|
681
|
+
* @throws {RequiredError}
|
|
682
|
+
*/
|
|
683
|
+
getScheduledPackage: (amazonOrderId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
684
|
+
/**
|
|
685
|
+
* Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
686
|
+
* @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation.
|
|
687
|
+
* @param {*} [options] Override http request option.
|
|
688
|
+
* @throws {RequiredError}
|
|
689
|
+
*/
|
|
690
|
+
listHandoverSlots: (listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
691
|
+
/**
|
|
692
|
+
* Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
693
|
+
* @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation.
|
|
694
|
+
* @param {*} [options] Override http request option.
|
|
695
|
+
* @throws {RequiredError}
|
|
696
|
+
*/
|
|
697
|
+
updateScheduledPackages: (updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
850
698
|
};
|
|
851
699
|
/**
|
|
852
700
|
* EasyShipApi - functional programming interface
|
|
853
701
|
*/
|
|
854
702
|
declare const EasyShipApiFp: (configuration?: Configuration) => {
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
703
|
+
/**
|
|
704
|
+
* Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
705
|
+
* @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
|
|
706
|
+
* @param {*} [options] Override http request option.
|
|
707
|
+
* @throws {RequiredError}
|
|
708
|
+
*/
|
|
709
|
+
createScheduledPackage(createScheduledPackageRequest: CreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
710
|
+
/**
|
|
711
|
+
* This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
712
|
+
* @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation.
|
|
713
|
+
* @param {*} [options] Override http request option.
|
|
714
|
+
* @throws {RequiredError}
|
|
715
|
+
*/
|
|
716
|
+
createScheduledPackageBulk(createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateScheduledPackagesResponse>>;
|
|
717
|
+
/**
|
|
718
|
+
* Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
719
|
+
* @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
720
|
+
* @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
|
|
721
|
+
* @param {*} [options] Override http request option.
|
|
722
|
+
* @throws {RequiredError}
|
|
723
|
+
*/
|
|
724
|
+
getScheduledPackage(amazonOrderId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
725
|
+
/**
|
|
726
|
+
* Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
727
|
+
* @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation.
|
|
728
|
+
* @param {*} [options] Override http request option.
|
|
729
|
+
* @throws {RequiredError}
|
|
730
|
+
*/
|
|
731
|
+
listHandoverSlots(listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListHandoverSlotsResponse>>;
|
|
732
|
+
/**
|
|
733
|
+
* Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
734
|
+
* @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation.
|
|
735
|
+
* @param {*} [options] Override http request option.
|
|
736
|
+
* @throws {RequiredError}
|
|
737
|
+
*/
|
|
738
|
+
updateScheduledPackages(updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Packages>>;
|
|
891
739
|
};
|
|
892
740
|
/**
|
|
893
741
|
* EasyShipApi - factory interface
|
|
894
742
|
*/
|
|
895
743
|
declare const EasyShipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
744
|
+
/**
|
|
745
|
+
* Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
746
|
+
* @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
|
|
747
|
+
* @param {*} [options] Override http request option.
|
|
748
|
+
* @throws {RequiredError}
|
|
749
|
+
*/
|
|
750
|
+
createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
751
|
+
/**
|
|
752
|
+
* This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
753
|
+
* @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
|
|
754
|
+
* @param {*} [options] Override http request option.
|
|
755
|
+
* @throws {RequiredError}
|
|
756
|
+
*/
|
|
757
|
+
createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateScheduledPackagesResponse>;
|
|
758
|
+
/**
|
|
759
|
+
* Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
760
|
+
* @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
|
|
761
|
+
* @param {*} [options] Override http request option.
|
|
762
|
+
* @throws {RequiredError}
|
|
763
|
+
*/
|
|
764
|
+
getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
765
|
+
/**
|
|
766
|
+
* Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
767
|
+
* @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
|
|
768
|
+
* @param {*} [options] Override http request option.
|
|
769
|
+
* @throws {RequiredError}
|
|
770
|
+
*/
|
|
771
|
+
listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListHandoverSlotsResponse>;
|
|
772
|
+
/**
|
|
773
|
+
* Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
774
|
+
* @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
|
|
775
|
+
* @param {*} [options] Override http request option.
|
|
776
|
+
* @throws {RequiredError}
|
|
777
|
+
*/
|
|
778
|
+
updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Packages>;
|
|
931
779
|
};
|
|
932
780
|
/**
|
|
933
781
|
* Request parameters for createScheduledPackage operation in EasyShipApi.
|
|
934
782
|
*/
|
|
935
783
|
interface EasyShipApiCreateScheduledPackageRequest {
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
784
|
+
/**
|
|
785
|
+
* The request schema for the `createScheduledPackage` operation.
|
|
786
|
+
*/
|
|
787
|
+
readonly createScheduledPackageRequest: CreateScheduledPackageRequest;
|
|
940
788
|
}
|
|
941
789
|
/**
|
|
942
790
|
* Request parameters for createScheduledPackageBulk operation in EasyShipApi.
|
|
943
791
|
*/
|
|
944
792
|
interface EasyShipApiCreateScheduledPackageBulkRequest {
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
793
|
+
/**
|
|
794
|
+
* The request schema for the `createScheduledPackageBulk` operation.
|
|
795
|
+
*/
|
|
796
|
+
readonly createScheduledPackagesRequest: CreateScheduledPackagesRequest;
|
|
949
797
|
}
|
|
950
798
|
/**
|
|
951
799
|
* Request parameters for getScheduledPackage operation in EasyShipApi.
|
|
952
800
|
*/
|
|
953
801
|
interface EasyShipApiGetScheduledPackageRequest {
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
802
|
+
/**
|
|
803
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
804
|
+
*/
|
|
805
|
+
readonly amazonOrderId: string;
|
|
806
|
+
/**
|
|
807
|
+
* An identifier for the marketplace in which the seller is selling.
|
|
808
|
+
*/
|
|
809
|
+
readonly marketplaceId: string;
|
|
962
810
|
}
|
|
963
811
|
/**
|
|
964
812
|
* Request parameters for listHandoverSlots operation in EasyShipApi.
|
|
965
813
|
*/
|
|
966
814
|
interface EasyShipApiListHandoverSlotsRequest {
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
815
|
+
/**
|
|
816
|
+
* The request schema for the `listHandoverSlots` operation.
|
|
817
|
+
*/
|
|
818
|
+
readonly listHandoverSlotsRequest?: ListHandoverSlotsRequest;
|
|
971
819
|
}
|
|
972
820
|
/**
|
|
973
821
|
* Request parameters for updateScheduledPackages operation in EasyShipApi.
|
|
974
822
|
*/
|
|
975
823
|
interface EasyShipApiUpdateScheduledPackagesRequest {
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
824
|
+
/**
|
|
825
|
+
* The request schema for the `updateScheduledPackages` operation.
|
|
826
|
+
*/
|
|
827
|
+
readonly updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest;
|
|
980
828
|
}
|
|
981
829
|
/**
|
|
982
830
|
* EasyShipApi - object-oriented interface
|
|
983
831
|
*/
|
|
984
832
|
declare class EasyShipApi extends BaseAPI {
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
}
|
|
1021
|
-
|
|
833
|
+
/**
|
|
834
|
+
* Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
835
|
+
* @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
|
|
836
|
+
* @param {*} [options] Override http request option.
|
|
837
|
+
* @throws {RequiredError}
|
|
838
|
+
*/
|
|
839
|
+
createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any, {}>>;
|
|
840
|
+
/**
|
|
841
|
+
* This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
842
|
+
* @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
|
|
843
|
+
* @param {*} [options] Override http request option.
|
|
844
|
+
* @throws {RequiredError}
|
|
845
|
+
*/
|
|
846
|
+
createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateScheduledPackagesResponse, any, {}>>;
|
|
847
|
+
/**
|
|
848
|
+
* Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
849
|
+
* @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
|
|
850
|
+
* @param {*} [options] Override http request option.
|
|
851
|
+
* @throws {RequiredError}
|
|
852
|
+
*/
|
|
853
|
+
getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any, {}>>;
|
|
854
|
+
/**
|
|
855
|
+
* Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
856
|
+
* @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
|
|
857
|
+
* @param {*} [options] Override http request option.
|
|
858
|
+
* @throws {RequiredError}
|
|
859
|
+
*/
|
|
860
|
+
listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListHandoverSlotsResponse, any, {}>>;
|
|
861
|
+
/**
|
|
862
|
+
* Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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, see [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).
|
|
863
|
+
* @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
|
|
864
|
+
* @param {*} [options] Override http request option.
|
|
865
|
+
* @throws {RequiredError}
|
|
866
|
+
*/
|
|
867
|
+
updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Packages, any, {}>>;
|
|
868
|
+
}
|
|
869
|
+
//#endregion
|
|
870
|
+
//#region src/client.d.ts
|
|
1022
871
|
declare const clientRateLimits: RateLimit[];
|
|
1023
872
|
declare class EasyShipApiClient extends EasyShipApi {
|
|
1024
|
-
|
|
873
|
+
constructor(configuration: ClientConfiguration);
|
|
1025
874
|
}
|
|
1026
|
-
|
|
1027
|
-
export { Code,
|
|
875
|
+
//#endregion
|
|
876
|
+
export { Code, CreateScheduledPackageRequest, CreateScheduledPackagesRequest, CreateScheduledPackagesResponse, Dimensions, EasyShipApi, EasyShipApiAxiosParamCreator, EasyShipApiClient, EasyShipApiCreateScheduledPackageBulkRequest, EasyShipApiCreateScheduledPackageRequest, EasyShipApiFactory, EasyShipApiFp, EasyShipApiGetScheduledPackageRequest, EasyShipApiListHandoverSlotsRequest, EasyShipApiUpdateScheduledPackagesRequest, ErrorList, HandoverMethod, InvoiceData, Item, LabelFormat, ListHandoverSlotsRequest, ListHandoverSlotsResponse, ModelError, OrderScheduleDetails, Package, PackageDetails, PackageStatus, Packages, RejectedOrder, ScheduledPackageId, TimeSlot, TrackingDetails, UnitOfLength, UnitOfWeight, UpdatePackageDetails, UpdateScheduledPackagesRequest, Weight, clientRateLimits };
|
|
877
|
+
//# sourceMappingURL=index.d.ts.map
|