@sp-api-sdk/easy-ship-api-2022-03-23 4.3.11 → 5.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.
Files changed (115) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +642 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/{types/api-model/api/easy-ship-api.d.ts → index.d.cts} +819 -26
  5. package/dist/index.d.ts +1027 -0
  6. package/dist/index.js +594 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/easy-ship-api.js +0 -361
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/code.js +0 -32
  16. package/dist/cjs/api-model/models/create-scheduled-package-request.js +0 -15
  17. package/dist/cjs/api-model/models/create-scheduled-packages-request.js +0 -15
  18. package/dist/cjs/api-model/models/create-scheduled-packages-response.js +0 -15
  19. package/dist/cjs/api-model/models/dimensions.js +0 -15
  20. package/dist/cjs/api-model/models/error-list.js +0 -15
  21. package/dist/cjs/api-model/models/handover-method.js +0 -23
  22. package/dist/cjs/api-model/models/index.js +0 -43
  23. package/dist/cjs/api-model/models/invoice-data.js +0 -15
  24. package/dist/cjs/api-model/models/item.js +0 -15
  25. package/dist/cjs/api-model/models/label-format.js +0 -23
  26. package/dist/cjs/api-model/models/list-handover-slots-request.js +0 -15
  27. package/dist/cjs/api-model/models/list-handover-slots-response.js +0 -15
  28. package/dist/cjs/api-model/models/model-error.js +0 -15
  29. package/dist/cjs/api-model/models/order-schedule-details.js +0 -15
  30. package/dist/cjs/api-model/models/package-details.js +0 -15
  31. package/dist/cjs/api-model/models/package-status.js +0 -33
  32. package/dist/cjs/api-model/models/package.js +0 -15
  33. package/dist/cjs/api-model/models/packages.js +0 -15
  34. package/dist/cjs/api-model/models/rejected-order.js +0 -15
  35. package/dist/cjs/api-model/models/scheduled-package-id.js +0 -15
  36. package/dist/cjs/api-model/models/time-slot.js +0 -15
  37. package/dist/cjs/api-model/models/tracking-details.js +0 -15
  38. package/dist/cjs/api-model/models/unit-of-length.js +0 -22
  39. package/dist/cjs/api-model/models/unit-of-weight.js +0 -23
  40. package/dist/cjs/api-model/models/update-package-details.js +0 -15
  41. package/dist/cjs/api-model/models/update-scheduled-packages-request.js +0 -15
  42. package/dist/cjs/api-model/models/weight.js +0 -15
  43. package/dist/cjs/client.js +0 -49
  44. package/dist/cjs/index.js +0 -19
  45. package/dist/es/api-model/api/easy-ship-api.js +0 -351
  46. package/dist/es/api-model/api.js +0 -14
  47. package/dist/es/api-model/base.js +0 -44
  48. package/dist/es/api-model/common.js +0 -110
  49. package/dist/es/api-model/configuration.js +0 -94
  50. package/dist/es/api-model/index.js +0 -16
  51. package/dist/es/api-model/models/code.js +0 -29
  52. package/dist/es/api-model/models/create-scheduled-package-request.js +0 -14
  53. package/dist/es/api-model/models/create-scheduled-packages-request.js +0 -14
  54. package/dist/es/api-model/models/create-scheduled-packages-response.js +0 -14
  55. package/dist/es/api-model/models/dimensions.js +0 -14
  56. package/dist/es/api-model/models/error-list.js +0 -14
  57. package/dist/es/api-model/models/handover-method.js +0 -20
  58. package/dist/es/api-model/models/index.js +0 -27
  59. package/dist/es/api-model/models/invoice-data.js +0 -14
  60. package/dist/es/api-model/models/item.js +0 -14
  61. package/dist/es/api-model/models/label-format.js +0 -20
  62. package/dist/es/api-model/models/list-handover-slots-request.js +0 -14
  63. package/dist/es/api-model/models/list-handover-slots-response.js +0 -14
  64. package/dist/es/api-model/models/model-error.js +0 -14
  65. package/dist/es/api-model/models/order-schedule-details.js +0 -14
  66. package/dist/es/api-model/models/package-details.js +0 -14
  67. package/dist/es/api-model/models/package-status.js +0 -30
  68. package/dist/es/api-model/models/package.js +0 -14
  69. package/dist/es/api-model/models/packages.js +0 -14
  70. package/dist/es/api-model/models/rejected-order.js +0 -14
  71. package/dist/es/api-model/models/scheduled-package-id.js +0 -14
  72. package/dist/es/api-model/models/time-slot.js +0 -14
  73. package/dist/es/api-model/models/tracking-details.js +0 -14
  74. package/dist/es/api-model/models/unit-of-length.js +0 -19
  75. package/dist/es/api-model/models/unit-of-weight.js +0 -20
  76. package/dist/es/api-model/models/update-package-details.js +0 -14
  77. package/dist/es/api-model/models/update-scheduled-packages-request.js +0 -14
  78. package/dist/es/api-model/models/weight.js +0 -14
  79. package/dist/es/client.js +0 -45
  80. package/dist/es/index.js +0 -3
  81. package/dist/types/api-model/api.d.ts +0 -12
  82. package/dist/types/api-model/base.d.ts +0 -42
  83. package/dist/types/api-model/common.d.ts +0 -34
  84. package/dist/types/api-model/configuration.d.ts +0 -98
  85. package/dist/types/api-model/index.d.ts +0 -14
  86. package/dist/types/api-model/models/code.d.ts +0 -28
  87. package/dist/types/api-model/models/create-scheduled-package-request.d.ts +0 -26
  88. package/dist/types/api-model/models/create-scheduled-packages-request.d.ts +0 -27
  89. package/dist/types/api-model/models/create-scheduled-packages-response.d.ts +0 -30
  90. package/dist/types/api-model/models/dimensions.d.ts +0 -34
  91. package/dist/types/api-model/models/error-list.d.ts +0 -20
  92. package/dist/types/api-model/models/handover-method.d.ts +0 -19
  93. package/dist/types/api-model/models/index.d.ts +0 -27
  94. package/dist/types/api-model/models/invoice-data.d.ts +0 -24
  95. package/dist/types/api-model/models/item.d.ts +0 -24
  96. package/dist/types/api-model/models/label-format.d.ts +0 -19
  97. package/dist/types/api-model/models/list-handover-slots-request.d.ts +0 -28
  98. package/dist/types/api-model/models/list-handover-slots-response.d.ts +0 -25
  99. package/dist/types/api-model/models/model-error.d.ts +0 -28
  100. package/dist/types/api-model/models/order-schedule-details.d.ts +0 -22
  101. package/dist/types/api-model/models/package-details.d.ts +0 -27
  102. package/dist/types/api-model/models/package-status.d.ts +0 -29
  103. package/dist/types/api-model/models/package.d.ts +0 -39
  104. package/dist/types/api-model/models/packages.d.ts +0 -21
  105. package/dist/types/api-model/models/rejected-order.d.ts +0 -21
  106. package/dist/types/api-model/models/scheduled-package-id.d.ts +0 -24
  107. package/dist/types/api-model/models/time-slot.d.ts +0 -30
  108. package/dist/types/api-model/models/tracking-details.d.ts +0 -20
  109. package/dist/types/api-model/models/unit-of-length.d.ts +0 -18
  110. package/dist/types/api-model/models/unit-of-weight.d.ts +0 -19
  111. package/dist/types/api-model/models/update-package-details.d.ts +0 -20
  112. package/dist/types/api-model/models/update-scheduled-packages-request.d.ts +0 -25
  113. package/dist/types/api-model/models/weight.d.ts +0 -22
  114. package/dist/types/client.d.ts +0 -6
  115. package/dist/types/index.d.ts +0 -3
@@ -1,15 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Selling Partner API for Easy Ship
6
- * Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
7
- *
8
- * The version of the OpenAPI document: 2022-03-23
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,15 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Selling Partner API for Easy Ship
6
- * Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
7
- *
8
- * The version of the OpenAPI document: 2022-03-23
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,15 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Selling Partner API for Easy Ship
6
- * Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
7
- *
8
- * The version of the OpenAPI document: 2022-03-23
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,49 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EasyShipApiClient = exports.clientRateLimits = void 0;
4
- const common_1 = require("@sp-api-sdk/common");
5
- const api_model_1 = require("./api-model");
6
- exports.clientRateLimits = [
7
- {
8
- method: 'post',
9
- // eslint-disable-next-line prefer-regex-literals
10
- urlRegex: new RegExp('^/easyShip/2022-03-23/timeSlot$'),
11
- rate: 1,
12
- burst: 5,
13
- },
14
- {
15
- method: 'get',
16
- // eslint-disable-next-line prefer-regex-literals
17
- urlRegex: new RegExp('^/easyShip/2022-03-23/package$'),
18
- rate: 1,
19
- burst: 5,
20
- },
21
- {
22
- method: 'post',
23
- // eslint-disable-next-line prefer-regex-literals
24
- urlRegex: new RegExp('^/easyShip/2022-03-23/package$'),
25
- rate: 1,
26
- burst: 5,
27
- },
28
- {
29
- method: 'patch',
30
- // eslint-disable-next-line prefer-regex-literals
31
- urlRegex: new RegExp('^/easyShip/2022-03-23/package$'),
32
- rate: 1,
33
- burst: 5,
34
- },
35
- {
36
- method: 'post',
37
- // eslint-disable-next-line prefer-regex-literals
38
- urlRegex: new RegExp('^/easyShip/2022-03-23/packages/bulk$'),
39
- rate: 1,
40
- burst: 5,
41
- },
42
- ];
43
- class EasyShipApiClient extends api_model_1.EasyShipApi {
44
- constructor(configuration) {
45
- const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
46
- super(new api_model_1.Configuration(), endpoint, axios);
47
- }
48
- }
49
- exports.EasyShipApiClient = EasyShipApiClient;
package/dist/cjs/index.js DELETED
@@ -1,19 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./client"), exports);
18
- __exportStar(require("./api-model/api"), exports);
19
- __exportStar(require("./api-model/models"), exports);
@@ -1,351 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Easy Ship
5
- * Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
6
- *
7
- * The version of the OpenAPI document: 2022-03-23
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import globalAxios from 'axios';
15
- // Some imports not used depending on template conditions
16
- // @ts-ignore
17
- import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
18
- // @ts-ignore
19
- import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
20
- /**
21
- * EasyShipApi - axios parameter creator
22
- */
23
- export const EasyShipApiAxiosParamCreator = function (configuration) {
24
- return {
25
- /**
26
- * 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).
27
- * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
28
- * @param {*} [options] Override http request option.
29
- * @throws {RequiredError}
30
- */
31
- createScheduledPackage: async (createScheduledPackageRequest, options = {}) => {
32
- // verify required parameter 'createScheduledPackageRequest' is not null or undefined
33
- assertParamExists('createScheduledPackage', 'createScheduledPackageRequest', createScheduledPackageRequest);
34
- const localVarPath = `/easyShip/2022-03-23/package`;
35
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
36
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
37
- let baseOptions;
38
- if (configuration) {
39
- baseOptions = configuration.baseOptions;
40
- }
41
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
42
- const localVarHeaderParameter = {};
43
- const localVarQueryParameter = {};
44
- localVarHeaderParameter['Content-Type'] = 'application/json';
45
- localVarHeaderParameter['Accept'] = 'application/json';
46
- setSearchParams(localVarUrlObj, localVarQueryParameter);
47
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
48
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
49
- localVarRequestOptions.data = serializeDataIfNeeded(createScheduledPackageRequest, localVarRequestOptions, configuration);
50
- return {
51
- url: toPathString(localVarUrlObj),
52
- options: localVarRequestOptions,
53
- };
54
- },
55
- /**
56
- * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
57
- * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation.
58
- * @param {*} [options] Override http request option.
59
- * @throws {RequiredError}
60
- */
61
- createScheduledPackageBulk: async (createScheduledPackagesRequest, options = {}) => {
62
- // verify required parameter 'createScheduledPackagesRequest' is not null or undefined
63
- assertParamExists('createScheduledPackageBulk', 'createScheduledPackagesRequest', createScheduledPackagesRequest);
64
- const localVarPath = `/easyShip/2022-03-23/packages/bulk`;
65
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
66
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
67
- let baseOptions;
68
- if (configuration) {
69
- baseOptions = configuration.baseOptions;
70
- }
71
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
72
- const localVarHeaderParameter = {};
73
- const localVarQueryParameter = {};
74
- localVarHeaderParameter['Content-Type'] = 'application/json';
75
- localVarHeaderParameter['Accept'] = 'application/json';
76
- setSearchParams(localVarUrlObj, localVarQueryParameter);
77
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
78
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
79
- localVarRequestOptions.data = serializeDataIfNeeded(createScheduledPackagesRequest, localVarRequestOptions, configuration);
80
- return {
81
- url: toPathString(localVarUrlObj),
82
- options: localVarRequestOptions,
83
- };
84
- },
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: async (amazonOrderId, marketplaceId, options = {}) => {
93
- // verify required parameter 'amazonOrderId' is not null or undefined
94
- assertParamExists('getScheduledPackage', 'amazonOrderId', amazonOrderId);
95
- // verify required parameter 'marketplaceId' is not null or undefined
96
- assertParamExists('getScheduledPackage', 'marketplaceId', marketplaceId);
97
- const localVarPath = `/easyShip/2022-03-23/package`;
98
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
99
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
100
- let baseOptions;
101
- if (configuration) {
102
- baseOptions = configuration.baseOptions;
103
- }
104
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
105
- const localVarHeaderParameter = {};
106
- const localVarQueryParameter = {};
107
- if (amazonOrderId !== undefined) {
108
- localVarQueryParameter['amazonOrderId'] = amazonOrderId;
109
- }
110
- if (marketplaceId !== undefined) {
111
- localVarQueryParameter['marketplaceId'] = marketplaceId;
112
- }
113
- localVarHeaderParameter['Accept'] = 'application/json';
114
- setSearchParams(localVarUrlObj, localVarQueryParameter);
115
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
116
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
117
- return {
118
- url: toPathString(localVarUrlObj),
119
- options: localVarRequestOptions,
120
- };
121
- },
122
- /**
123
- * 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).
124
- * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation.
125
- * @param {*} [options] Override http request option.
126
- * @throws {RequiredError}
127
- */
128
- listHandoverSlots: async (listHandoverSlotsRequest, options = {}) => {
129
- const localVarPath = `/easyShip/2022-03-23/timeSlot`;
130
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
131
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
132
- let baseOptions;
133
- if (configuration) {
134
- baseOptions = configuration.baseOptions;
135
- }
136
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
137
- const localVarHeaderParameter = {};
138
- const localVarQueryParameter = {};
139
- localVarHeaderParameter['Content-Type'] = 'application/json';
140
- localVarHeaderParameter['Accept'] = 'application/json';
141
- setSearchParams(localVarUrlObj, localVarQueryParameter);
142
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
143
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
144
- localVarRequestOptions.data = serializeDataIfNeeded(listHandoverSlotsRequest, localVarRequestOptions, configuration);
145
- return {
146
- url: toPathString(localVarUrlObj),
147
- options: localVarRequestOptions,
148
- };
149
- },
150
- /**
151
- * 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).
152
- * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation.
153
- * @param {*} [options] Override http request option.
154
- * @throws {RequiredError}
155
- */
156
- updateScheduledPackages: async (updateScheduledPackagesRequest, options = {}) => {
157
- const localVarPath = `/easyShip/2022-03-23/package`;
158
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
159
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
160
- let baseOptions;
161
- if (configuration) {
162
- baseOptions = configuration.baseOptions;
163
- }
164
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options };
165
- const localVarHeaderParameter = {};
166
- const localVarQueryParameter = {};
167
- localVarHeaderParameter['Content-Type'] = 'application/json';
168
- localVarHeaderParameter['Accept'] = 'application/json';
169
- setSearchParams(localVarUrlObj, localVarQueryParameter);
170
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
171
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
172
- localVarRequestOptions.data = serializeDataIfNeeded(updateScheduledPackagesRequest, localVarRequestOptions, configuration);
173
- return {
174
- url: toPathString(localVarUrlObj),
175
- options: localVarRequestOptions,
176
- };
177
- },
178
- };
179
- };
180
- /**
181
- * EasyShipApi - functional programming interface
182
- */
183
- export const EasyShipApiFp = function (configuration) {
184
- const localVarAxiosParamCreator = EasyShipApiAxiosParamCreator(configuration);
185
- return {
186
- /**
187
- * 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).
188
- * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
189
- * @param {*} [options] Override http request option.
190
- * @throws {RequiredError}
191
- */
192
- async createScheduledPackage(createScheduledPackageRequest, options) {
193
- const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledPackage(createScheduledPackageRequest, options);
194
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
195
- const localVarOperationServerBasePath = operationServerMap['EasyShipApi.createScheduledPackage']?.[localVarOperationServerIndex]?.url;
196
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
197
- },
198
- /**
199
- * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
200
- * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation.
201
- * @param {*} [options] Override http request option.
202
- * @throws {RequiredError}
203
- */
204
- async createScheduledPackageBulk(createScheduledPackagesRequest, options) {
205
- const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledPackageBulk(createScheduledPackagesRequest, options);
206
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
207
- const localVarOperationServerBasePath = operationServerMap['EasyShipApi.createScheduledPackageBulk']?.[localVarOperationServerIndex]?.url;
208
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
209
- },
210
- /**
211
- * 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).
212
- * @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
213
- * @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
214
- * @param {*} [options] Override http request option.
215
- * @throws {RequiredError}
216
- */
217
- async getScheduledPackage(amazonOrderId, marketplaceId, options) {
218
- const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduledPackage(amazonOrderId, marketplaceId, options);
219
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
220
- const localVarOperationServerBasePath = operationServerMap['EasyShipApi.getScheduledPackage']?.[localVarOperationServerIndex]?.url;
221
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
222
- },
223
- /**
224
- * 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).
225
- * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation.
226
- * @param {*} [options] Override http request option.
227
- * @throws {RequiredError}
228
- */
229
- async listHandoverSlots(listHandoverSlotsRequest, options) {
230
- const localVarAxiosArgs = await localVarAxiosParamCreator.listHandoverSlots(listHandoverSlotsRequest, options);
231
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
232
- const localVarOperationServerBasePath = operationServerMap['EasyShipApi.listHandoverSlots']?.[localVarOperationServerIndex]?.url;
233
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
234
- },
235
- /**
236
- * 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).
237
- * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation.
238
- * @param {*} [options] Override http request option.
239
- * @throws {RequiredError}
240
- */
241
- async updateScheduledPackages(updateScheduledPackagesRequest, options) {
242
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledPackages(updateScheduledPackagesRequest, options);
243
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
244
- const localVarOperationServerBasePath = operationServerMap['EasyShipApi.updateScheduledPackages']?.[localVarOperationServerIndex]?.url;
245
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
246
- },
247
- };
248
- };
249
- /**
250
- * EasyShipApi - factory interface
251
- */
252
- export const EasyShipApiFactory = function (configuration, basePath, axios) {
253
- const localVarFp = EasyShipApiFp(configuration);
254
- return {
255
- /**
256
- * 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).
257
- * @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
258
- * @param {*} [options] Override http request option.
259
- * @throws {RequiredError}
260
- */
261
- createScheduledPackage(requestParameters, options) {
262
- return localVarFp.createScheduledPackage(requestParameters.createScheduledPackageRequest, options).then((request) => request(axios, basePath));
263
- },
264
- /**
265
- * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
266
- * @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
267
- * @param {*} [options] Override http request option.
268
- * @throws {RequiredError}
269
- */
270
- createScheduledPackageBulk(requestParameters, options) {
271
- return localVarFp.createScheduledPackageBulk(requestParameters.createScheduledPackagesRequest, options).then((request) => request(axios, basePath));
272
- },
273
- /**
274
- * 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).
275
- * @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
276
- * @param {*} [options] Override http request option.
277
- * @throws {RequiredError}
278
- */
279
- getScheduledPackage(requestParameters, options) {
280
- return localVarFp.getScheduledPackage(requestParameters.amazonOrderId, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
281
- },
282
- /**
283
- * 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).
284
- * @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
285
- * @param {*} [options] Override http request option.
286
- * @throws {RequiredError}
287
- */
288
- listHandoverSlots(requestParameters = {}, options) {
289
- return localVarFp.listHandoverSlots(requestParameters.listHandoverSlotsRequest, options).then((request) => request(axios, basePath));
290
- },
291
- /**
292
- * 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).
293
- * @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
294
- * @param {*} [options] Override http request option.
295
- * @throws {RequiredError}
296
- */
297
- updateScheduledPackages(requestParameters = {}, options) {
298
- return localVarFp.updateScheduledPackages(requestParameters.updateScheduledPackagesRequest, options).then((request) => request(axios, basePath));
299
- },
300
- };
301
- };
302
- /**
303
- * EasyShipApi - object-oriented interface
304
- */
305
- export class EasyShipApi extends BaseAPI {
306
- /**
307
- * 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).
308
- * @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
309
- * @param {*} [options] Override http request option.
310
- * @throws {RequiredError}
311
- */
312
- createScheduledPackage(requestParameters, options) {
313
- return EasyShipApiFp(this.configuration).createScheduledPackage(requestParameters.createScheduledPackageRequest, options).then((request) => request(this.axios, this.basePath));
314
- }
315
- /**
316
- * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
317
- * @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
318
- * @param {*} [options] Override http request option.
319
- * @throws {RequiredError}
320
- */
321
- createScheduledPackageBulk(requestParameters, options) {
322
- return EasyShipApiFp(this.configuration).createScheduledPackageBulk(requestParameters.createScheduledPackagesRequest, options).then((request) => request(this.axios, this.basePath));
323
- }
324
- /**
325
- * 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).
326
- * @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
327
- * @param {*} [options] Override http request option.
328
- * @throws {RequiredError}
329
- */
330
- getScheduledPackage(requestParameters, options) {
331
- return EasyShipApiFp(this.configuration).getScheduledPackage(requestParameters.amazonOrderId, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
332
- }
333
- /**
334
- * 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).
335
- * @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
336
- * @param {*} [options] Override http request option.
337
- * @throws {RequiredError}
338
- */
339
- listHandoverSlots(requestParameters = {}, options) {
340
- return EasyShipApiFp(this.configuration).listHandoverSlots(requestParameters.listHandoverSlotsRequest, options).then((request) => request(this.axios, this.basePath));
341
- }
342
- /**
343
- * 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).
344
- * @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
345
- * @param {*} [options] Override http request option.
346
- * @throws {RequiredError}
347
- */
348
- updateScheduledPackages(requestParameters = {}, options) {
349
- return EasyShipApiFp(this.configuration).updateScheduledPackages(requestParameters.updateScheduledPackagesRequest, options).then((request) => request(this.axios, this.basePath));
350
- }
351
- }
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Easy Ship
5
- * Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
6
- *
7
- * The version of the OpenAPI document: 2022-03-23
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export * from './api/easy-ship-api';
@@ -1,44 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Easy Ship
5
- * Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).
6
- *
7
- * The version of the OpenAPI document: 2022-03-23
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import globalAxios from 'axios';
15
- export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
16
- export const COLLECTION_FORMATS = {
17
- csv: ",",
18
- ssv: " ",
19
- tsv: "\t",
20
- pipes: "|",
21
- };
22
- export class BaseAPI {
23
- basePath;
24
- axios;
25
- configuration;
26
- constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
27
- this.basePath = basePath;
28
- this.axios = axios;
29
- if (configuration) {
30
- this.configuration = configuration;
31
- this.basePath = configuration.basePath ?? basePath;
32
- }
33
- }
34
- }
35
- ;
36
- export class RequiredError extends Error {
37
- field;
38
- constructor(field, msg) {
39
- super(msg);
40
- this.field = field;
41
- this.name = "RequiredError";
42
- }
43
- }
44
- export const operationServerMap = {};