@sp-api-sdk/easy-ship-api-2022-03-23 4.3.12 → 5.1.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 (116) hide show
  1. package/README.md +7 -8
  2. package/dist/index.cjs +715 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +877 -0
  5. package/dist/index.d.ts +877 -0
  6. package/dist/index.js +680 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +26 -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/easy-ship-api.d.ts +0 -234
  82. package/dist/types/api-model/api.d.ts +0 -12
  83. package/dist/types/api-model/base.d.ts +0 -42
  84. package/dist/types/api-model/common.d.ts +0 -34
  85. package/dist/types/api-model/configuration.d.ts +0 -98
  86. package/dist/types/api-model/index.d.ts +0 -14
  87. package/dist/types/api-model/models/code.d.ts +0 -28
  88. package/dist/types/api-model/models/create-scheduled-package-request.d.ts +0 -26
  89. package/dist/types/api-model/models/create-scheduled-packages-request.d.ts +0 -27
  90. package/dist/types/api-model/models/create-scheduled-packages-response.d.ts +0 -30
  91. package/dist/types/api-model/models/dimensions.d.ts +0 -34
  92. package/dist/types/api-model/models/error-list.d.ts +0 -20
  93. package/dist/types/api-model/models/handover-method.d.ts +0 -19
  94. package/dist/types/api-model/models/index.d.ts +0 -27
  95. package/dist/types/api-model/models/invoice-data.d.ts +0 -24
  96. package/dist/types/api-model/models/item.d.ts +0 -24
  97. package/dist/types/api-model/models/label-format.d.ts +0 -19
  98. package/dist/types/api-model/models/list-handover-slots-request.d.ts +0 -28
  99. package/dist/types/api-model/models/list-handover-slots-response.d.ts +0 -25
  100. package/dist/types/api-model/models/model-error.d.ts +0 -28
  101. package/dist/types/api-model/models/order-schedule-details.d.ts +0 -22
  102. package/dist/types/api-model/models/package-details.d.ts +0 -27
  103. package/dist/types/api-model/models/package-status.d.ts +0 -29
  104. package/dist/types/api-model/models/package.d.ts +0 -39
  105. package/dist/types/api-model/models/packages.d.ts +0 -21
  106. package/dist/types/api-model/models/rejected-order.d.ts +0 -21
  107. package/dist/types/api-model/models/scheduled-package-id.d.ts +0 -24
  108. package/dist/types/api-model/models/time-slot.d.ts +0 -30
  109. package/dist/types/api-model/models/tracking-details.d.ts +0 -20
  110. package/dist/types/api-model/models/unit-of-length.d.ts +0 -18
  111. package/dist/types/api-model/models/unit-of-weight.d.ts +0 -19
  112. package/dist/types/api-model/models/update-package-details.d.ts +0 -20
  113. package/dist/types/api-model/models/update-scheduled-packages-request.d.ts +0 -25
  114. package/dist/types/api-model/models/weight.d.ts +0 -22
  115. package/dist/types/client.d.ts +0 -6
  116. package/dist/types/index.d.ts +0 -3
@@ -1,19 +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
- /**
15
- * The unit of measurement used to measure the length.
16
- */
17
- export const UnitOfLength = {
18
- Cm: 'cm',
19
- };
@@ -1,20 +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
- /**
15
- * The unit of measurement used to measure the weight.
16
- */
17
- export const UnitOfWeight = {
18
- Grams: 'grams',
19
- G: 'g',
20
- };
@@ -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 {};
@@ -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 {};
@@ -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 {};
package/dist/es/client.js DELETED
@@ -1,45 +0,0 @@
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 DELETED
@@ -1,3 +0,0 @@
1
- export * from './client';
2
- export * from './api-model/api';
3
- export * from './api-model/models';
@@ -1,234 +0,0 @@
1
- /**
2
- * Selling Partner API for Easy Ship
3
- * 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).
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
- */
27
- export declare const EasyShipApiAxiosParamCreator: (configuration?: Configuration) => {
28
- /**
29
- * 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).
30
- * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation.
31
- * @param {*} [options] Override http request option.
32
- * @throws {RequiredError}
33
- */
34
- createScheduledPackage: (createScheduledPackageRequest: CreateScheduledPackageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
- /**
36
- * 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).
37
- * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the &#x60;createScheduledPackageBulk&#x60; operation.
38
- * @param {*} [options] Override http request option.
39
- * @throws {RequiredError}
40
- */
41
- createScheduledPackageBulk: (createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
42
- /**
43
- * 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).
44
- * @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
45
- * @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- getScheduledPackage: (amazonOrderId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50
- /**
51
- * 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).
52
- * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the &#x60;listHandoverSlots&#x60; operation.
53
- * @param {*} [options] Override http request option.
54
- * @throws {RequiredError}
55
- */
56
- listHandoverSlots: (listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
57
- /**
58
- * 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).
59
- * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the &#x60;updateScheduledPackages&#x60; operation.
60
- * @param {*} [options] Override http request option.
61
- * @throws {RequiredError}
62
- */
63
- updateScheduledPackages: (updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
64
- };
65
- /**
66
- * EasyShipApi - functional programming interface
67
- */
68
- export declare const EasyShipApiFp: (configuration?: Configuration) => {
69
- /**
70
- * 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).
71
- * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the &#x60;createScheduledPackage&#x60; operation.
72
- * @param {*} [options] Override http request option.
73
- * @throws {RequiredError}
74
- */
75
- createScheduledPackage(createScheduledPackageRequest: CreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
76
- /**
77
- * 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).
78
- * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the &#x60;createScheduledPackageBulk&#x60; operation.
79
- * @param {*} [options] Override http request option.
80
- * @throws {RequiredError}
81
- */
82
- createScheduledPackageBulk(createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateScheduledPackagesResponse>>;
83
- /**
84
- * 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).
85
- * @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
86
- * @param {string} marketplaceId An identifier for the marketplace in which the seller is selling.
87
- * @param {*} [options] Override http request option.
88
- * @throws {RequiredError}
89
- */
90
- getScheduledPackage(amazonOrderId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
91
- /**
92
- * 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).
93
- * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the &#x60;listHandoverSlots&#x60; operation.
94
- * @param {*} [options] Override http request option.
95
- * @throws {RequiredError}
96
- */
97
- listHandoverSlots(listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListHandoverSlotsResponse>>;
98
- /**
99
- * 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).
100
- * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the &#x60;updateScheduledPackages&#x60; operation.
101
- * @param {*} [options] Override http request option.
102
- * @throws {RequiredError}
103
- */
104
- updateScheduledPackages(updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Packages>>;
105
- };
106
- /**
107
- * EasyShipApi - factory interface
108
- */
109
- export declare const EasyShipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
110
- /**
111
- * 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).
112
- * @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
113
- * @param {*} [options] Override http request option.
114
- * @throws {RequiredError}
115
- */
116
- createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
117
- /**
118
- * 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).
119
- * @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
120
- * @param {*} [options] Override http request option.
121
- * @throws {RequiredError}
122
- */
123
- createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateScheduledPackagesResponse>;
124
- /**
125
- * 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).
126
- * @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
127
- * @param {*} [options] Override http request option.
128
- * @throws {RequiredError}
129
- */
130
- getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
131
- /**
132
- * 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).
133
- * @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
134
- * @param {*} [options] Override http request option.
135
- * @throws {RequiredError}
136
- */
137
- listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListHandoverSlotsResponse>;
138
- /**
139
- * 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).
140
- * @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
141
- * @param {*} [options] Override http request option.
142
- * @throws {RequiredError}
143
- */
144
- updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Packages>;
145
- };
146
- /**
147
- * Request parameters for createScheduledPackage operation in EasyShipApi.
148
- */
149
- export interface EasyShipApiCreateScheduledPackageRequest {
150
- /**
151
- * The request schema for the &#x60;createScheduledPackage&#x60; operation.
152
- */
153
- readonly createScheduledPackageRequest: CreateScheduledPackageRequest;
154
- }
155
- /**
156
- * Request parameters for createScheduledPackageBulk operation in EasyShipApi.
157
- */
158
- export interface EasyShipApiCreateScheduledPackageBulkRequest {
159
- /**
160
- * The request schema for the &#x60;createScheduledPackageBulk&#x60; operation.
161
- */
162
- readonly createScheduledPackagesRequest: CreateScheduledPackagesRequest;
163
- }
164
- /**
165
- * Request parameters for getScheduledPackage operation in EasyShipApi.
166
- */
167
- export interface EasyShipApiGetScheduledPackageRequest {
168
- /**
169
- * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
170
- */
171
- readonly amazonOrderId: string;
172
- /**
173
- * An identifier for the marketplace in which the seller is selling.
174
- */
175
- readonly marketplaceId: string;
176
- }
177
- /**
178
- * Request parameters for listHandoverSlots operation in EasyShipApi.
179
- */
180
- export interface EasyShipApiListHandoverSlotsRequest {
181
- /**
182
- * The request schema for the &#x60;listHandoverSlots&#x60; operation.
183
- */
184
- readonly listHandoverSlotsRequest?: ListHandoverSlotsRequest;
185
- }
186
- /**
187
- * Request parameters for updateScheduledPackages operation in EasyShipApi.
188
- */
189
- export interface EasyShipApiUpdateScheduledPackagesRequest {
190
- /**
191
- * The request schema for the &#x60;updateScheduledPackages&#x60; operation.
192
- */
193
- readonly updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest;
194
- }
195
- /**
196
- * EasyShipApi - object-oriented interface
197
- */
198
- export declare class EasyShipApi extends BaseAPI {
199
- /**
200
- * 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).
201
- * @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters.
202
- * @param {*} [options] Override http request option.
203
- * @throws {RequiredError}
204
- */
205
- createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Package, any, {}>>;
206
- /**
207
- * 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).
208
- * @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters.
209
- * @param {*} [options] Override http request option.
210
- * @throws {RequiredError}
211
- */
212
- createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateScheduledPackagesResponse, any, {}>>;
213
- /**
214
- * 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).
215
- * @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters.
216
- * @param {*} [options] Override http request option.
217
- * @throws {RequiredError}
218
- */
219
- getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Package, any, {}>>;
220
- /**
221
- * 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).
222
- * @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters.
223
- * @param {*} [options] Override http request option.
224
- * @throws {RequiredError}
225
- */
226
- listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListHandoverSlotsResponse, any, {}>>;
227
- /**
228
- * 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).
229
- * @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters.
230
- * @param {*} [options] Override http request option.
231
- * @throws {RequiredError}
232
- */
233
- updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Packages, any, {}>>;
234
- }
@@ -1,12 +0,0 @@
1
- /**
2
- * Selling Partner API for Easy Ship
3
- * 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).
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';
@@ -1,42 +0,0 @@
1
- /**
2
- * Selling Partner API for Easy Ship
3
- * 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).
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
- export declare const COLLECTION_FORMATS: {
16
- csv: string;
17
- ssv: string;
18
- tsv: string;
19
- pipes: string;
20
- };
21
- export interface RequestArgs {
22
- url: string;
23
- options: RawAxiosRequestConfig;
24
- }
25
- export declare class BaseAPI {
26
- protected basePath: string;
27
- protected axios: AxiosInstance;
28
- protected configuration: Configuration | undefined;
29
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
- }
31
- export declare class RequiredError extends Error {
32
- field: string;
33
- constructor(field: string, msg?: string);
34
- }
35
- interface ServerMap {
36
- [key: string]: {
37
- url: string;
38
- description: string;
39
- }[];
40
- }
41
- export declare const operationServerMap: ServerMap;
42
- export {};
@@ -1,34 +0,0 @@
1
- /**
2
- * Selling Partner API for Easy Ship
3
- * 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).
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
- export declare const DUMMY_BASE_URL = "https://example.com";
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
21
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
22
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
23
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
24
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
25
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
26
- /**
27
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
30
- */
31
- export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
32
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
33
- export declare const toPathString: (url: URL) => string;
34
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -1,98 +0,0 @@
1
- /**
2
- * Selling Partner API for Easy Ship
3
- * 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).
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
- interface AWSv4Configuration {
13
- options?: {
14
- region?: string;
15
- service?: string;
16
- };
17
- credentials?: {
18
- accessKeyId?: string;
19
- secretAccessKey?: string;
20
- sessionToken?: string;
21
- };
22
- }
23
- export interface ConfigurationParameters {
24
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
- username?: string;
26
- password?: string;
27
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
- awsv4?: AWSv4Configuration;
29
- basePath?: string;
30
- serverIndex?: number;
31
- baseOptions?: any;
32
- formDataCtor?: new () => any;
33
- }
34
- export declare class Configuration {
35
- /**
36
- * parameter for apiKey security
37
- * @param name security name
38
- */
39
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
- /**
41
- * parameter for basic security
42
- */
43
- username?: string;
44
- /**
45
- * parameter for basic security
46
- */
47
- password?: string;
48
- /**
49
- * parameter for oauth2 security
50
- * @param name security name
51
- * @param scopes oauth2 scope
52
- */
53
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
- /**
55
- * parameter for aws4 signature security
56
- * @param {Object} AWS4Signature - AWS4 Signature security
57
- * @param {string} options.region - aws region
58
- * @param {string} options.service - name of the service.
59
- * @param {string} credentials.accessKeyId - aws access key id
60
- * @param {string} credentials.secretAccessKey - aws access key
61
- * @param {string} credentials.sessionToken - aws session token
62
- * @memberof Configuration
63
- */
64
- awsv4?: AWSv4Configuration;
65
- /**
66
- * override base path
67
- */
68
- basePath?: string;
69
- /**
70
- * override server index
71
- */
72
- serverIndex?: number;
73
- /**
74
- * base options for axios calls
75
- */
76
- baseOptions?: any;
77
- /**
78
- * The FormData constructor that will be used to create multipart form data
79
- * requests. You can inject this here so that execution environments that
80
- * do not support the FormData class can still run the generated client.
81
- *
82
- * @type {new () => FormData}
83
- */
84
- formDataCtor?: new () => any;
85
- constructor(param?: ConfigurationParameters);
86
- /**
87
- * Check if the given MIME is a JSON MIME.
88
- * JSON MIME examples:
89
- * application/json
90
- * application/json; charset=UTF8
91
- * APPLICATION/JSON
92
- * application/vnd.company+json
93
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
94
- * @return True if the given MIME is JSON, false otherwise.
95
- */
96
- isJsonMime(mime: string): boolean;
97
- }
98
- export {};
@@ -1,14 +0,0 @@
1
- /**
2
- * Selling Partner API for Easy Ship
3
- * 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).
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";