@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,45 @@
|
|
|
1
|
+
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
+
import { Configuration, EasyShipApi } from './api-model';
|
|
3
|
+
export const clientRateLimits = [
|
|
4
|
+
{
|
|
5
|
+
method: 'post',
|
|
6
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
7
|
+
urlRegex: new RegExp('^/easyShip/2022-03-23/timeSlot$'),
|
|
8
|
+
rate: 1,
|
|
9
|
+
burst: 5,
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
method: 'get',
|
|
13
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
14
|
+
urlRegex: new RegExp('^/easyShip/2022-03-23/package$'),
|
|
15
|
+
rate: 1,
|
|
16
|
+
burst: 5,
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
method: 'post',
|
|
20
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
21
|
+
urlRegex: new RegExp('^/easyShip/2022-03-23/package$'),
|
|
22
|
+
rate: 1,
|
|
23
|
+
burst: 5,
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
method: 'patch',
|
|
27
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
28
|
+
urlRegex: new RegExp('^/easyShip/2022-03-23/package$'),
|
|
29
|
+
rate: 1,
|
|
30
|
+
burst: 5,
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
method: 'post',
|
|
34
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
35
|
+
urlRegex: new RegExp('^/easyShip/2022-03-23/packages/bulk$'),
|
|
36
|
+
rate: 1,
|
|
37
|
+
burst: 5,
|
|
38
|
+
},
|
|
39
|
+
];
|
|
40
|
+
export class EasyShipApiClient extends EasyShipApi {
|
|
41
|
+
constructor(configuration) {
|
|
42
|
+
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
43
|
+
super(new Configuration(), endpoint, axios);
|
|
44
|
+
}
|
|
45
|
+
}
|
package/dist/es/index.js
ADDED
|
@@ -0,0 +1,267 @@
|
|
|
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 { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { CreateScheduledPackageRequest } from '../models';
|
|
17
|
+
import type { CreateScheduledPackagesRequest } from '../models';
|
|
18
|
+
import type { CreateScheduledPackagesResponse } from '../models';
|
|
19
|
+
import type { ListHandoverSlotsRequest } from '../models';
|
|
20
|
+
import type { ListHandoverSlotsResponse } from '../models';
|
|
21
|
+
import type { Package } from '../models';
|
|
22
|
+
import type { Packages } from '../models';
|
|
23
|
+
import type { UpdateScheduledPackagesRequest } from '../models';
|
|
24
|
+
/**
|
|
25
|
+
* EasyShipApi - axios parameter creator
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export declare const EasyShipApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
|
+
/**
|
|
30
|
+
* 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).
|
|
31
|
+
* @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
|
|
32
|
+
* @param {*} [options] Override http request option.
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
createScheduledPackage: (createScheduledPackageRequest: CreateScheduledPackageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
+
/**
|
|
37
|
+
* This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
38
|
+
* @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
createScheduledPackageBulk: (createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
|
+
/**
|
|
44
|
+
* 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).
|
|
45
|
+
* @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
46
|
+
* @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
getScheduledPackage: (amazonOrderId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
|
+
/**
|
|
52
|
+
* 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).
|
|
53
|
+
* @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation.
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
listHandoverSlots: (listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* 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).
|
|
60
|
+
* @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation.
|
|
61
|
+
* @param {*} [options] Override http request option.
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
*/
|
|
64
|
+
updateScheduledPackages: (updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* EasyShipApi - functional programming interface
|
|
68
|
+
* @export
|
|
69
|
+
*/
|
|
70
|
+
export declare const EasyShipApiFp: (configuration?: Configuration) => {
|
|
71
|
+
/**
|
|
72
|
+
* 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).
|
|
73
|
+
* @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
createScheduledPackage(createScheduledPackageRequest: CreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
78
|
+
/**
|
|
79
|
+
* This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
80
|
+
* @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation.
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
createScheduledPackageBulk(createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateScheduledPackagesResponse>>;
|
|
85
|
+
/**
|
|
86
|
+
* 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).
|
|
87
|
+
* @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
88
|
+
* @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
getScheduledPackage(amazonOrderId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
93
|
+
/**
|
|
94
|
+
* 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).
|
|
95
|
+
* @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation.
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
listHandoverSlots(listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListHandoverSlotsResponse>>;
|
|
100
|
+
/**
|
|
101
|
+
* 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).
|
|
102
|
+
* @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
updateScheduledPackages(updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Packages>>;
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* EasyShipApi - factory interface
|
|
110
|
+
* @export
|
|
111
|
+
*/
|
|
112
|
+
export declare const EasyShipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
113
|
+
/**
|
|
114
|
+
* 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).
|
|
115
|
+
* @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
120
|
+
/**
|
|
121
|
+
* This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
122
|
+
* @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateScheduledPackagesResponse>;
|
|
127
|
+
/**
|
|
128
|
+
* 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).
|
|
129
|
+
* @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
134
|
+
/**
|
|
135
|
+
* 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).
|
|
136
|
+
* @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListHandoverSlotsResponse>;
|
|
141
|
+
/**
|
|
142
|
+
* 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).
|
|
143
|
+
* @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
|
|
144
|
+
* @param {*} [options] Override http request option.
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Packages>;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* Request parameters for createScheduledPackage operation in EasyShipApi.
|
|
151
|
+
* @export
|
|
152
|
+
* @interface EasyShipApiCreateScheduledPackageRequest
|
|
153
|
+
*/
|
|
154
|
+
export interface EasyShipApiCreateScheduledPackageRequest {
|
|
155
|
+
/**
|
|
156
|
+
* The request schema for the `createScheduledPackage` operation.
|
|
157
|
+
* @type {CreateScheduledPackageRequest}
|
|
158
|
+
* @memberof EasyShipApiCreateScheduledPackage
|
|
159
|
+
*/
|
|
160
|
+
readonly createScheduledPackageRequest: CreateScheduledPackageRequest;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Request parameters for createScheduledPackageBulk operation in EasyShipApi.
|
|
164
|
+
* @export
|
|
165
|
+
* @interface EasyShipApiCreateScheduledPackageBulkRequest
|
|
166
|
+
*/
|
|
167
|
+
export interface EasyShipApiCreateScheduledPackageBulkRequest {
|
|
168
|
+
/**
|
|
169
|
+
* The request schema for the `createScheduledPackageBulk` operation.
|
|
170
|
+
* @type {CreateScheduledPackagesRequest}
|
|
171
|
+
* @memberof EasyShipApiCreateScheduledPackageBulk
|
|
172
|
+
*/
|
|
173
|
+
readonly createScheduledPackagesRequest: CreateScheduledPackagesRequest;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Request parameters for getScheduledPackage operation in EasyShipApi.
|
|
177
|
+
* @export
|
|
178
|
+
* @interface EasyShipApiGetScheduledPackageRequest
|
|
179
|
+
*/
|
|
180
|
+
export interface EasyShipApiGetScheduledPackageRequest {
|
|
181
|
+
/**
|
|
182
|
+
* An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
|
|
183
|
+
* @type {string}
|
|
184
|
+
* @memberof EasyShipApiGetScheduledPackage
|
|
185
|
+
*/
|
|
186
|
+
readonly amazonOrderId: string;
|
|
187
|
+
/**
|
|
188
|
+
* An identifier for the marketplace in which the seller is selling.
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof EasyShipApiGetScheduledPackage
|
|
191
|
+
*/
|
|
192
|
+
readonly marketplaceId: string;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* Request parameters for listHandoverSlots operation in EasyShipApi.
|
|
196
|
+
* @export
|
|
197
|
+
* @interface EasyShipApiListHandoverSlotsRequest
|
|
198
|
+
*/
|
|
199
|
+
export interface EasyShipApiListHandoverSlotsRequest {
|
|
200
|
+
/**
|
|
201
|
+
* The request schema for the `listHandoverSlots` operation.
|
|
202
|
+
* @type {ListHandoverSlotsRequest}
|
|
203
|
+
* @memberof EasyShipApiListHandoverSlots
|
|
204
|
+
*/
|
|
205
|
+
readonly listHandoverSlotsRequest?: ListHandoverSlotsRequest;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Request parameters for updateScheduledPackages operation in EasyShipApi.
|
|
209
|
+
* @export
|
|
210
|
+
* @interface EasyShipApiUpdateScheduledPackagesRequest
|
|
211
|
+
*/
|
|
212
|
+
export interface EasyShipApiUpdateScheduledPackagesRequest {
|
|
213
|
+
/**
|
|
214
|
+
* The request schema for the `updateScheduledPackages` operation.
|
|
215
|
+
* @type {UpdateScheduledPackagesRequest}
|
|
216
|
+
* @memberof EasyShipApiUpdateScheduledPackages
|
|
217
|
+
*/
|
|
218
|
+
readonly updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* EasyShipApi - object-oriented interface
|
|
222
|
+
* @export
|
|
223
|
+
* @class EasyShipApi
|
|
224
|
+
* @extends {BaseAPI}
|
|
225
|
+
*/
|
|
226
|
+
export declare class EasyShipApi extends BaseAPI {
|
|
227
|
+
/**
|
|
228
|
+
* 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).
|
|
229
|
+
* @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
* @memberof EasyShipApi
|
|
233
|
+
*/
|
|
234
|
+
createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Package, any>>;
|
|
235
|
+
/**
|
|
236
|
+
* This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
237
|
+
* @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
|
|
238
|
+
* @param {*} [options] Override http request option.
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
* @memberof EasyShipApi
|
|
241
|
+
*/
|
|
242
|
+
createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateScheduledPackagesResponse, any>>;
|
|
243
|
+
/**
|
|
244
|
+
* 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).
|
|
245
|
+
* @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
* @memberof EasyShipApi
|
|
249
|
+
*/
|
|
250
|
+
getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Package, any>>;
|
|
251
|
+
/**
|
|
252
|
+
* 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).
|
|
253
|
+
* @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
* @memberof EasyShipApi
|
|
257
|
+
*/
|
|
258
|
+
listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListHandoverSlotsResponse, any>>;
|
|
259
|
+
/**
|
|
260
|
+
* 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).
|
|
261
|
+
* @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
|
|
262
|
+
* @param {*} [options] Override http request option.
|
|
263
|
+
* @throws {RequiredError}
|
|
264
|
+
* @memberof EasyShipApi
|
|
265
|
+
*/
|
|
266
|
+
updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Packages, any>>;
|
|
267
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
export * from './api/easy-ship-api';
|
|
@@ -0,0 +1,66 @@
|
|
|
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 { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
export declare const BASE_PATH: string;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const COLLECTION_FORMATS: {
|
|
20
|
+
csv: string;
|
|
21
|
+
ssv: string;
|
|
22
|
+
tsv: string;
|
|
23
|
+
pipes: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @export
|
|
28
|
+
* @interface RequestArgs
|
|
29
|
+
*/
|
|
30
|
+
export interface RequestArgs {
|
|
31
|
+
url: string;
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @class BaseAPI
|
|
38
|
+
*/
|
|
39
|
+
export declare class BaseAPI {
|
|
40
|
+
protected basePath: string;
|
|
41
|
+
protected axios: AxiosInstance;
|
|
42
|
+
protected configuration: Configuration | undefined;
|
|
43
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @class RequiredError
|
|
49
|
+
* @extends {Error}
|
|
50
|
+
*/
|
|
51
|
+
export declare class RequiredError extends Error {
|
|
52
|
+
field: string;
|
|
53
|
+
constructor(field: string, msg?: string);
|
|
54
|
+
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
|
@@ -0,0 +1,65 @@
|
|
|
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 { Configuration } from "./configuration";
|
|
13
|
+
import type { RequestArgs } from "./base";
|
|
14
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const toPathString: (url: URL) => string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -0,0 +1,91 @@
|
|
|
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
|
+
export interface ConfigurationParameters {
|
|
13
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
|
+
username?: string;
|
|
15
|
+
password?: string;
|
|
16
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
|
+
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
19
|
+
baseOptions?: any;
|
|
20
|
+
formDataCtor?: new () => any;
|
|
21
|
+
}
|
|
22
|
+
export declare class Configuration {
|
|
23
|
+
/**
|
|
24
|
+
* parameter for apiKey security
|
|
25
|
+
* @param name security name
|
|
26
|
+
* @memberof Configuration
|
|
27
|
+
*/
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
/**
|
|
30
|
+
* parameter for basic security
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Configuration
|
|
34
|
+
*/
|
|
35
|
+
username?: string;
|
|
36
|
+
/**
|
|
37
|
+
* parameter for basic security
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof Configuration
|
|
41
|
+
*/
|
|
42
|
+
password?: string;
|
|
43
|
+
/**
|
|
44
|
+
* parameter for oauth2 security
|
|
45
|
+
* @param name security name
|
|
46
|
+
* @param scopes oauth2 scope
|
|
47
|
+
* @memberof Configuration
|
|
48
|
+
*/
|
|
49
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
|
+
/**
|
|
51
|
+
* override base path
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof Configuration
|
|
55
|
+
*/
|
|
56
|
+
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
64
|
+
/**
|
|
65
|
+
* base options for axios calls
|
|
66
|
+
*
|
|
67
|
+
* @type {any}
|
|
68
|
+
* @memberof Configuration
|
|
69
|
+
*/
|
|
70
|
+
baseOptions?: any;
|
|
71
|
+
/**
|
|
72
|
+
* The FormData constructor that will be used to create multipart form data
|
|
73
|
+
* requests. You can inject this here so that execution environments that
|
|
74
|
+
* do not support the FormData class can still run the generated client.
|
|
75
|
+
*
|
|
76
|
+
* @type {new () => FormData}
|
|
77
|
+
*/
|
|
78
|
+
formDataCtor?: new () => any;
|
|
79
|
+
constructor(param?: ConfigurationParameters);
|
|
80
|
+
/**
|
|
81
|
+
* Check if the given MIME is a JSON MIME.
|
|
82
|
+
* JSON MIME examples:
|
|
83
|
+
* application/json
|
|
84
|
+
* application/json; charset=UTF8
|
|
85
|
+
* APPLICATION/JSON
|
|
86
|
+
* application/vnd.company+json
|
|
87
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
88
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
89
|
+
*/
|
|
90
|
+
isJsonMime(mime: string): boolean;
|
|
91
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
export * from "./api";
|
|
13
|
+
export * from "./configuration";
|
|
14
|
+
export * from "./models";
|
|
@@ -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
|
+
* An error code that identifies the type of error that occurred. The error codes listed below are specific to the Easy Ship section.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const Code: {
|
|
18
|
+
readonly InvalidInput: "InvalidInput";
|
|
19
|
+
readonly InvalidTimeSlotId: "InvalidTimeSlotId";
|
|
20
|
+
readonly ScheduledPackageAlreadyExists: "ScheduledPackageAlreadyExists";
|
|
21
|
+
readonly ScheduleWindowExpired: "ScheduleWindowExpired";
|
|
22
|
+
readonly RetryableAfterGettingNewSlots: "RetryableAfterGettingNewSlots";
|
|
23
|
+
readonly TimeSlotNotAvailable: "TimeSlotNotAvailable";
|
|
24
|
+
readonly ResourceNotFound: "ResourceNotFound";
|
|
25
|
+
readonly InvalidOrderState: "InvalidOrderState";
|
|
26
|
+
readonly RegionNotSupported: "RegionNotSupported";
|
|
27
|
+
readonly OrderNotEligibleForRescheduling: "OrderNotEligibleForRescheduling";
|
|
28
|
+
readonly InternalServerError: "InternalServerError";
|
|
29
|
+
};
|
|
30
|
+
export type Code = typeof Code[keyof typeof Code];
|