@sp-api-sdk/easy-ship-api-2022-03-23 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +107 -0
- package/dist/cjs/api-model/api/easy-ship-api.js +367 -0
- package/dist/cjs/api-model/api.js +30 -0
- package/dist/cjs/api-model/base.js +71 -0
- package/dist/cjs/api-model/common.js +145 -0
- package/dist/cjs/api-model/configuration.js +99 -0
- package/dist/cjs/api-model/index.js +32 -0
- package/dist/cjs/api-model/models/code.js +34 -0
- package/dist/cjs/api-model/models/create-scheduled-package-request.js +15 -0
- package/dist/cjs/api-model/models/create-scheduled-packages-request.js +15 -0
- package/dist/cjs/api-model/models/create-scheduled-packages-response.js +15 -0
- package/dist/cjs/api-model/models/dimensions.js +15 -0
- package/dist/cjs/api-model/models/error-list.js +15 -0
- package/dist/cjs/api-model/models/handover-method.js +25 -0
- package/dist/cjs/api-model/models/index.js +43 -0
- package/dist/cjs/api-model/models/invoice-data.js +15 -0
- package/dist/cjs/api-model/models/item.js +15 -0
- package/dist/cjs/api-model/models/label-format.js +25 -0
- package/dist/cjs/api-model/models/list-handover-slots-request.js +15 -0
- package/dist/cjs/api-model/models/list-handover-slots-response.js +15 -0
- package/dist/cjs/api-model/models/model-error.js +15 -0
- package/dist/cjs/api-model/models/order-schedule-details.js +15 -0
- package/dist/cjs/api-model/models/package-details.js +15 -0
- package/dist/cjs/api-model/models/package-status.js +35 -0
- package/dist/cjs/api-model/models/package.js +15 -0
- package/dist/cjs/api-model/models/packages.js +15 -0
- package/dist/cjs/api-model/models/rejected-order.js +15 -0
- package/dist/cjs/api-model/models/scheduled-package-id.js +15 -0
- package/dist/cjs/api-model/models/time-slot.js +15 -0
- package/dist/cjs/api-model/models/tracking-details.js +15 -0
- package/dist/cjs/api-model/models/unit-of-length.js +24 -0
- package/dist/cjs/api-model/models/unit-of-weight.js +25 -0
- package/dist/cjs/api-model/models/update-package-details.js +15 -0
- package/dist/cjs/api-model/models/update-scheduled-packages-request.js +15 -0
- package/dist/cjs/api-model/models/weight.js +15 -0
- package/dist/cjs/client.js +49 -0
- package/dist/cjs/index.js +19 -0
- package/dist/es/api-model/api/easy-ship-api.js +357 -0
- package/dist/es/api-model/api.js +14 -0
- package/dist/es/api-model/base.js +63 -0
- package/dist/es/api-model/common.js +133 -0
- package/dist/es/api-model/configuration.js +95 -0
- package/dist/es/api-model/index.js +16 -0
- package/dist/es/api-model/models/code.js +31 -0
- package/dist/es/api-model/models/create-scheduled-package-request.js +14 -0
- package/dist/es/api-model/models/create-scheduled-packages-request.js +14 -0
- package/dist/es/api-model/models/create-scheduled-packages-response.js +14 -0
- package/dist/es/api-model/models/dimensions.js +14 -0
- package/dist/es/api-model/models/error-list.js +14 -0
- package/dist/es/api-model/models/handover-method.js +22 -0
- package/dist/es/api-model/models/index.js +27 -0
- package/dist/es/api-model/models/invoice-data.js +14 -0
- package/dist/es/api-model/models/item.js +14 -0
- package/dist/es/api-model/models/label-format.js +22 -0
- package/dist/es/api-model/models/list-handover-slots-request.js +14 -0
- package/dist/es/api-model/models/list-handover-slots-response.js +14 -0
- package/dist/es/api-model/models/model-error.js +14 -0
- package/dist/es/api-model/models/order-schedule-details.js +14 -0
- package/dist/es/api-model/models/package-details.js +14 -0
- package/dist/es/api-model/models/package-status.js +32 -0
- package/dist/es/api-model/models/package.js +14 -0
- package/dist/es/api-model/models/packages.js +14 -0
- package/dist/es/api-model/models/rejected-order.js +14 -0
- package/dist/es/api-model/models/scheduled-package-id.js +14 -0
- package/dist/es/api-model/models/time-slot.js +14 -0
- package/dist/es/api-model/models/tracking-details.js +14 -0
- package/dist/es/api-model/models/unit-of-length.js +21 -0
- package/dist/es/api-model/models/unit-of-weight.js +22 -0
- package/dist/es/api-model/models/update-package-details.js +14 -0
- package/dist/es/api-model/models/update-scheduled-packages-request.js +14 -0
- package/dist/es/api-model/models/weight.js +14 -0
- package/dist/es/client.js +45 -0
- package/dist/es/index.js +3 -0
- package/dist/types/api-model/api/easy-ship-api.d.ts +267 -0
- package/dist/types/api-model/api.d.ts +12 -0
- package/dist/types/api-model/base.d.ts +66 -0
- package/dist/types/api-model/common.d.ts +65 -0
- package/dist/types/api-model/configuration.d.ts +91 -0
- package/dist/types/api-model/index.d.ts +14 -0
- package/dist/types/api-model/models/code.d.ts +30 -0
- package/dist/types/api-model/models/create-scheduled-package-request.d.ts +37 -0
- package/dist/types/api-model/models/create-scheduled-packages-request.d.ts +38 -0
- package/dist/types/api-model/models/create-scheduled-packages-response.d.ts +38 -0
- package/dist/types/api-model/models/dimensions.d.ts +49 -0
- package/dist/types/api-model/models/error-list.d.ts +24 -0
- package/dist/types/api-model/models/handover-method.d.ts +21 -0
- package/dist/types/api-model/models/index.d.ts +27 -0
- package/dist/types/api-model/models/invoice-data.d.ts +30 -0
- package/dist/types/api-model/models/item.d.ts +30 -0
- package/dist/types/api-model/models/label-format.d.ts +21 -0
- package/dist/types/api-model/models/list-handover-slots-request.d.ts +44 -0
- package/dist/types/api-model/models/list-handover-slots-response.d.ts +31 -0
- package/dist/types/api-model/models/model-error.d.ts +36 -0
- package/dist/types/api-model/models/order-schedule-details.d.ts +31 -0
- package/dist/types/api-model/models/package-details.d.ts +38 -0
- package/dist/types/api-model/models/package-status.d.ts +31 -0
- package/dist/types/api-model/models/package.d.ts +80 -0
- package/dist/types/api-model/models/packages.d.ts +25 -0
- package/dist/types/api-model/models/rejected-order.d.ts +30 -0
- package/dist/types/api-model/models/scheduled-package-id.d.ts +30 -0
- package/dist/types/api-model/models/time-slot.d.ts +43 -0
- package/dist/types/api-model/models/tracking-details.d.ts +24 -0
- package/dist/types/api-model/models/unit-of-length.d.ts +20 -0
- package/dist/types/api-model/models/unit-of-weight.d.ts +21 -0
- package/dist/types/api-model/models/update-package-details.d.ts +32 -0
- package/dist/types/api-model/models/update-scheduled-packages-request.d.ts +31 -0
- package/dist/types/api-model/models/weight.d.ts +31 -0
- package/dist/types/client.d.ts +6 -0
- package/dist/types/index.d.ts +3 -0
- package/package.json +44 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { PackageDetails } from './package-details';
|
|
13
|
+
/**
|
|
14
|
+
* The request schema for the `createScheduledPackage` operation.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CreateScheduledPackageRequest
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateScheduledPackageRequest {
|
|
19
|
+
/**
|
|
20
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof CreateScheduledPackageRequest
|
|
23
|
+
*/
|
|
24
|
+
'amazonOrderId': string;
|
|
25
|
+
/**
|
|
26
|
+
* A string of up to 255 characters.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof CreateScheduledPackageRequest
|
|
29
|
+
*/
|
|
30
|
+
'marketplaceId': string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {PackageDetails}
|
|
34
|
+
* @memberof CreateScheduledPackageRequest
|
|
35
|
+
*/
|
|
36
|
+
'packageDetails': PackageDetails;
|
|
37
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { LabelFormat } from './label-format';
|
|
13
|
+
import type { OrderScheduleDetails } from './order-schedule-details';
|
|
14
|
+
/**
|
|
15
|
+
* The request body for the POST /easyShip/2022-03-23/packages/bulk API.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface CreateScheduledPackagesRequest
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateScheduledPackagesRequest {
|
|
20
|
+
/**
|
|
21
|
+
* A string of up to 255 characters.
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof CreateScheduledPackagesRequest
|
|
24
|
+
*/
|
|
25
|
+
'marketplaceId': string;
|
|
26
|
+
/**
|
|
27
|
+
* An array allowing users to specify orders to be scheduled.
|
|
28
|
+
* @type {Array<OrderScheduleDetails>}
|
|
29
|
+
* @memberof CreateScheduledPackagesRequest
|
|
30
|
+
*/
|
|
31
|
+
'orderScheduleDetailsList': Array<OrderScheduleDetails>;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {LabelFormat}
|
|
35
|
+
* @memberof CreateScheduledPackagesRequest
|
|
36
|
+
*/
|
|
37
|
+
'labelFormat': LabelFormat;
|
|
38
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Package } from './package';
|
|
13
|
+
import type { RejectedOrder } from './rejected-order';
|
|
14
|
+
/**
|
|
15
|
+
* 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.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface CreateScheduledPackagesResponse
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateScheduledPackagesResponse {
|
|
20
|
+
/**
|
|
21
|
+
* A list of packages. Refer to the `Package` object.
|
|
22
|
+
* @type {Array<Package>}
|
|
23
|
+
* @memberof CreateScheduledPackagesResponse
|
|
24
|
+
*/
|
|
25
|
+
'scheduledPackages'?: Array<Package>;
|
|
26
|
+
/**
|
|
27
|
+
* A list of orders we couldn\'t scheduled on your behalf. Each element contains the reason and details on the error.
|
|
28
|
+
* @type {Array<RejectedOrder>}
|
|
29
|
+
* @memberof CreateScheduledPackagesResponse
|
|
30
|
+
*/
|
|
31
|
+
'rejectedOrders'?: Array<RejectedOrder>;
|
|
32
|
+
/**
|
|
33
|
+
* A pre-signed URL for the zip document containing the shipping labels and the documents enabled for your marketplace.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof CreateScheduledPackagesResponse
|
|
36
|
+
*/
|
|
37
|
+
'printableDocumentsUrl'?: string;
|
|
38
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { UnitOfLength } from './unit-of-length';
|
|
13
|
+
/**
|
|
14
|
+
* The dimensions of the scheduled package.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface Dimensions
|
|
17
|
+
*/
|
|
18
|
+
export interface Dimensions {
|
|
19
|
+
/**
|
|
20
|
+
* The numerical value of the specified dimension.
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof Dimensions
|
|
23
|
+
*/
|
|
24
|
+
'length'?: number;
|
|
25
|
+
/**
|
|
26
|
+
* The numerical value of the specified dimension.
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof Dimensions
|
|
29
|
+
*/
|
|
30
|
+
'width'?: number;
|
|
31
|
+
/**
|
|
32
|
+
* The numerical value of the specified dimension.
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof Dimensions
|
|
35
|
+
*/
|
|
36
|
+
'height'?: number;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {UnitOfLength}
|
|
40
|
+
* @memberof Dimensions
|
|
41
|
+
*/
|
|
42
|
+
'unit'?: UnitOfLength;
|
|
43
|
+
/**
|
|
44
|
+
* A string of up to 255 characters.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof Dimensions
|
|
47
|
+
*/
|
|
48
|
+
'identifier'?: string;
|
|
49
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ErrorList
|
|
16
|
+
*/
|
|
17
|
+
export interface ErrorList {
|
|
18
|
+
/**
|
|
19
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
20
|
+
* @type {Array<Error>}
|
|
21
|
+
* @memberof ErrorList
|
|
22
|
+
*/
|
|
23
|
+
'errors': Array<Error>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Identifies the method by which a seller will hand a package over to Amazon Logistics.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const HandoverMethod: {
|
|
18
|
+
readonly Pickup: "Pickup";
|
|
19
|
+
readonly Dropoff: "Dropoff";
|
|
20
|
+
};
|
|
21
|
+
export type HandoverMethod = typeof HandoverMethod[keyof typeof HandoverMethod];
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export * from './code';
|
|
2
|
+
export * from './create-scheduled-package-request';
|
|
3
|
+
export * from './create-scheduled-packages-request';
|
|
4
|
+
export * from './create-scheduled-packages-response';
|
|
5
|
+
export * from './dimensions';
|
|
6
|
+
export * from './error-list';
|
|
7
|
+
export * from './handover-method';
|
|
8
|
+
export * from './invoice-data';
|
|
9
|
+
export * from './item';
|
|
10
|
+
export * from './label-format';
|
|
11
|
+
export * from './list-handover-slots-request';
|
|
12
|
+
export * from './list-handover-slots-response';
|
|
13
|
+
export * from './model-error';
|
|
14
|
+
export * from './order-schedule-details';
|
|
15
|
+
export * from './package';
|
|
16
|
+
export * from './package-details';
|
|
17
|
+
export * from './package-status';
|
|
18
|
+
export * from './packages';
|
|
19
|
+
export * from './rejected-order';
|
|
20
|
+
export * from './scheduled-package-id';
|
|
21
|
+
export * from './time-slot';
|
|
22
|
+
export * from './tracking-details';
|
|
23
|
+
export * from './unit-of-length';
|
|
24
|
+
export * from './unit-of-weight';
|
|
25
|
+
export * from './update-package-details';
|
|
26
|
+
export * from './update-scheduled-packages-request';
|
|
27
|
+
export * from './weight';
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Invoice number and date.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface InvoiceData
|
|
16
|
+
*/
|
|
17
|
+
export interface InvoiceData {
|
|
18
|
+
/**
|
|
19
|
+
* A string of up to 255 characters.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof InvoiceData
|
|
22
|
+
*/
|
|
23
|
+
'invoiceNumber': string;
|
|
24
|
+
/**
|
|
25
|
+
* A datetime value in ISO 8601 format.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof InvoiceData
|
|
28
|
+
*/
|
|
29
|
+
'invoiceDate'?: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Item identifier and serial number information.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface Item
|
|
16
|
+
*/
|
|
17
|
+
export interface Item {
|
|
18
|
+
/**
|
|
19
|
+
* The Amazon-defined order item identifier.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof Item
|
|
22
|
+
*/
|
|
23
|
+
'orderItemId'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* A list of serial numbers for the items associated with the `OrderItemId` value.
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof Item
|
|
28
|
+
*/
|
|
29
|
+
'orderItemSerialNumbers'?: Array<string>;
|
|
30
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The file format in which the shipping label will be created.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const LabelFormat: {
|
|
18
|
+
readonly Pdf: "PDF";
|
|
19
|
+
readonly Zpl: "ZPL";
|
|
20
|
+
};
|
|
21
|
+
export type LabelFormat = typeof LabelFormat[keyof typeof LabelFormat];
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Dimensions } from './dimensions';
|
|
13
|
+
import type { Weight } from './weight';
|
|
14
|
+
/**
|
|
15
|
+
* The request schema for the `listHandoverSlots` operation.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ListHandoverSlotsRequest
|
|
18
|
+
*/
|
|
19
|
+
export interface ListHandoverSlotsRequest {
|
|
20
|
+
/**
|
|
21
|
+
* A string of up to 255 characters.
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof ListHandoverSlotsRequest
|
|
24
|
+
*/
|
|
25
|
+
'marketplaceId': string;
|
|
26
|
+
/**
|
|
27
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof ListHandoverSlotsRequest
|
|
30
|
+
*/
|
|
31
|
+
'amazonOrderId': string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Dimensions}
|
|
35
|
+
* @memberof ListHandoverSlotsRequest
|
|
36
|
+
*/
|
|
37
|
+
'packageDimensions': Dimensions;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {Weight}
|
|
41
|
+
* @memberof ListHandoverSlotsRequest
|
|
42
|
+
*/
|
|
43
|
+
'packageWeight': Weight;
|
|
44
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { TimeSlot } from './time-slot';
|
|
13
|
+
/**
|
|
14
|
+
* The response schema for the `listHandoverSlots` operation.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ListHandoverSlotsResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface ListHandoverSlotsResponse {
|
|
19
|
+
/**
|
|
20
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof ListHandoverSlotsResponse
|
|
23
|
+
*/
|
|
24
|
+
'amazonOrderId': string;
|
|
25
|
+
/**
|
|
26
|
+
* A list of time slots.
|
|
27
|
+
* @type {Array<TimeSlot>}
|
|
28
|
+
* @memberof ListHandoverSlotsResponse
|
|
29
|
+
*/
|
|
30
|
+
'timeSlots': Array<TimeSlot>;
|
|
31
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Error response returned when the request is unsuccessful.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ModelError
|
|
16
|
+
*/
|
|
17
|
+
export interface ModelError {
|
|
18
|
+
/**
|
|
19
|
+
* An error code that identifies the type of error that occurred.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ModelError
|
|
22
|
+
*/
|
|
23
|
+
'code': string;
|
|
24
|
+
/**
|
|
25
|
+
* A message that describes the error condition.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ModelError
|
|
28
|
+
*/
|
|
29
|
+
'message': string;
|
|
30
|
+
/**
|
|
31
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ModelError
|
|
34
|
+
*/
|
|
35
|
+
'details'?: string;
|
|
36
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { PackageDetails } from './package-details';
|
|
13
|
+
/**
|
|
14
|
+
* This object allows users to specify an order to be scheduled. Only the amazonOrderId is required.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface OrderScheduleDetails
|
|
17
|
+
*/
|
|
18
|
+
export interface OrderScheduleDetails {
|
|
19
|
+
/**
|
|
20
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof OrderScheduleDetails
|
|
23
|
+
*/
|
|
24
|
+
'amazonOrderId': string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {PackageDetails}
|
|
28
|
+
* @memberof OrderScheduleDetails
|
|
29
|
+
*/
|
|
30
|
+
'packageDetails'?: PackageDetails;
|
|
31
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Item } from './item';
|
|
13
|
+
import type { TimeSlot } from './time-slot';
|
|
14
|
+
/**
|
|
15
|
+
* Package details. Includes `packageItems`, `packageTimeSlot`, and `packageIdentifier`.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface PackageDetails
|
|
18
|
+
*/
|
|
19
|
+
export interface PackageDetails {
|
|
20
|
+
/**
|
|
21
|
+
* A list of items contained in the package.
|
|
22
|
+
* @type {Array<Item>}
|
|
23
|
+
* @memberof PackageDetails
|
|
24
|
+
*/
|
|
25
|
+
'packageItems'?: Array<Item>;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {TimeSlot}
|
|
29
|
+
* @memberof PackageDetails
|
|
30
|
+
*/
|
|
31
|
+
'packageTimeSlot': TimeSlot;
|
|
32
|
+
/**
|
|
33
|
+
* Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof PackageDetails
|
|
36
|
+
*/
|
|
37
|
+
'packageIdentifier'?: string;
|
|
38
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The status of the package.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const PackageStatus: {
|
|
18
|
+
readonly ReadyForPickup: "ReadyForPickup";
|
|
19
|
+
readonly PickedUp: "PickedUp";
|
|
20
|
+
readonly AtOriginFc: "AtOriginFC";
|
|
21
|
+
readonly AtDestinationFc: "AtDestinationFC";
|
|
22
|
+
readonly Delivered: "Delivered";
|
|
23
|
+
readonly Rejected: "Rejected";
|
|
24
|
+
readonly Undeliverable: "Undeliverable";
|
|
25
|
+
readonly ReturnedToSeller: "ReturnedToSeller";
|
|
26
|
+
readonly LostInTransit: "LostInTransit";
|
|
27
|
+
readonly LabelCanceled: "LabelCanceled";
|
|
28
|
+
readonly DamagedInTransit: "DamagedInTransit";
|
|
29
|
+
readonly OutForDelivery: "OutForDelivery";
|
|
30
|
+
};
|
|
31
|
+
export type PackageStatus = typeof PackageStatus[keyof typeof PackageStatus];
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Dimensions } from './dimensions';
|
|
13
|
+
import type { InvoiceData } from './invoice-data';
|
|
14
|
+
import type { Item } from './item';
|
|
15
|
+
import type { PackageStatus } from './package-status';
|
|
16
|
+
import type { ScheduledPackageId } from './scheduled-package-id';
|
|
17
|
+
import type { TimeSlot } from './time-slot';
|
|
18
|
+
import type { TrackingDetails } from './tracking-details';
|
|
19
|
+
import type { Weight } from './weight';
|
|
20
|
+
/**
|
|
21
|
+
* This object contains all the details of the scheduled Easy Ship package.
|
|
22
|
+
* @export
|
|
23
|
+
* @interface Package
|
|
24
|
+
*/
|
|
25
|
+
export interface Package {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {ScheduledPackageId}
|
|
29
|
+
* @memberof Package
|
|
30
|
+
*/
|
|
31
|
+
'scheduledPackageId': ScheduledPackageId;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Dimensions}
|
|
35
|
+
* @memberof Package
|
|
36
|
+
*/
|
|
37
|
+
'packageDimensions': Dimensions;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {Weight}
|
|
41
|
+
* @memberof Package
|
|
42
|
+
*/
|
|
43
|
+
'packageWeight': Weight;
|
|
44
|
+
/**
|
|
45
|
+
* A list of items contained in the package.
|
|
46
|
+
* @type {Array<Item>}
|
|
47
|
+
* @memberof Package
|
|
48
|
+
*/
|
|
49
|
+
'packageItems'?: Array<Item>;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {TimeSlot}
|
|
53
|
+
* @memberof Package
|
|
54
|
+
*/
|
|
55
|
+
'packageTimeSlot': TimeSlot;
|
|
56
|
+
/**
|
|
57
|
+
* Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof Package
|
|
60
|
+
*/
|
|
61
|
+
'packageIdentifier'?: string;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {InvoiceData}
|
|
65
|
+
* @memberof Package
|
|
66
|
+
*/
|
|
67
|
+
'invoice'?: InvoiceData;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {PackageStatus}
|
|
71
|
+
* @memberof Package
|
|
72
|
+
*/
|
|
73
|
+
'packageStatus'?: PackageStatus;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @type {TrackingDetails}
|
|
77
|
+
* @memberof Package
|
|
78
|
+
*/
|
|
79
|
+
'trackingDetails'?: TrackingDetails;
|
|
80
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Easy Ship
|
|
3
|
+
* The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-03-23
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Package } from './package';
|
|
13
|
+
/**
|
|
14
|
+
* A list of packages.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface Packages
|
|
17
|
+
*/
|
|
18
|
+
export interface Packages {
|
|
19
|
+
/**
|
|
20
|
+
* A list of packages.
|
|
21
|
+
* @type {Array<Package>}
|
|
22
|
+
* @memberof Packages
|
|
23
|
+
*/
|
|
24
|
+
'packages': Array<Package>;
|
|
25
|
+
}
|