From 9c6decdc23074dc1bbb02659a5c9092eef5fb20a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 13 Sep 2024 05:11:09 +0000 Subject: [PATCH] feat: Update API models (#1111) amazon-warehousing-and-distribution-model: - Quantity details at SKU level for the shipment. - Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center. fulfillment-outbound-api-model: - A delivery document for a package - The delivery information for the package listings-items-api-model-v20210801: - Add a function to Search for and return list of listings items and respective details for a selling partner sellers-api-model: - Add a function to Return information about a seller account and its marketplaces vendor-orders-api-model: - Retrieve The unit of measure for prices of items sold by weight Co-authored-by: nguyentoanit <19872073+nguyentoanit@users.noreply.github.com> --- .../api.ts | 117 ++- .../base.ts | 4 +- .../common.ts | 4 +- .../configuration.ts | 4 +- .../index.ts | 4 +- .../catalog-items-api-model-v20220401/api.ts | 16 +- .../feeds-api-model-v20210630/api.ts | 48 +- .../fulfillment-outbound-api-model/api.ts | 178 +++-- src/api-models/index.ts | 34 +- .../listings-items-api-model-v20210801/api.ts | 246 ++++++ .../merchant-fulfillment-api-model/api.ts | 112 +-- .../merchant-fulfillment-api-model/base.ts | 2 +- .../merchant-fulfillment-api-model/common.ts | 2 +- .../configuration.ts | 2 +- .../merchant-fulfillment-api-model/index.ts | 2 +- src/api-models/orders-api-model/api.ts | 728 ++++++++++++++---- src/api-models/orders-api-model/base.ts | 2 +- src/api-models/orders-api-model/common.ts | 2 +- .../orders-api-model/configuration.ts | 2 +- src/api-models/orders-api-model/index.ts | 2 +- .../api.ts | 2 +- src/api-models/sellers-api-model/api.ts | 302 +++++++- src/api-models/sellers-api-model/base.ts | 2 +- src/api-models/sellers-api-model/common.ts | 2 +- .../sellers-api-model/configuration.ts | 2 +- src/api-models/sellers-api-model/index.ts | 2 +- src/api-models/vendor-orders-api-model/api.ts | 224 +++--- 27 files changed, 1541 insertions(+), 506 deletions(-) diff --git a/src/api-models/amazon-warehousing-and-distribution-model/api.ts b/src/api-models/amazon-warehousing-and-distribution-model/api.ts index e537d457..0044852b 100644 --- a/src/api-models/amazon-warehousing-and-distribution-model/api.ts +++ b/src/api-models/amazon-warehousing-and-distribution-model/api.ts @@ -1,8 +1,8 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for AWD - * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * The Selling Partner API for Amazon Warehousing and Distribution + * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. * * The version of the OpenAPI document: 2024-05-09 * @@ -284,6 +284,12 @@ export interface InboundShipment { * @memberof InboundShipment */ shipmentId: string; + /** + * Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW. + * @type {Array} + * @memberof InboundShipment + */ + shipmentSkuQuantities?: Array; /** * * @type {InboundShipmentStatus} @@ -452,6 +458,12 @@ export interface InventorySummary { * @memberof InventorySummary */ sku: string; + /** + * Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center + * @type {number} + * @memberof InventorySummary + */ + totalInboundQuantity?: number; /** * Total quantity that is present in AWD distribution centers. * @type {number} @@ -662,6 +674,41 @@ export enum ShipmentSortableField { CreatedAt = 'CREATED_AT' } +/** + * Enum to specify if returned shipment should include SKU quantity details + * @export + * @enum {string} + */ +export enum SkuQuantitiesVisibility { + Show = 'SHOW', + Hide = 'HIDE' +} + +/** + * Quantity details for a SKU as part of a shipment + * @export + * @interface SkuQuantity + */ +export interface SkuQuantity { + /** + * + * @type {InventoryQuantity} + * @memberof SkuQuantity + */ + expectedQuantity: InventoryQuantity; + /** + * + * @type {InventoryQuantity} + * @memberof SkuQuantity + */ + receivedQuantity?: InventoryQuantity; + /** + * The merchant stock keeping unit + * @type {string} + * @memberof SkuQuantity + */ + sku: string; +} /** * Sort order for a collection of items. For example, order or shipment. * @export @@ -701,12 +748,13 @@ export enum WeightUnitOfMeasurement { export const AwdApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Retrieves an AWD inbound shipment. + * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param {'SHOW' | 'HIDE'} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInboundShipment: async (shipmentId: string, options: any = {}): Promise => { + getInboundShipment: async (shipmentId: string, skuQuantities?: 'SHOW' | 'HIDE', options: any = {}): Promise => { // verify required parameter 'shipmentId' is not null or undefined assertParamExists('getInboundShipment', 'shipmentId', shipmentId) const localVarPath = `/awd/2024-05-09/inboundShipments/{shipmentId}` @@ -722,6 +770,10 @@ export const AwdApiAxiosParamCreator = function (configuration?: Configuration) const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (skuQuantities !== undefined) { + localVarQueryParameter['skuQuantities'] = skuQuantities; + } + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); @@ -734,9 +786,9 @@ export const AwdApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. - * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. Required if `sortOrder` is provided. - * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. @@ -802,7 +854,7 @@ export const AwdApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} [sku] Filter by seller or merchant SKU for the item. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. @@ -866,19 +918,20 @@ export const AwdApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AwdApiAxiosParamCreator(configuration) return { /** - * Retrieves an AWD inbound shipment. + * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param {'SHOW' | 'HIDE'} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getInboundShipment(shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundShipment(shipmentId, options); + async getInboundShipment(shipmentId: string, skuQuantities?: 'SHOW' | 'HIDE', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundShipment(shipmentId, skuQuantities, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. - * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. Required if `sortOrder` is provided. - * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. @@ -892,7 +945,7 @@ export const AwdApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} [sku] Filter by seller or merchant SKU for the item. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. @@ -916,18 +969,19 @@ export const AwdApiFactory = function (configuration?: Configuration, basePath?: const localVarFp = AwdApiFp(configuration) return { /** - * Retrieves an AWD inbound shipment. + * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param {'SHOW' | 'HIDE'} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInboundShipment(shipmentId: string, options?: any): AxiosPromise { - return localVarFp.getInboundShipment(shipmentId, options).then((request) => request(axios, basePath)); + getInboundShipment(shipmentId: string, skuQuantities?: 'SHOW' | 'HIDE', options?: any): AxiosPromise { + return localVarFp.getInboundShipment(shipmentId, skuQuantities, options).then((request) => request(axios, basePath)); }, /** - * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. - * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. Required if `sortOrder` is provided. - * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. @@ -940,7 +994,7 @@ export const AwdApiFactory = function (configuration?: Configuration, basePath?: return localVarFp.listInboundShipments(sortBy, sortOrder, shipmentStatus, updatedAfter, updatedBefore, maxResults, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} [sku] Filter by seller or merchant SKU for the item. * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. @@ -967,6 +1021,13 @@ export interface AwdApiGetInboundShipmentRequest { * @memberof AwdApiGetInboundShipment */ readonly shipmentId: string + + /** + * If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities + * @type {'SHOW' | 'HIDE'} + * @memberof AwdApiGetInboundShipment + */ + readonly skuQuantities?: 'SHOW' | 'HIDE' } /** @@ -976,14 +1037,14 @@ export interface AwdApiGetInboundShipmentRequest { */ export interface AwdApiListInboundShipmentsRequest { /** - * Field to sort results by. Required if `sortOrder` is provided. + * Field to sort results by. By default, the response will be sorted by UPDATED_AT. * @type {'UPDATED_AT' | 'CREATED_AT'} * @memberof AwdApiListInboundShipments */ readonly sortBy?: 'UPDATED_AT' | 'CREATED_AT' /** - * Sort the response in `ASCENDING` or `DESCENDING` order. + * Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @type {'ASCENDING' | 'DESCENDING'} * @memberof AwdApiListInboundShipments */ @@ -1075,18 +1136,18 @@ export interface AwdApiListInventoryRequest { */ export class AwdApi extends BaseAPI { /** - * Retrieves an AWD inbound shipment. + * Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {AwdApiGetInboundShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AwdApi */ public getInboundShipment(requestParameters: AwdApiGetInboundShipmentRequest, options?: any) { - return AwdApiFp(this.configuration).getInboundShipment(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); + return AwdApiFp(this.configuration).getInboundShipment(requestParameters.shipmentId, requestParameters.skuQuantities, options).then((request) => request(this.axios, this.basePath)); } /** - * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. + * Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {AwdApiListInboundShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1097,7 +1158,7 @@ export class AwdApi extends BaseAPI { } /** - * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {AwdApiListInventoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/amazon-warehousing-and-distribution-model/base.ts b/src/api-models/amazon-warehousing-and-distribution-model/base.ts index f4a608b9..c2cc5011 100644 --- a/src/api-models/amazon-warehousing-and-distribution-model/base.ts +++ b/src/api-models/amazon-warehousing-and-distribution-model/base.ts @@ -1,8 +1,8 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for AWD - * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * The Selling Partner API for Amazon Warehousing and Distribution + * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. * * The version of the OpenAPI document: 2024-05-09 * diff --git a/src/api-models/amazon-warehousing-and-distribution-model/common.ts b/src/api-models/amazon-warehousing-and-distribution-model/common.ts index 0ee15052..e5a4c719 100644 --- a/src/api-models/amazon-warehousing-and-distribution-model/common.ts +++ b/src/api-models/amazon-warehousing-and-distribution-model/common.ts @@ -1,8 +1,8 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for AWD - * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * The Selling Partner API for Amazon Warehousing and Distribution + * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. * * The version of the OpenAPI document: 2024-05-09 * diff --git a/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts b/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts index fbb9ca2c..9af1cf12 100644 --- a/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts +++ b/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts @@ -1,8 +1,8 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for AWD - * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * The Selling Partner API for Amazon Warehousing and Distribution + * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. * * The version of the OpenAPI document: 2024-05-09 * diff --git a/src/api-models/amazon-warehousing-and-distribution-model/index.ts b/src/api-models/amazon-warehousing-and-distribution-model/index.ts index 242105a1..98ee0dad 100644 --- a/src/api-models/amazon-warehousing-and-distribution-model/index.ts +++ b/src/api-models/amazon-warehousing-and-distribution-model/index.ts @@ -1,8 +1,8 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for AWD - * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * The Selling Partner API for Amazon Warehousing and Distribution + * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. * * The version of the OpenAPI document: 2024-05-09 * diff --git a/src/api-models/catalog-items-api-model-v20220401/api.ts b/src/api-models/catalog-items-api-model-v20220401/api.ts index b77e3bfd..3f36b4ec 100644 --- a/src/api-models/catalog-items-api-model-v20220401/api.ts +++ b/src/api-models/catalog-items-api-model-v20220401/api.ts @@ -932,7 +932,7 @@ export interface Refinements { export const CatalogApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @param {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. @@ -982,7 +982,7 @@ export const CatalogApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. @@ -1083,7 +1083,7 @@ export const CatalogApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CatalogApiAxiosParamCreator(configuration) return { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @param {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. @@ -1096,7 +1096,7 @@ export const CatalogApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. @@ -1127,7 +1127,7 @@ export const CatalogApiFactory = function (configuration?: Configuration, basePa const localVarFp = CatalogApiFp(configuration) return { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @param {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. @@ -1139,7 +1139,7 @@ export const CatalogApiFactory = function (configuration?: Configuration, basePa return localVarFp.getCatalogItem(asin, marketplaceIds, includedData, locale, options).then((request) => request(axios, basePath)); }, /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. @@ -1295,7 +1295,7 @@ export interface CatalogApiSearchCatalogItemsRequest { */ export class CatalogApi extends BaseAPI { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1306,7 +1306,7 @@ export class CatalogApi extends BaseAPI { } /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/feeds-api-model-v20210630/api.ts b/src/api-models/feeds-api-model-v20210630/api.ts index 24dd665e..7c8040a5 100644 --- a/src/api-models/feeds-api-model-v20210630/api.ts +++ b/src/api-models/feeds-api-model-v20210630/api.ts @@ -264,7 +264,7 @@ export interface ModelError { export const FeedsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -297,7 +297,7 @@ export const FeedsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | 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). + * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#post-feeds2021-06-30feeds) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -332,7 +332,7 @@ export const FeedsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | 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). + * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -367,7 +367,7 @@ export const FeedsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Returns feed details (including the resultDocumentId, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -400,7 +400,7 @@ export const FeedsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedDocumentId The identifier of the feed document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -433,7 +433,7 @@ export const FeedsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of feeds to return in a single call. @@ -511,7 +511,7 @@ export const FeedsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FeedsApiAxiosParamCreator(configuration) return { /** - * Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -521,7 +521,7 @@ export const FeedsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | 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). + * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#post-feeds2021-06-30feeds) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -531,7 +531,7 @@ export const FeedsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | 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). + * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -541,7 +541,7 @@ export const FeedsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns feed details (including the resultDocumentId, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -551,7 +551,7 @@ export const FeedsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedDocumentId The identifier of the feed document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -561,7 +561,7 @@ export const FeedsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of feeds to return in a single call. @@ -587,7 +587,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath const localVarFp = FeedsApiFp(configuration) return { /** - * Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -596,7 +596,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath return localVarFp.cancelFeed(feedId, options).then((request) => request(axios, basePath)); }, /** - * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | 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). + * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#post-feeds2021-06-30feeds) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -605,7 +605,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath return localVarFp.createFeed(body, options).then((request) => request(axios, basePath)); }, /** - * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | 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). + * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -614,7 +614,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath return localVarFp.createFeedDocument(body, options).then((request) => request(axios, basePath)); }, /** - * Returns feed details (including the resultDocumentId, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedId The identifier for the feed. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -623,7 +623,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath return localVarFp.getFeed(feedId, options).then((request) => request(axios, basePath)); }, /** - * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} feedDocumentId The identifier of the feed document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -632,7 +632,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath return localVarFp.getFeedDocument(feedDocumentId, options).then((request) => request(axios, basePath)); }, /** - * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [feedTypes] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of feeds to return in a single call. @@ -783,7 +783,7 @@ export interface FeedsApiGetFeedsRequest { */ export class FeedsApi extends BaseAPI { /** - * Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FeedsApiCancelFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -794,7 +794,7 @@ export class FeedsApi extends BaseAPI { } /** - * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | 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). + * Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#post-feeds2021-06-30feeds) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api). * @param {FeedsApiCreateFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -805,7 +805,7 @@ export class FeedsApi extends BaseAPI { } /** - * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | 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). + * Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -816,7 +816,7 @@ export class FeedsApi extends BaseAPI { } /** - * Returns feed details (including the resultDocumentId, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | 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). + * Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FeedsApiGetFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -827,7 +827,7 @@ export class FeedsApi extends BaseAPI { } /** - * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns the information required for retrieving a feed document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -838,7 +838,7 @@ export class FeedsApi extends BaseAPI { } /** - * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | 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). + * Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FeedsApiGetFeedsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/fulfillment-outbound-api-model/api.ts b/src/api-models/fulfillment-outbound-api-model/api.ts index 96513ed1..75caad10 100644 --- a/src/api-models/fulfillment-outbound-api-model/api.ts +++ b/src/api-models/fulfillment-outbound-api-model/api.ts @@ -522,6 +522,44 @@ export interface DateRange { */ latest: string; } +/** + * A delivery document for a package. + * @export + * @interface DeliveryDocument + */ +export interface DeliveryDocument { + /** + * The delivery document type. Values are `SIGNATURE` and `DELIVERY_IMAGE`. + * @type {string} + * @memberof DeliveryDocument + */ + documentType: string; + /** + * A URL that you can use to download the document. This URL has a `Content-Type` header. Note that the URL expires after one hour. To get a new URL, you must call the API again. + * @type {string} + * @memberof DeliveryDocument + */ + url?: string; +} +/** + * The delivery information for the package. This information is available after the package is delivered. + * @export + * @interface DeliveryInformation + */ +export interface DeliveryInformation { + /** + * A list of delivery documents for a package. + * @type {Array} + * @memberof DeliveryInformation + */ + deliveryDocumentList?: Array; + /** + * + * @type {DropOffLocation} + * @memberof DeliveryInformation + */ + dropOffLocation?: DropOffLocation; +} /** * Localized messaging for a delivery offering. * @export @@ -598,34 +636,6 @@ export interface DeliveryPreferences { */ dropOffLocation?: DropOffLocation; } -/** - * A quantity based on unit of measure. - * @export - * @interface DeliveryQuantity - */ -export interface DeliveryQuantity { - /** - * The unit of measure for the amount. - * @type {string} - * @memberof DeliveryQuantity - */ - unitOfMeasure: DeliveryQuantityUnitOfMeasureEnum | 'Each'; - /** - * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. - * @type {string} - * @memberof DeliveryQuantity - */ - amount: string; -} - -/** - * @export - * @enum {string} - */ -export enum DeliveryQuantityUnitOfMeasureEnum { - Each = 'Each' -} - /** * The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace. * @export @@ -1413,6 +1423,12 @@ export interface FulfillmentShipmentPackage { * @memberof FulfillmentShipmentPackage */ lockerDetails?: LockerDetails; + /** + * + * @type {DeliveryInformation} + * @memberof FulfillmentShipmentPackage + */ + deliveryInformation?: DeliveryInformation; } /** * The product details for the delivery offer. @@ -1961,7 +1977,7 @@ export interface ListReturnReasonCodesResult { reasonCodeDetails?: Array; } /** - * The locker details, if provided can be used to access locker delivery box. + * The locker details, which you can use to access the locker delivery box. * @export * @interface LockerDetails */ @@ -2710,7 +2726,7 @@ export enum WeightUnitEnum { export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2743,7 +2759,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2778,7 +2794,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items. * @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter * @param {*} [options] Override http request option. @@ -2817,7 +2833,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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). + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2852,7 +2868,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. + * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param {string} featureName The name of the feature for which to return a list of eligible inventory. * @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. @@ -2904,7 +2920,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The marketplace for which to return the count. * @param {string} featureName The name of the feature. * @param {string} sellerSku Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit. @@ -2948,7 +2964,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The marketplace for which to return the list of features. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2984,7 +3000,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3017,7 +3033,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3052,7 +3068,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} packageNumber The unencrypted package identifier returned by the `getFulfillmentOrder` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3088,7 +3104,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. @@ -3129,7 +3145,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerSku The seller SKU for which return reason codes are required. * @param {string} [marketplaceId] The marketplace for which the seller wants return reason codes. * @param {string} [sellerFulfillmentOrderId] The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. @@ -3219,7 +3235,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }; }, /** - * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. @@ -3268,7 +3284,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FbaOutboundApiAxiosParamCreator(configuration) return { /** - * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3278,7 +3294,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3288,7 +3304,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items. * @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter * @param {*} [options] Override http request option. @@ -3299,7 +3315,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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). + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3309,7 +3325,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. + * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param {string} featureName The name of the feature for which to return a list of eligible inventory. * @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. @@ -3322,7 +3338,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The marketplace for which to return the count. * @param {string} featureName The name of the feature. * @param {string} sellerSku Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit. @@ -3334,7 +3350,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The marketplace for which to return the list of features. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3344,7 +3360,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3354,7 +3370,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3364,7 +3380,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} packageNumber The unencrypted package identifier returned by the `getFulfillmentOrder` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3374,7 +3390,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. @@ -3385,7 +3401,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerSku The seller SKU for which return reason codes are required. * @param {string} [marketplaceId] The marketplace for which the seller wants return reason codes. * @param {string} [sellerFulfillmentOrderId] The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. @@ -3409,7 +3425,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. @@ -3430,7 +3446,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba const localVarFp = FbaOutboundApiFp(configuration) return { /** - * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3439,7 +3455,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.cancelFulfillmentOrder(sellerFulfillmentOrderId, options).then((request) => request(axios, basePath)); }, /** - * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3448,7 +3464,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.createFulfillmentOrder(body, options).then((request) => request(axios, basePath)); }, /** - * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items. * @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter * @param {*} [options] Override http request option. @@ -3458,7 +3474,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.createFulfillmentReturn(sellerFulfillmentOrderId, body, options).then((request) => request(axios, basePath)); }, /** - * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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). + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3467,7 +3483,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.deliveryOffers(body, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. + * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param {string} featureName The name of the feature for which to return a list of eligible inventory. * @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. @@ -3479,7 +3495,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.getFeatureInventory(marketplaceId, featureName, nextToken, queryStartDate, options).then((request) => request(axios, basePath)); }, /** - * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The marketplace for which to return the count. * @param {string} featureName The name of the feature. * @param {string} sellerSku Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit. @@ -3490,7 +3506,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.getFeatureSKU(marketplaceId, featureName, sellerSku, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The marketplace for which to return the list of features. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3499,7 +3515,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.getFeatures(marketplaceId, options).then((request) => request(axios, basePath)); }, /** - * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3508,7 +3524,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.getFulfillmentOrder(sellerFulfillmentOrderId, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3517,7 +3533,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.getFulfillmentPreview(body, options).then((request) => request(axios, basePath)); }, /** - * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} packageNumber The unencrypted package identifier returned by the `getFulfillmentOrder` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3526,7 +3542,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.getPackageTrackingDetails(packageNumber, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. * @param {string} [nextToken] A string token returned in the response to your previous request. * @param {*} [options] Override http request option. @@ -3536,7 +3552,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.listAllFulfillmentOrders(queryStartDate, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerSku The seller SKU for which return reason codes are required. * @param {string} [marketplaceId] The marketplace for which the seller wants return reason codes. * @param {string} [sellerFulfillmentOrderId] The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. @@ -3558,7 +3574,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba return localVarFp.submitFulfillmentOrderStatusUpdate(sellerFulfillmentOrderId, body, options).then((request) => request(axios, basePath)); }, /** - * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. * @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. @@ -3858,7 +3874,7 @@ export interface FbaOutboundApiUpdateFulfillmentOrderRequest { */ export class FbaOutboundApi extends BaseAPI { /** - * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3869,7 +3885,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {FbaOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3880,7 +3896,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3891,7 +3907,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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). + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiDeliveryOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3902,7 +3918,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. + * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {FbaOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3913,7 +3929,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiGetFeatureSKURequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3924,7 +3940,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiGetFeaturesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3935,7 +3951,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3946,7 +3962,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3957,7 +3973,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3968,7 +3984,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) + * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) * @param {FbaOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3979,7 +3995,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4001,7 +4017,7 @@ export class FbaOutboundApi extends BaseAPI { } /** - * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/index.ts b/src/api-models/index.ts index a2c6b14c..b18a65ec 100644 --- a/src/api-models/index.ts +++ b/src/api-models/index.ts @@ -6,6 +6,7 @@ export { InventoryDetailsVisibility as AmazonWarehousingAndDistributionModelInventoryDetailsVisibility, InventoryUnitOfMeasurement as AmazonWarehousingAndDistributionModelInventoryUnitOfMeasurement, ShipmentSortableField as AmazonWarehousingAndDistributionModelShipmentSortableField, + SkuQuantitiesVisibility as AmazonWarehousingAndDistributionModelSkuQuantitiesVisibility, SortOrder as AmazonWarehousingAndDistributionModelSortOrder, VolumeUnitOfMeasurement as AmazonWarehousingAndDistributionModelVolumeUnitOfMeasurement, WeightUnitOfMeasurement as AmazonWarehousingAndDistributionModelWeightUnitOfMeasurement, @@ -29,6 +30,7 @@ export { ProductAttribute as AmazonWarehousingAndDistributionModelProductAttribute, ProductQuantity as AmazonWarehousingAndDistributionModelProductQuantity, ShipmentListing as AmazonWarehousingAndDistributionModelShipmentListing, + SkuQuantity as AmazonWarehousingAndDistributionModelSkuQuantity, AwdApiGetInboundShipmentRequest as AmazonWarehousingAndDistributionModelAwdApiGetInboundShipmentRequest, AwdApiListInboundShipmentsRequest as AmazonWarehousingAndDistributionModelAwdApiListInboundShipmentsRequest, AwdApiListInventoryRequest as AmazonWarehousingAndDistributionModelAwdApiListInventoryRequest, @@ -670,7 +672,6 @@ export { AdditionalLocationInfo as FulfillmentOutboundApiModelAdditionalLocationInfo, AmountUnitOfMeasureEnum as FulfillmentOutboundApiModelAmountUnitOfMeasureEnum, CurrentStatus as FulfillmentOutboundApiModelCurrentStatus, - DeliveryQuantityUnitOfMeasureEnum as FulfillmentOutboundApiModelDeliveryQuantityUnitOfMeasureEnum, DropOffLocationTypeEnum as FulfillmentOutboundApiModelDropOffLocationTypeEnum, EventCode as FulfillmentOutboundApiModelEventCode, FeatureSettingsFeatureFulfillmentPolicyEnum as FulfillmentOutboundApiModelFeatureSettingsFeatureFulfillmentPolicyEnum, @@ -697,11 +698,12 @@ export { CreateFulfillmentReturnResult as FulfillmentOutboundApiModelCreateFulfillmentReturnResult, CreateReturnItem as FulfillmentOutboundApiModelCreateReturnItem, DateRange as FulfillmentOutboundApiModelDateRange, + DeliveryDocument as FulfillmentOutboundApiModelDeliveryDocument, + DeliveryInformation as FulfillmentOutboundApiModelDeliveryInformation, DeliveryMessage as FulfillmentOutboundApiModelDeliveryMessage, DeliveryOffer as FulfillmentOutboundApiModelDeliveryOffer, DeliveryPolicy as FulfillmentOutboundApiModelDeliveryPolicy, DeliveryPreferences as FulfillmentOutboundApiModelDeliveryPreferences, - DeliveryQuantity as FulfillmentOutboundApiModelDeliveryQuantity, DeliveryWindow as FulfillmentOutboundApiModelDeliveryWindow, Destination as FulfillmentOutboundApiModelDestination, DropOffLocation as FulfillmentOutboundApiModelDropOffLocation, @@ -802,6 +804,7 @@ export { ListingsItemPutRequestRequirementsEnum as ListingsItemsApiModelV20210801ListingsItemPutRequestRequirementsEnum, ListingsItemSubmissionResponseStatusEnum as ListingsItemsApiModelV20210801ListingsItemSubmissionResponseStatusEnum, PatchOperationOpEnum as ListingsItemsApiModelV20210801PatchOperationOpEnum, + Audience as ListingsItemsApiModelV20210801Audience, ErrorList as ListingsItemsApiModelV20210801ErrorList, FulfillmentAvailability as ListingsItemsApiModelV20210801FulfillmentAvailability, Issue as ListingsItemsApiModelV20210801Issue, @@ -813,18 +816,21 @@ export { ItemImage as ListingsItemsApiModelV20210801ItemImage, ItemOfferByMarketplace as ListingsItemsApiModelV20210801ItemOfferByMarketplace, ItemProcurement as ListingsItemsApiModelV20210801ItemProcurement, + ItemSearchResults as ListingsItemsApiModelV20210801ItemSearchResults, ItemSummaryByMarketplace as ListingsItemsApiModelV20210801ItemSummaryByMarketplace, ListingsItemPatchRequest as ListingsItemsApiModelV20210801ListingsItemPatchRequest, ListingsItemPutRequest as ListingsItemsApiModelV20210801ListingsItemPutRequest, ListingsItemSubmissionResponse as ListingsItemsApiModelV20210801ListingsItemSubmissionResponse, ModelError as ListingsItemsApiModelV20210801ModelError, Money as ListingsItemsApiModelV20210801Money, + Pagination as ListingsItemsApiModelV20210801Pagination, PatchOperation as ListingsItemsApiModelV20210801PatchOperation, Points as ListingsItemsApiModelV20210801Points, ListingsApiDeleteListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiDeleteListingsItemRequest, ListingsApiGetListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiGetListingsItemRequest, ListingsApiPatchListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiPatchListingsItemRequest, ListingsApiPutListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiPutListingsItemRequest, + ListingsApiSearchListingsItemsRequest as ListingsItemsApiModelV20210801ListingsApiSearchListingsItemsRequest, } from './listings-items-api-model-v20210801' export { LinkVerbEnum as ListingsRestrictionsApiModelLinkVerbEnum, @@ -999,6 +1005,9 @@ export { ConstraintType as OrdersApiModelConstraintType, EasyShipShipmentStatus as OrdersApiModelEasyShipShipmentStatus, ElectronicInvoiceStatus as OrdersApiModelElectronicInvoiceStatus, + FulfillmentPlanFulfillmentTypeEnum as OrdersApiModelFulfillmentPlanFulfillmentTypeEnum, + FulfillmentPlanFulfillmentPlanStatusEnum as OrdersApiModelFulfillmentPlanFulfillmentPlanStatusEnum, + FulfillmentPlanConstraintType as OrdersApiModelFulfillmentPlanConstraintType, MeasurementUnitEnum as OrdersApiModelMeasurementUnitEnum, OrderOrderStatusEnum as OrdersApiModelOrderOrderStatusEnum, OrderFulfillmentChannelEnum as OrdersApiModelOrderFulfillmentChannelEnum, @@ -1029,8 +1038,14 @@ export { DeliveryPreferences as OrdersApiModelDeliveryPreferences, ExceptionDates as OrdersApiModelExceptionDates, FulfillmentInstruction as OrdersApiModelFulfillmentInstruction, + FulfillmentInstructions as OrdersApiModelFulfillmentInstructions, + FulfillmentLocation as OrdersApiModelFulfillmentLocation, + FulfillmentPlan as OrdersApiModelFulfillmentPlan, + FulfillmentPlanItem as OrdersApiModelFulfillmentPlanItem, + FulfillmentPlanShippingConstraints as OrdersApiModelFulfillmentPlanShippingConstraints, GetOrderAddressResponse as OrdersApiModelGetOrderAddressResponse, GetOrderBuyerInfoResponse as OrdersApiModelGetOrderBuyerInfoResponse, + GetOrderFulfillmentInstructionsResponse as OrdersApiModelGetOrderFulfillmentInstructionsResponse, GetOrderItemsBuyerInfoResponse as OrdersApiModelGetOrderItemsBuyerInfoResponse, GetOrderItemsResponse as OrdersApiModelGetOrderItemsResponse, GetOrderRegulatedInfoResponse as OrdersApiModelGetOrderRegulatedInfoResponse, @@ -1056,12 +1071,14 @@ export { PaymentExecutionDetailItem as OrdersApiModelPaymentExecutionDetailItem, PointsGrantedDetail as OrdersApiModelPointsGrantedDetail, PreferredDeliveryTime as OrdersApiModelPreferredDeliveryTime, + PrescriptionDetail as OrdersApiModelPrescriptionDetail, ProductInfoDetail as OrdersApiModelProductInfoDetail, RegulatedInformation as OrdersApiModelRegulatedInformation, RegulatedInformationField as OrdersApiModelRegulatedInformationField, RegulatedOrderVerificationStatus as OrdersApiModelRegulatedOrderVerificationStatus, RejectionReason as OrdersApiModelRejectionReason, ShippingConstraints as OrdersApiModelShippingConstraints, + ShippingInstructions as OrdersApiModelShippingInstructions, SubstitutionOption as OrdersApiModelSubstitutionOption, SubstitutionPreferences as OrdersApiModelSubstitutionPreferences, TaxClassification as OrdersApiModelTaxClassification, @@ -1071,10 +1088,13 @@ export { UpdateVerificationStatusErrorResponse as OrdersApiModelUpdateVerificationStatusErrorResponse, UpdateVerificationStatusRequest as OrdersApiModelUpdateVerificationStatusRequest, UpdateVerificationStatusRequestBody as OrdersApiModelUpdateVerificationStatusRequestBody, + ValidVerificationDetail as OrdersApiModelValidVerificationDetail, + VerificationDetails as OrdersApiModelVerificationDetails, OrdersV0ApiConfirmShipmentRequest as OrdersApiModelOrdersV0ApiConfirmShipmentRequest, OrdersV0ApiGetOrderRequest as OrdersApiModelOrdersV0ApiGetOrderRequest, OrdersV0ApiGetOrderAddressRequest as OrdersApiModelOrdersV0ApiGetOrderAddressRequest, OrdersV0ApiGetOrderBuyerInfoRequest as OrdersApiModelOrdersV0ApiGetOrderBuyerInfoRequest, + OrdersV0ApiGetOrderFulfillmentInstructionsRequest as OrdersApiModelOrdersV0ApiGetOrderFulfillmentInstructionsRequest, OrdersV0ApiGetOrderItemsRequest as OrdersApiModelOrdersV0ApiGetOrderItemsRequest, OrdersV0ApiGetOrderItemsBuyerInfoRequest as OrdersApiModelOrdersV0ApiGetOrderItemsBuyerInfoRequest, OrdersV0ApiGetOrderRegulatedInfoRequest as OrdersApiModelOrdersV0ApiGetOrderRegulatedInfoRequest, @@ -1342,11 +1362,20 @@ export { SalesApiGetOrderMetricsRequest as SalesApiModelSalesApiGetOrderMetricsRequest, } from './sales-api-model' export { + AccountBusinessTypeEnum as SellersApiModelAccountBusinessTypeEnum, + MarketplaceLevelAttributesListingStatusEnum as SellersApiModelMarketplaceLevelAttributesListingStatusEnum, + MarketplaceLevelAttributesSellingPlanEnum as SellersApiModelMarketplaceLevelAttributesSellingPlanEnum, + Account as SellersApiModelAccount, + Address as SellersApiModelAddress, + Business as SellersApiModelBusiness, + GetAccountResponse as SellersApiModelGetAccountResponse, GetMarketplaceParticipationsResponse as SellersApiModelGetMarketplaceParticipationsResponse, Marketplace as SellersApiModelMarketplace, + MarketplaceLevelAttributes as SellersApiModelMarketplaceLevelAttributes, MarketplaceParticipation as SellersApiModelMarketplaceParticipation, ModelError as SellersApiModelModelError, Participation as SellersApiModelParticipation, + PrimaryContact as SellersApiModelPrimaryContact, } from './sellers-api-model' export { AppointmentAppointmentStatusEnum as ServicesApiModelAppointmentAppointmentStatusEnum, @@ -2006,6 +2035,7 @@ export { ImportDetailsMethodOfPaymentEnum as VendorOrdersApiModelImportDetailsMethodOfPaymentEnum, ImportDetailsInternationalCommercialTermsEnum as VendorOrdersApiModelImportDetailsInternationalCommercialTermsEnum, ItemQuantityUnitOfMeasureEnum as VendorOrdersApiModelItemQuantityUnitOfMeasureEnum, + MoneyUnitOfMeasureEnum as VendorOrdersApiModelMoneyUnitOfMeasureEnum, OrderPurchaseOrderStateEnum as VendorOrdersApiModelOrderPurchaseOrderStateEnum, OrderDetailsPurchaseOrderTypeEnum as VendorOrdersApiModelOrderDetailsPurchaseOrderTypeEnum, OrderDetailsPaymentMethodEnum as VendorOrdersApiModelOrderDetailsPaymentMethodEnum, diff --git a/src/api-models/listings-items-api-model-v20210801/api.ts b/src/api-models/listings-items-api-model-v20210801/api.ts index c61b9418..a4519c96 100644 --- a/src/api-models/listings-items-api-model-v20210801/api.ts +++ b/src/api-models/listings-items-api-model-v20210801/api.ts @@ -21,6 +21,25 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; +/** + * Buyer segment or program this offer is applicable to. + * @export + * @interface Audience + */ +export interface Audience { + /** + * Name of the audience an offer is applicable to. Common values: * \'ALL\' - Standard offer audience for buyers on Amazon retail websites. * \'B2B\' - Offer audience for Amazon Business website buyers. + * @type {string} + * @memberof Audience + */ + value?: string; + /** + * Localized display name for the audience. + * @type {string} + * @memberof Audience + */ + displayName?: string; +} /** * A list of error responses returned when a request is unsuccessful. * @export @@ -292,6 +311,12 @@ export interface ItemOfferByMarketplace { * @memberof ItemOfferByMarketplace */ points?: Points; + /** + * + * @type {Audience} + * @memberof ItemOfferByMarketplace + */ + audience?: Audience; } /** @@ -316,6 +341,31 @@ export interface ItemProcurement { */ costPrice: Money; } +/** + * Selling partner listings items and search related metadata. + * @export + * @interface ItemSearchResults + */ +export interface ItemSearchResults { + /** + * The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found). Note: The maximum number of items (SKUs) that can be returned and paged through is 1000. + * @type {number} + * @memberof ItemSearchResults + */ + numberOfResults: number; + /** + * + * @type {Pagination} + * @memberof ItemSearchResults + */ + pagination?: Pagination; + /** + * A list of listings items. + * @type {Array} + * @memberof ItemSearchResults + */ + items: Array; +} /** * Summary details of a listings item for an Amazon marketplace. * @export @@ -559,6 +609,25 @@ export interface Money { */ amount: string; } +/** + * When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object. + * @export + * @interface Pagination + */ +export interface Pagination { + /** + * A token that can be used to fetch the next page. + * @type {string} + * @memberof Pagination + */ + nextToken?: string; + /** + * A token that can be used to fetch the previous page. + * @type {string} + * @memberof Pagination + */ + previousToken?: string; +} /** * Individual JSON Patch operation for an HTTP PATCH request. * @export @@ -843,6 +912,76 @@ export const ListingsApiAxiosParamCreator = function (configuration?: Configurat localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Search for and return list of listings items and respective details for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. + * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. + * @param {Array} [identifiers] A comma-delimited list of product identifiers to search for listings items by. **Note**: 1. Required when `identifiersType` is provided. + * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search for listings items by. **Note**: 1. Required when `identifiers` is provided. + * @param {number} [pageSize] Number of results to be returned per page. + * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results. + * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. + * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchListingsItems: async (sellerId: string, marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', pageSize?: number, pageToken?: string, includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>, issueLocale?: string, options: any = {}): Promise => { + // verify required parameter 'sellerId' is not null or undefined + assertParamExists('searchListingsItems', 'sellerId', sellerId) + // verify required parameter 'marketplaceIds' is not null or undefined + assertParamExists('searchListingsItems', 'marketplaceIds', marketplaceIds) + const localVarPath = `/listings/2021-08-01/items/{sellerId}` + .replace(`{${"sellerId"}}`, encodeURIComponent(String(sellerId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (marketplaceIds) { + localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv); + } + + if (identifiers) { + localVarQueryParameter['identifiers'] = identifiers.join(COLLECTION_FORMATS.csv); + } + + if (identifiersType !== undefined) { + localVarQueryParameter['identifiersType'] = identifiersType; + } + + if (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (pageToken !== undefined) { + localVarQueryParameter['pageToken'] = pageToken; + } + + if (includedData) { + localVarQueryParameter['includedData'] = includedData.join(COLLECTION_FORMATS.csv); + } + + if (issueLocale !== undefined) { + localVarQueryParameter['issueLocale'] = issueLocale; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -917,6 +1056,23 @@ export const ListingsApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.putListingsItem(sellerId, sku, marketplaceIds, body, includedData, mode, issueLocale, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Search for and return list of listings items and respective details for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. + * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. + * @param {Array} [identifiers] A comma-delimited list of product identifiers to search for listings items by. **Note**: 1. Required when `identifiersType` is provided. + * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search for listings items by. **Note**: 1. Required when `identifiers` is provided. + * @param {number} [pageSize] Number of results to be returned per page. + * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results. + * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. + * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async searchListingsItems(sellerId: string, marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', pageSize?: number, pageToken?: string, includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>, issueLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchListingsItems(sellerId, marketplaceIds, identifiers, identifiersType, pageSize, pageToken, includedData, issueLocale, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, } }; @@ -982,6 +1138,22 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP putListingsItem(sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPutRequest, includedData?: Array<'identifiers' | 'issues'>, mode?: 'VALIDATION_PREVIEW', issueLocale?: string, options?: any): AxiosPromise { return localVarFp.putListingsItem(sellerId, sku, marketplaceIds, body, includedData, mode, issueLocale, options).then((request) => request(axios, basePath)); }, + /** + * Search for and return list of listings items and respective details for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. + * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. + * @param {Array} [identifiers] A comma-delimited list of product identifiers to search for listings items by. **Note**: 1. Required when `identifiersType` is provided. + * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search for listings items by. **Note**: 1. Required when `identifiers` is provided. + * @param {number} [pageSize] Number of results to be returned per page. + * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results. + * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. + * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchListingsItems(sellerId: string, marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', pageSize?: number, pageToken?: string, includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>, issueLocale?: string, options?: any): AxiosPromise { + return localVarFp.searchListingsItems(sellerId, marketplaceIds, identifiers, identifiersType, pageSize, pageToken, includedData, issueLocale, options).then((request) => request(axios, basePath)); + }, }; }; @@ -1174,6 +1346,69 @@ export interface ListingsApiPutListingsItemRequest { readonly issueLocale?: string } +/** + * Request parameters for searchListingsItems operation in ListingsApi. + * @export + * @interface ListingsApiSearchListingsItemsRequest + */ +export interface ListingsApiSearchListingsItemsRequest { + /** + * A selling partner identifier, such as a merchant account or vendor code. + * @type {string} + * @memberof ListingsApiSearchListingsItems + */ + readonly sellerId: string + + /** + * A comma-delimited list of Amazon marketplace identifiers for the request. + * @type {Array} + * @memberof ListingsApiSearchListingsItems + */ + readonly marketplaceIds: Array + + /** + * A comma-delimited list of product identifiers to search for listings items by. **Note**: 1. Required when `identifiersType` is provided. + * @type {Array} + * @memberof ListingsApiSearchListingsItems + */ + readonly identifiers?: Array + + /** + * Type of product identifiers to search for listings items by. **Note**: 1. Required when `identifiers` is provided. + * @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} + * @memberof ListingsApiSearchListingsItems + */ + readonly identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC' + + /** + * Number of results to be returned per page. + * @type {number} + * @memberof ListingsApiSearchListingsItems + */ + readonly pageSize?: number + + /** + * A token to fetch a certain page when there are multiple pages worth of results. + * @type {string} + * @memberof ListingsApiSearchListingsItems + */ + readonly pageToken?: string + + /** + * A comma-delimited list of data sets to include in the response. Default: summaries. + * @type {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>} + * @memberof ListingsApiSearchListingsItems + */ + readonly includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'> + + /** + * A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale. + * @type {string} + * @memberof ListingsApiSearchListingsItems + */ + readonly issueLocale?: string +} + /** * ListingsApi - object-oriented interface * @export @@ -1224,6 +1459,17 @@ export class ListingsApi extends BaseAPI { public putListingsItem(requestParameters: ListingsApiPutListingsItemRequest, options?: any) { return ListingsApiFp(this.configuration).putListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.body, requestParameters.includedData, requestParameters.mode, requestParameters.issueLocale, options).then((request) => request(this.axios, this.basePath)); } + + /** + * Search for and return list of listings items and respective details for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * @param {ListingsApiSearchListingsItemsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ListingsApi + */ + public searchListingsItems(requestParameters: ListingsApiSearchListingsItemsRequest, options?: any) { + return ListingsApiFp(this.configuration).searchListingsItems(requestParameters.sellerId, requestParameters.marketplaceIds, requestParameters.identifiers, requestParameters.identifiersType, requestParameters.pageSize, requestParameters.pageToken, requestParameters.includedData, requestParameters.issueLocale, options).then((request) => request(this.axios, this.basePath)); + } } diff --git a/src/api-models/merchant-fulfillment-api-model/api.ts b/src/api-models/merchant-fulfillment-api-model/api.ts index cd32a1fc..f0cbf2b5 100644 --- a/src/api-models/merchant-fulfillment-api-model/api.ts +++ b/src/api-models/merchant-fulfillment-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Merchant Fulfillment - * With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services. + * The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services. * * The version of the OpenAPI document: v0 * @@ -169,7 +169,7 @@ export interface Address { */ City: string; /** - * The state or province code. Note: Required in Canada, US, and UK marketplaces. Also required for shipments originating in China. + * The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China. * @type {string} * @memberof Address */ @@ -251,7 +251,7 @@ export interface AvailableShippingServiceOptions { AvailableDeliveryExperienceOptions: Array; } /** - * Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, `CLAIMS_PROTECTED`) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC. + * Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC * @export * @interface Benefits */ @@ -263,7 +263,7 @@ export interface Benefits { */ IncludedBenefits?: Array; /** - * A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation. + * A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation. * @type {Array} * @memberof Benefits */ @@ -400,7 +400,7 @@ export interface CurrencyAmount { Amount: number; } /** - * Details related to any dangerous goods or items that are shipped. + * Details related to any dangerous goods/items that are being shipped. * @export * @interface DangerousGoodsDetails */ @@ -412,7 +412,7 @@ export interface DangerousGoodsDetails { */ UnitedNationsRegulatoryId?: string; /** - * The specific regulatory class of the shipped item. + * The specific regulatory class of the item being shipped. * @type {string} * @memberof DangerousGoodsDetails */ @@ -486,19 +486,19 @@ export enum DeliveryExperienceType { } /** - * An object representing an excluded benefit that is excluded for a shipping offer or rate. + * Object representing an excluded benefit that is excluded for a shipping offer or rate. * @export * @interface ExcludedBenefit */ export interface ExcludedBenefit { /** - * A benefit that is being excluded from a shipment. + * Benefit that is being excluded from a shipment. * @type {string} * @memberof ExcludedBenefit */ Benefit?: string; /** - * List of reasons (for example, `LATE_DELIVERY_RISK`) why a benefit is excluded for a shipping offer. + * List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer. * @type {Array} * @memberof ExcludedBenefit */ @@ -585,7 +585,7 @@ export interface GetAdditionalSellerInputsResponse { errors?: Array; } /** - * The payload for the `getAdditionalSellerInputs` operation. + * The payload for the getAdditionalSellerInputs operation. * @export * @interface GetAdditionalSellerInputsResult */ @@ -642,7 +642,7 @@ export interface GetEligibleShipmentServicesResponse { errors?: Array; } /** - * The payload for the `getEligibleShipmentServices` operation. + * The payload for the getEligibleShipmentServices operation. * @export * @interface GetEligibleShipmentServicesResult */ @@ -654,7 +654,7 @@ export interface GetEligibleShipmentServicesResult { */ ShippingServiceList: Array; /** - * List of services that are for some reason unavailable for this request + * List of services that were for some reason unavailable for this request * @type {Array} * @memberof GetEligibleShipmentServicesResult */ @@ -798,7 +798,7 @@ export interface ItemLevelFields { */ export interface Label { /** - * Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`. + * Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel. * @type {string} * @memberof Label */ @@ -835,7 +835,7 @@ export interface Label { */ export interface LabelCustomization { /** - * Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`. + * Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel. * @type {string} * @memberof LabelCustomization */ @@ -937,7 +937,7 @@ export interface Length { unit?: UnitOfLength | 'inches' | 'centimeters'; } /** - * Liquid volume. + * Liquid Volume. * @export * @interface LiquidVolume */ @@ -977,7 +977,7 @@ export enum LiquidVolumeUnitEnum { */ export interface ModelError { /** - * An error code that identifies the type of error that occurred. + * An error code that identifies the type of error that occured. * @type {string} * @memberof ModelError */ @@ -1002,19 +1002,19 @@ export interface ModelError { */ export interface PackageDimensions { /** - * Number that represents the given package dimension. + * Number representing the given package dimension. * @type {number} * @memberof PackageDimensions */ Length?: number; /** - * Number that represents the given package dimension. + * Number representing the given package dimension. * @type {number} * @memberof PackageDimensions */ Width?: number; /** - * Number that represents the given package dimension. + * Number representing the given package dimension. * @type {number} * @memberof PackageDimensions */ @@ -1033,7 +1033,7 @@ export interface PackageDimensions { PredefinedPackageDimensions?: PredefinedPackageDimensions | 'FedEx_Box_10kg' | 'FedEx_Box_25kg' | 'FedEx_Box_Extra_Large_1' | 'FedEx_Box_Extra_Large_2' | 'FedEx_Box_Large_1' | 'FedEx_Box_Large_2' | 'FedEx_Box_Medium_1' | 'FedEx_Box_Medium_2' | 'FedEx_Box_Small_1' | 'FedEx_Box_Small_2' | 'FedEx_Envelope' | 'FedEx_Padded_Pak' | 'FedEx_Pak_1' | 'FedEx_Pak_2' | 'FedEx_Tube' | 'FedEx_XL_Pak' | 'UPS_Box_10kg' | 'UPS_Box_25kg' | 'UPS_Express_Box' | 'UPS_Express_Box_Large' | 'UPS_Express_Box_Medium' | 'UPS_Express_Box_Small' | 'UPS_Express_Envelope' | 'UPS_Express_Hard_Pak' | 'UPS_Express_Legal_Envelope' | 'UPS_Express_Pak' | 'UPS_Express_Tube' | 'UPS_Laboratory_Pak' | 'UPS_Pad_Pak' | 'UPS_Pallet' | 'USPS_Card' | 'USPS_Flat' | 'USPS_FlatRateCardboardEnvelope' | 'USPS_FlatRateEnvelope' | 'USPS_FlatRateGiftCardEnvelope' | 'USPS_FlatRateLegalEnvelope' | 'USPS_FlatRatePaddedEnvelope' | 'USPS_FlatRateWindowEnvelope' | 'USPS_LargeFlatRateBoardGameBox' | 'USPS_LargeFlatRateBox' | 'USPS_Letter' | 'USPS_MediumFlatRateBox1' | 'USPS_MediumFlatRateBox2' | 'USPS_RegionalRateBoxA1' | 'USPS_RegionalRateBoxA2' | 'USPS_RegionalRateBoxB1' | 'USPS_RegionalRateBoxB2' | 'USPS_RegionalRateBoxC' | 'USPS_SmallFlatRateBox' | 'USPS_SmallFlatRateEnvelope'; } /** - * An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box. + * An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box. * @export * @enum {string} */ @@ -1097,13 +1097,13 @@ export enum PredefinedPackageDimensions { */ export interface RejectedShippingService { /** - * The rejected shipping carrier name. For example, USPS. + * The rejected shipping carrier name. e.g. USPS * @type {string} * @memberof RejectedShippingService */ CarrierName: string; /** - * The rejected shipping service localized name. For example, FedEx Standard Overnight. + * The rejected shipping service localized name. e.g. FedEx Standard Overnight * @type {string} * @memberof RejectedShippingService */ @@ -1115,7 +1115,7 @@ export interface RejectedShippingService { */ ShippingServiceId: string; /** - * A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`. + * A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX * @type {string} * @memberof RejectedShippingService */ @@ -1177,7 +1177,7 @@ export interface SellerInputDefinition { RestrictedSetValues?: Array; } /** - * The details of a shipment. Includes the shipment status. + * The details of a shipment, including the shipment status. * @export * @interface Shipment */ @@ -1201,7 +1201,7 @@ export interface Shipment { */ SellerOrderId?: string; /** - * The list of items you want to include in a shipment. + * The list of items to be included in a shipment. * @type {Array} * @memberof Shipment */ @@ -1292,7 +1292,7 @@ export interface ShipmentRequestDetails { */ SellerOrderId?: string; /** - * The list of items you want to include in a shipment. + * The list of items to be included in a shipment. * @type {Array} * @memberof ShipmentRequestDetails */ @@ -1390,7 +1390,7 @@ export interface ShippingOfferingFilter { */ export interface ShippingService { /** - * A plain text representation of a carrier\'s shipping service. For example, UPS Ground or FedEx Standard Overnight. + * A plain text representation of a carrier\'s shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\". * @type {string} * @memberof ShippingService */ @@ -1493,7 +1493,7 @@ export interface ShippingServiceOptions { */ DeclaredValue?: CurrencyAmount; /** - * When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK). + * When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK). * @type {boolean} * @memberof ShippingServiceOptions */ @@ -1593,7 +1593,7 @@ export interface Weight { export const MerchantFulfillmentApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1626,8 +1626,8 @@ export const MerchantFulfillmentApiAxiosParamCreator = function (configuration?: }; }, /** - * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {CreateShipmentRequest} body Request schema for `CreateShipment` operation. + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). + * @param {CreateShipmentRequest} body Request schema for CreateShipment operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1661,8 +1661,8 @@ export const MerchantFulfillmentApiAxiosParamCreator = function (configuration?: }; }, /** - * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {GetAdditionalSellerInputsRequest} body Request schema for the `GetAdditionalSellerInputs` operation. + * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). + * @param {GetAdditionalSellerInputsRequest} body Request schema for GetAdditionalSellerInputs operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1696,7 +1696,7 @@ export const MerchantFulfillmentApiAxiosParamCreator = function (configuration?: }; }, /** - * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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). * @param {GetEligibleShipmentServicesRequest} body Request schema for GetEligibleShipmentServices operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1731,7 +1731,7 @@ export const MerchantFulfillmentApiAxiosParamCreator = function (configuration?: }; }, /** - * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1774,7 +1774,7 @@ export const MerchantFulfillmentApiFp = function(configuration?: Configuration) const localVarAxiosParamCreator = MerchantFulfillmentApiAxiosParamCreator(configuration) return { /** - * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1784,8 +1784,8 @@ export const MerchantFulfillmentApiFp = function(configuration?: Configuration) return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {CreateShipmentRequest} body Request schema for `CreateShipment` operation. + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). + * @param {CreateShipmentRequest} body Request schema for CreateShipment operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1794,8 +1794,8 @@ export const MerchantFulfillmentApiFp = function(configuration?: Configuration) return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {GetAdditionalSellerInputsRequest} body Request schema for the `GetAdditionalSellerInputs` operation. + * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). + * @param {GetAdditionalSellerInputsRequest} body Request schema for GetAdditionalSellerInputs operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1804,7 +1804,7 @@ export const MerchantFulfillmentApiFp = function(configuration?: Configuration) return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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). * @param {GetEligibleShipmentServicesRequest} body Request schema for GetEligibleShipmentServices operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1814,7 +1814,7 @@ export const MerchantFulfillmentApiFp = function(configuration?: Configuration) return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1834,7 +1834,7 @@ export const MerchantFulfillmentApiFactory = function (configuration?: Configura const localVarFp = MerchantFulfillmentApiFp(configuration) return { /** - * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1843,8 +1843,8 @@ export const MerchantFulfillmentApiFactory = function (configuration?: Configura return localVarFp.cancelShipment(shipmentId, options).then((request) => request(axios, basePath)); }, /** - * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {CreateShipmentRequest} body Request schema for `CreateShipment` operation. + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). + * @param {CreateShipmentRequest} body Request schema for CreateShipment operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1852,8 +1852,8 @@ export const MerchantFulfillmentApiFactory = function (configuration?: Configura return localVarFp.createShipment(body, options).then((request) => request(axios, basePath)); }, /** - * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {GetAdditionalSellerInputsRequest} body Request schema for the `GetAdditionalSellerInputs` operation. + * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). + * @param {GetAdditionalSellerInputsRequest} body Request schema for GetAdditionalSellerInputs operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1861,7 +1861,7 @@ export const MerchantFulfillmentApiFactory = function (configuration?: Configura return localVarFp.getAdditionalSellerInputs(body, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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). * @param {GetEligibleShipmentServicesRequest} body Request schema for GetEligibleShipmentServices operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1870,7 +1870,7 @@ export const MerchantFulfillmentApiFactory = function (configuration?: Configura return localVarFp.getEligibleShipmentServices(body, options).then((request) => request(axios, basePath)); }, /** - * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {string} shipmentId The Amazon-defined shipment identifier for the shipment. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1902,7 +1902,7 @@ export interface MerchantFulfillmentApiCancelShipmentRequest { */ export interface MerchantFulfillmentApiCreateShipmentRequest { /** - * Request schema for `CreateShipment` operation. + * Request schema for CreateShipment operation. * @type {CreateShipmentRequest} * @memberof MerchantFulfillmentApiCreateShipment */ @@ -1916,7 +1916,7 @@ export interface MerchantFulfillmentApiCreateShipmentRequest { */ export interface MerchantFulfillmentApiGetAdditionalSellerInputsRequest { /** - * Request schema for the `GetAdditionalSellerInputs` operation. + * Request schema for GetAdditionalSellerInputs operation. * @type {GetAdditionalSellerInputsRequest} * @memberof MerchantFulfillmentApiGetAdditionalSellerInputs */ @@ -1959,7 +1959,7 @@ export interface MerchantFulfillmentApiGetShipmentRequest { */ export class MerchantFulfillmentApi extends BaseAPI { /** - * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {MerchantFulfillmentApiCancelShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1970,7 +1970,7 @@ export class MerchantFulfillmentApi extends BaseAPI { } /** - * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {MerchantFulfillmentApiCreateShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1981,7 +1981,7 @@ export class MerchantFulfillmentApi extends BaseAPI { } /** - * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {MerchantFulfillmentApiGetAdditionalSellerInputsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1992,7 +1992,7 @@ export class MerchantFulfillmentApi extends BaseAPI { } /** - * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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). * @param {MerchantFulfillmentApiGetEligibleShipmentServicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2003,7 +2003,7 @@ export class MerchantFulfillmentApi extends BaseAPI { } /** - * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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). * @param {MerchantFulfillmentApiGetShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/merchant-fulfillment-api-model/base.ts b/src/api-models/merchant-fulfillment-api-model/base.ts index 8150797c..14e70251 100644 --- a/src/api-models/merchant-fulfillment-api-model/base.ts +++ b/src/api-models/merchant-fulfillment-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Merchant Fulfillment - * With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services. + * The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/merchant-fulfillment-api-model/common.ts b/src/api-models/merchant-fulfillment-api-model/common.ts index 4f990343..37a4c8e0 100644 --- a/src/api-models/merchant-fulfillment-api-model/common.ts +++ b/src/api-models/merchant-fulfillment-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Merchant Fulfillment - * With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services. + * The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/merchant-fulfillment-api-model/configuration.ts b/src/api-models/merchant-fulfillment-api-model/configuration.ts index d03b5494..6cef0db3 100644 --- a/src/api-models/merchant-fulfillment-api-model/configuration.ts +++ b/src/api-models/merchant-fulfillment-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Merchant Fulfillment - * With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services. + * The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/merchant-fulfillment-api-model/index.ts b/src/api-models/merchant-fulfillment-api-model/index.ts index 4c667df4..e46327e8 100644 --- a/src/api-models/merchant-fulfillment-api-model/index.ts +++ b/src/api-models/merchant-fulfillment-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Merchant Fulfillment - * With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services. + * The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/orders-api-model/api.ts b/src/api-models/orders-api-model/api.ts index 4ad45ec5..0f6657a7 100644 --- a/src/api-models/orders-api-model/api.ts +++ b/src/api-models/orders-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Orders - * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response. **Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces. + * Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response). * * The version of the OpenAPI document: v0 * @@ -100,7 +100,7 @@ export interface Address { */ CountryCode?: string; /** - * The phone number of the buyer. **Note**: 1. This attribute is only available for shipping address. 2. The buyer `Phone` number is suppressed in some cases, including but not limited to a. `Phone` is suppressed for all Fulfillment by Amazon (FBA) orders. b. `Phone` is suppressed for the shipped MFN(Fulfilled by the seller) order when current date is past Latest Delivery Date. + * The phone number of the buyer. **Note**: 1. This attribute is only available for shipping address. 2. In some cases, the buyer phone number is suppressed: a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. b. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date. * @type {string} * @memberof Address */ @@ -129,7 +129,7 @@ export enum AddressAddressTypeEnum { } /** - * The container of extended address fields. For example, street name, street number. Only available with Brazil shipping addresses as of now. + * The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses. * @export * @interface AddressExtendedFields */ @@ -141,7 +141,7 @@ export interface AddressExtendedFields { */ StreetName?: string; /** - * The house number/building number/property number in the street. + * The house, building, or property number associated with the location\'s street address. * @type {string} * @memberof AddressExtendedFields */ @@ -153,14 +153,14 @@ export interface AddressExtendedFields { */ Complement?: string; /** - * The neighborhood. It\'s smaller than a region and an integral part of an address. It is used in some countries like Brazil. + * The neighborhood. This value is only used in some countries (such as Brazil). * @type {string} * @memberof AddressExtendedFields */ Neighborhood?: string; } /** - * An item associated with an order item. For example, a tire installation service purchased with tires. + * An item that is associated with an order item. For example, a tire installation service that is purchased with tires. * @export * @interface AssociatedItem */ @@ -259,7 +259,7 @@ export enum BusinessHoursDayOfWeekEnum { */ export interface BuyerCustomizedInfoDetail { /** - * The location of a zip file containing Amazon Custom data. + * The location of a ZIP file containing Amazon Custom data. * @type {string} * @memberof BuyerCustomizedInfoDetail */ @@ -296,7 +296,7 @@ export interface BuyerInfo { */ BuyerTaxInfo?: BuyerTaxInfo; /** - * The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. + * The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout. * @type {string} * @memberof BuyerInfo */ @@ -397,13 +397,13 @@ export interface ConfirmShipmentErrorResponse { */ export interface ConfirmShipmentOrderItem { /** - * The unique identifier of the order item. + * The order item\'s unique identifier. * @type {string} * @memberof ConfirmShipmentOrderItem */ orderItemId: string; /** - * The quantity of the item. + * The item\'s quantity. * @type {number} * @memberof ConfirmShipmentOrderItem */ @@ -428,7 +428,7 @@ export interface ConfirmShipmentRequest { */ packageDetail: PackageDetail; /** - * The cod collection method, support in JP only. + * The COD collection method (only supported in the JP marketplace). * @type {string} * @memberof ConfirmShipmentRequest */ @@ -490,7 +490,7 @@ export interface DeliveryPreferences { AddressInstructions?: string; } /** - * The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. + * The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders. * @export * @enum {string} */ @@ -552,18 +552,174 @@ export interface ExceptionDates { OpenIntervals?: Array; } /** - * Contains the instructions about the fulfillment like where should it be fulfilled from. + * Contains the instructions about the fulfillment, such as the location from where you want the order filled. * @export * @interface FulfillmentInstruction */ export interface FulfillmentInstruction { /** - * Denotes the recommended `sourceId` where the order should be fulfilled from. + * The `sourceId` of the location from where you want the order fulfilled. * @type {string} * @memberof FulfillmentInstruction */ FulfillmentSupplySourceId?: string; } +/** + * Contains all fulfillment plans for the order + * @export + * @interface FulfillmentInstructions + */ +export interface FulfillmentInstructions { + /** + * List of all fulfillment plans for the given order id + * @type {Array} + * @memberof FulfillmentInstructions + */ + FulfillmentPlans?: Array; + /** + * An Amazon-defined order identifier, in 3-7-7 format. + * @type {string} + * @memberof FulfillmentInstructions + */ + AmazonOrderId: string; +} +/** + * Represents a location from which the plan is to be fulfilled. + * @export + * @interface FulfillmentLocation + */ +export interface FulfillmentLocation { + /** + * The fulfillment location identifier. + * @type {string} + * @memberof FulfillmentLocation + */ + SupplySourceId?: string; +} +/** + * A collection of order items that are to be fulfilled from the same location with the same shipping, pickup, and service instructions. + * @export + * @interface FulfillmentPlan + */ +export interface FulfillmentPlan { + /** + * Unique identifier for a fulfillment plan. + * @type {string} + * @memberof FulfillmentPlan + */ + FulfillmentPlanId: string; + /** + * Time when the fulfillment plan was created in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @type {string} + * @memberof FulfillmentPlan + */ + CreationDate: string; + /** + * Type of fulfillment + * @type {string} + * @memberof FulfillmentPlan + */ + FulfillmentType: FulfillmentPlanFulfillmentTypeEnum | 'INSTORE_PICKUP' | 'SERVICE' | 'SHIP'; + /** + * The fulfillment plan status. + * @type {string} + * @memberof FulfillmentPlan + */ + FulfillmentPlanStatus: FulfillmentPlanFulfillmentPlanStatusEnum | 'ACTIVE' | 'ABORTED' | 'COMPLETED' | 'PARTIALLY_FULFILLED'; + /** + * The time when the fulfillment plan\'s status was last updated in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @type {string} + * @memberof FulfillmentPlan + */ + LastStatusUpdateDate: string; + /** + * + * @type {FulfillmentLocation} + * @memberof FulfillmentPlan + */ + FulfillmentLocation?: FulfillmentLocation; + /** + * + * @type {ShippingInstructions} + * @memberof FulfillmentPlan + */ + ShippingInstructions?: ShippingInstructions; + /** + * The details of the order items that are included in the fulfillment plan. + * @type {Array} + * @memberof FulfillmentPlan + */ + FulfillmentPlanItems: Array; +} + +/** + * @export + * @enum {string} + */ +export enum FulfillmentPlanFulfillmentTypeEnum { + InstorePickup = 'INSTORE_PICKUP', + Service = 'SERVICE', + Ship = 'SHIP' +} +/** + * @export + * @enum {string} + */ +export enum FulfillmentPlanFulfillmentPlanStatusEnum { + Active = 'ACTIVE', + Aborted = 'ABORTED', + Completed = 'COMPLETED', + PartiallyFulfilled = 'PARTIALLY_FULFILLED' +} + +/** + * Details the importance of the constraint present on the item. + * @export + * @enum {string} + */ +export enum FulfillmentPlanConstraintType { + Mandatory = 'MANDATORY', + Recommended = 'RECOMMENDED' +} + +/** + * The order items associated with this fulfillment plan. + * @export + * @interface FulfillmentPlanItem + */ +export interface FulfillmentPlanItem { + /** + * An Amazon-defined associated order item\'s order item identifier. + * @type {string} + * @memberof FulfillmentPlanItem + */ + OrderItemId: string; + /** + * + * @type {Measurement} + * @memberof FulfillmentPlanItem + */ + Measurement: Measurement; +} +/** + * Delivery constraints applicable to this order. + * @export + * @interface FulfillmentPlanShippingConstraints + */ +export interface FulfillmentPlanShippingConstraints { + /** + * + * @type {FulfillmentPlanConstraintType} + * @memberof FulfillmentPlanShippingConstraints + */ + PalletDelivery?: FulfillmentPlanConstraintType | 'MANDATORY' | 'RECOMMENDED'; + /** + * + * @type {FulfillmentPlanConstraintType} + * @memberof FulfillmentPlanShippingConstraints + */ + SignatureConfirmation?: FulfillmentPlanConstraintType | 'MANDATORY' | 'RECOMMENDED'; +} /** * The response schema for the `getOrderAddress` operation. * @export @@ -602,6 +758,25 @@ export interface GetOrderBuyerInfoResponse { */ errors?: Array; } +/** + * The response schema for the `getOrderFulfillmentInstructions` operation. + * @export + * @interface GetOrderFulfillmentInstructionsResponse + */ +export interface GetOrderFulfillmentInstructionsResponse { + /** + * + * @type {FulfillmentInstructions} + * @memberof GetOrderFulfillmentInstructionsResponse + */ + payload?: FulfillmentInstructions; + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof GetOrderFulfillmentInstructionsResponse + */ + errors?: Array; +} /** * The response schema for the `getOrderItemsBuyerInfo` operation. * @export @@ -722,7 +897,7 @@ export interface ItemBuyerInfo { */ GiftWrapTax?: Money; /** - * A gift message provided by the buyer. **Note**: This attribute is only available for MFN (Fulfilled by the seller) orders. + * A gift message provided by the buyer. **Note**: This attribute is only available for MFN (fulfilled by seller) orders. * @type {string} * @memberof ItemBuyerInfo */ @@ -754,13 +929,13 @@ export interface MarketplaceTaxInfo { */ export interface Measurement { /** - * The unit of measure for this measurement. + * The unit of measure. * @type {string} * @memberof Measurement */ Unit: MeasurementUnitEnum | 'OUNCES' | 'POUNDS' | 'KILOGRAMS' | 'GRAMS' | 'MILLIGRAMS' | 'INCHES' | 'FEET' | 'METERS' | 'CENTIMETERS' | 'MILLIMETERS' | 'SQUARE_METERS' | 'SQUARE_CENTIMETERS' | 'SQUARE_FEET' | 'SQUARE_INCHES' | 'GALLONS' | 'PINTS' | 'QUARTS' | 'FLUID_OUNCES' | 'LITERS' | 'CUBIC_METERS' | 'CUBIC_FEET' | 'CUBIC_INCHES' | 'CUBIC_CENTIMETERS' | 'COUNT'; /** - * The value of the measurement. + * The measurement value. * @type {number} * @memberof Measurement */ @@ -905,7 +1080,7 @@ export interface Order { */ PurchaseDate: string; /** - * The date when the order was last updated. **Note**: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01. + * The date when the order was last updated. __Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01. * @type {string} * @memberof Order */ @@ -917,25 +1092,25 @@ export interface Order { */ OrderStatus: OrderOrderStatusEnum | 'Pending' | 'Unshipped' | 'PartiallyShipped' | 'Shipped' | 'Canceled' | 'Unfulfillable' | 'InvoiceUnconfirmed' | 'PendingAvailability'; /** - * Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN). + * Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`). * @type {string} * @memberof Order */ FulfillmentChannel?: OrderFulfillmentChannelEnum | 'MFN' | 'AFN'; /** - * The sales channel of the first item in the order. + * The sales channel for the first item in the order. * @type {string} * @memberof Order */ SalesChannel?: string; /** - * The order channel of the first item in the order. + * The order channel for the first item in the order. * @type {string} * @memberof Order */ OrderChannel?: string; /** - * The shipment service level of the order. + * The order\'s shipment service level. * @type {string} * @memberof Order */ @@ -965,7 +1140,7 @@ export interface Order { */ PaymentExecutionDetail?: Array; /** - * The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (CVS) payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information. + * The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information. * @type {string} * @memberof Order */ @@ -983,7 +1158,7 @@ export interface Order { */ MarketplaceId?: string; /** - * The shipment service level category of the order. **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, `Standard`. + * The shipment service level category for the order. **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`. * @type {string} * @memberof Order */ @@ -1001,31 +1176,31 @@ export interface Order { */ CbaDisplayableShippingLabel?: string; /** - * The type of the order. + * The order\'s type. * @type {string} * @memberof Order */ OrderType?: OrderOrderTypeEnum | 'StandardOrder' | 'LongLeadTimeOrder' | 'Preorder' | 'BackOrder' | 'SourcingOnDemandOrder'; /** - * The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. **Note**: `EarliestShipDate` might not be returned for orders placed before February 1, 2013. + * The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. __Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013. * @type {string} * @memberof Order */ EarliestShipDate?: string; /** - * The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. **Note**: `LatestShipDate` might not be returned for orders placed before February 1, 2013. + * The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. __Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013. * @type {string} * @memberof Order */ LatestShipDate?: string; /** - * The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. + * The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. * @type {string} * @memberof Order */ EarliestDeliveryDate?: string; /** - * The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a `PendingAvailability`, Pending, or Canceled status. + * The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status. * @type {string} * @memberof Order */ @@ -1043,19 +1218,19 @@ export interface Order { */ IsPrime?: boolean; /** - * When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see \"Premium Shipping Options\" in the Seller Central Help for your marketplace. + * When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to \"Premium Shipping Options\" in the Seller Central Help for your marketplace. * @type {boolean} * @memberof Order */ IsPremiumOrder?: boolean; /** - * When true, the order is a GlobalExpress order. + * When true, the order is a `GlobalExpress` order. * @type {boolean} * @memberof Order */ IsGlobalExpressEnabled?: boolean; /** - * The order ID value for the order that is being replaced. Returned only if `IsReplacementOrder` = true. + * The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true. * @type {string} * @memberof Order */ @@ -1067,13 +1242,13 @@ export interface Order { */ IsReplacementOrder?: boolean; /** - * Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders. + * Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders. * @type {string} * @memberof Order */ PromiseResponseDueDate?: string; /** - * When true, the estimated ship date is specified for the order. Returned only for Sourcing on Demand orders. + * When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders. * @type {boolean} * @memberof Order */ @@ -1234,7 +1409,7 @@ export interface OrderAddress { */ AmazonOrderId: string; /** - * The company name of the contact buyer. For Invoice By Amazon (IBA) orders, the buyer company should be Amazon entities. + * The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities. * @type {string} * @memberof OrderAddress */ @@ -1289,7 +1464,7 @@ export interface OrderBuyerInfo { */ BuyerTaxInfo?: BuyerTaxInfo; /** - * The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. + * The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout. * @type {string} * @memberof OrderBuyerInfo */ @@ -1302,13 +1477,13 @@ export interface OrderBuyerInfo { */ export interface OrderItem { /** - * The Amazon Standard Identification Number (ASIN) of the item. + * The item\'s Amazon Standard Identification Number (ASIN). * @type {string} * @memberof OrderItem */ ASIN: string; /** - * The seller stock keeping unit (SKU) of the item. + * The item\'s seller stock keeping unit (SKU). * @type {string} * @memberof OrderItem */ @@ -1326,7 +1501,7 @@ export interface OrderItem { */ AssociatedItems?: Array; /** - * The name of the item. + * The item\'s name. * @type {string} * @memberof OrderItem */ @@ -1422,43 +1597,43 @@ export interface OrderItem { */ CODFeeDiscount?: Money; /** - * Indicates whether the item is a gift. **Possible values**: `true`, `false`. + * Indicates whether the item is a gift. **Possible values**: `true` and `false`. * @type {string} * @memberof OrderItem */ IsGift?: string; /** - * The condition of the item as described by the seller. + * The condition of the item, as described by the seller. * @type {string} * @memberof OrderItem */ ConditionNote?: string; /** - * The condition of the item. **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, `Club`. + * The condition of the item. **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`. * @type {string} * @memberof OrderItem */ ConditionId?: string; /** - * The subcondition of the item. **Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, `Other`. + * The subcondition of the item. **Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`. * @type {string} * @memberof OrderItem */ ConditionSubtypeId?: string; /** - * The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format. + * The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. * @type {string} * @memberof OrderItem */ ScheduledDeliveryStartDate?: string; /** - * The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format. + * The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. * @type {string} * @memberof OrderItem */ ScheduledDeliveryEndDate?: string; /** - * Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to [Amazon Business](https://business.amazon.com). **Possible values**: `BusinessPrice` - A special price that is available only for Amazon Business orders. + * Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible values**: `BusinessPrice` * @type {string} * @memberof OrderItem */ @@ -1470,19 +1645,19 @@ export interface OrderItem { */ TaxCollection?: TaxCollection; /** - * When true, the product type for this item has a serial number. Returned only for Amazon Easy Ship orders. + * When true, the product type for this item has a serial number. Only returned for Amazon Easy Ship orders. * @type {boolean} * @memberof OrderItem */ SerialNumberRequired?: boolean; /** - * When true, the ASIN is enrolled in Transparency and the Transparency serial number that needs to be submitted can be determined by the following: **1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN). **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. **QR code SN:** Submit the URL that the QR code generates. + * When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by: **1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN). **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. **QR code SN:** Submit the URL that the QR code generates. * @type {boolean} * @memberof OrderItem */ IsTransparency?: boolean; /** - * The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale. + * The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale. * @type {string} * @memberof OrderItem */ @@ -1577,7 +1752,7 @@ export interface OrderItemBuyerInfo { */ GiftWrapTax?: Money; /** - * A gift message provided by the buyer. **Note**: This attribute is only available for MFN (Fulfilled by the seller) orders. + * A gift message provided by the buyer. **Note**: This attribute is only available for MFN (fulfilled by seller) orders. * @type {string} * @memberof OrderItemBuyerInfo */ @@ -1689,13 +1864,13 @@ export interface OrdersList { */ NextToken?: string; /** - * A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in ISO 8601 format. + * Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @type {string} * @memberof OrdersList */ LastUpdatedBefore?: string; /** - * A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. + * Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @type {string} * @memberof OrdersList */ @@ -1725,13 +1900,13 @@ export interface PackageDetail { */ packageReferenceId: string; /** - * Identifies the carrier that will deliver the package. This field is required for all marketplaces. For the acceptable `CarrierCode` value, refer to the list of CarrierCode. + * Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces). * @type {string} * @memberof PackageDetail */ carrierCode: string; /** - * Carrier Name that will deliver the package. Required when carrierCode is \"Others\" + * Carrier Name that will deliver the package. Required when `carrierCode` is \"Others\" * @type {string} * @memberof PackageDetail */ @@ -1755,7 +1930,7 @@ export interface PackageDetail { */ shipDate: string; /** - * The unique identifier of the supply source. + * The unique identifier for the supply source. * @type {string} * @memberof PackageDetail */ @@ -1780,7 +1955,7 @@ export interface PaymentExecutionDetailItem { */ Payment: Money; /** - * A sub-payment method for a COD order. **Possible values**: * `COD`: Cash On Delivery. * `GC`: Gift Card. * `PointsAccount`: Amazon Points. * `Invoice`: Invoice. + * A sub-payment method for a COD order. **Possible values**: * `COD`: Cash on delivery * `GC`: Gift card * `PointsAccount`: Amazon Points * `Invoice`: Invoice * @type {string} * @memberof PaymentExecutionDetailItem */ @@ -1818,12 +1993,61 @@ export interface PreferredDeliveryTime { */ BusinessHours?: Array; /** - * Dates when the business is closed in the next 30 days. + * Dates when the business is closed during the next 30 days. * @type {Array} * @memberof PreferredDeliveryTime */ ExceptionDates?: Array; } +/** + * Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller’s own records. Only approved orders can have prescriptions. + * @export + * @interface PrescriptionDetail + */ +export interface PrescriptionDetail { + /** + * The identifier for the prescription used to verify the regulated product. + * @type {string} + * @memberof PrescriptionDetail + */ + prescriptionId: string; + /** + * The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @type {string} + * @memberof PrescriptionDetail + */ + expirationDate: string; + /** + * The number of units in each fill as provided in the prescription. + * @type {number} + * @memberof PrescriptionDetail + */ + writtenQuantity: number; + /** + * The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0. + * @type {number} + * @memberof PrescriptionDetail + */ + totalRefillsAuthorized: number; + /** + * The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be 0. + * @type {number} + * @memberof PrescriptionDetail + */ + refillsRemaining: number; + /** + * The identifier for the clinic which provided the prescription used to verify the regulated product. + * @type {string} + * @memberof PrescriptionDetail + */ + clinicId: string; + /** + * The instructions for the prescription as provided by the approver of the regulated product. + * @type {string} + * @memberof PrescriptionDetail + */ + usageInstructions: string; +} /** * Product information on the number of items. * @export @@ -1857,13 +2081,13 @@ export interface RegulatedInformation { */ export interface RegulatedInformationField { /** - * The unique identifier for the field. + * The unique identifier of the field. * @type {string} * @memberof RegulatedInformationField */ FieldId: string; /** - * The name for the field. + * The name of the field. * @type {string} * @memberof RegulatedInformationField */ @@ -1875,7 +2099,7 @@ export interface RegulatedInformationField { */ FieldType: RegulatedInformationFieldFieldTypeEnum | 'Text' | 'FileAttachment'; /** - * The content of the field as collected in regulatory form. Note that `FileAttachment` type fields will contain a URL to download the attachment here. + * The content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment. * @type {string} * @memberof RegulatedInformationField */ @@ -1892,7 +2116,7 @@ export enum RegulatedInformationFieldFieldTypeEnum { } /** - * The verification status of the order along with associated approval or rejection metadata. + * The verification status of the order, along with associated approval or rejection metadata. * @export * @interface RegulatedOrderVerificationStatus */ @@ -1922,7 +2146,7 @@ export interface RegulatedOrderVerificationStatus { */ RejectionReason?: RejectionReason; /** - * The date the order was reviewed. In ISO 8601 date time format. + * The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. * @type {string} * @memberof RegulatedOrderVerificationStatus */ @@ -1933,9 +2157,15 @@ export interface RegulatedOrderVerificationStatus { * @memberof RegulatedOrderVerificationStatus */ ExternalReviewerId?: string; + /** + * A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided. + * @type {Array} + * @memberof RegulatedOrderVerificationStatus + */ + ValidVerificationDetails?: Array; } /** - * The reason for rejecting the order\'s regulated information. Not present if the order isn\'t rejected. + * The reason for rejecting the order\'s regulated information. This is only present if the order is rejected. * @export * @interface RejectionReason */ @@ -1976,6 +2206,49 @@ export interface ShippingConstraints { * @memberof ShippingConstraints */ PalletDelivery?: ConstraintType | 'MANDATORY'; + /** + * + * @type {ConstraintType} + * @memberof ShippingConstraints + */ + SignatureConfirmation?: ConstraintType | 'MANDATORY'; + /** + * + * @type {ConstraintType} + * @memberof ShippingConstraints + */ + RecipientIdentityVerification?: ConstraintType | 'MANDATORY'; + /** + * + * @type {ConstraintType} + * @memberof ShippingConstraints + */ + RecipientAgeVerification?: ConstraintType | 'MANDATORY'; +} +/** + * The shipping-related information of a delivery. + * @export + * @interface ShippingInstructions + */ +export interface ShippingInstructions { + /** + * The name of the carrier that delivers the package. + * @type {string} + * @memberof ShippingInstructions + */ + CarrierCode?: string; + /** + * The ship method that is used for the order. + * @type {string} + * @memberof ShippingInstructions + */ + ShippingMethod?: string; + /** + * + * @type {FulfillmentPlanShippingConstraints} + * @memberof ShippingInstructions + */ + ShippingConstraints?: FulfillmentPlanShippingConstraints; } /** * Substitution options for an order item. @@ -1984,7 +2257,7 @@ export interface ShippingConstraints { */ export interface SubstitutionOption { /** - * The Amazon Standard Identification Number (ASIN) of the item. + * The item\'s Amazon Standard Identification Number (ASIN). * @type {string} * @memberof SubstitutionOption */ @@ -1996,13 +2269,13 @@ export interface SubstitutionOption { */ QuantityOrdered?: number; /** - * The seller stock keeping unit (SKU) of the item. + * The item\'s seller stock keeping unit (SKU). * @type {string} * @memberof SubstitutionOption */ SellerSKU?: string; /** - * The title of the item. + * The item\'s title. * @type {string} * @memberof SubstitutionOption */ @@ -2045,7 +2318,7 @@ export enum SubstitutionPreferencesSubstitutionTypeEnum { } /** - * The tax classification for the order. + * The tax classification of the order. * @export * @interface TaxClassification */ @@ -2173,19 +2446,57 @@ export interface UpdateVerificationStatusRequestBody { * @type {VerificationStatus} * @memberof UpdateVerificationStatusRequestBody */ - status: VerificationStatus | 'Pending' | 'Approved' | 'Rejected' | 'Expired' | 'Cancelled'; + status?: VerificationStatus | 'Pending' | 'Approved' | 'Rejected' | 'Expired' | 'Cancelled'; /** - * The identifier for the order\'s regulated information reviewer. + * The identifier of the order\'s regulated information reviewer. * @type {string} * @memberof UpdateVerificationStatusRequestBody */ externalReviewerId: string; /** - * The unique identifier for the rejection reason used for rejecting the order\'s regulated information. Only required if the new status is rejected. + * The unique identifier of the rejection reason used for rejecting the order\'s regulated information. Only required if the new status is rejected. * @type {string} * @memberof UpdateVerificationStatusRequestBody */ rejectionReasonId?: string; + /** + * + * @type {VerificationDetails} + * @memberof UpdateVerificationStatusRequestBody + */ + verificationDetails?: VerificationDetails; +} +/** + * The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order. + * @export + * @interface ValidVerificationDetail + */ +export interface ValidVerificationDetail { + /** + * A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`. + * @type {string} + * @memberof ValidVerificationDetail + */ + VerificationDetailType: string; + /** + * A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is [\"Approved\"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`. + * @type {Array} + * @memberof ValidVerificationDetail + */ + ValidVerificationStatuses: Array<(VerificationStatus | 'Pending' | 'Approved' | 'Rejected' | 'Expired' | 'Cancelled')>; +} +/** + * Additional information related to the verification of a regulated order. + * @export + * @interface VerificationDetails + */ +export interface VerificationDetails { + /** + * + * @type {PrescriptionDetail} + * @memberof VerificationDetails + */ + prescriptionDetail?: PrescriptionDetail; } /** * The verification status of the order. @@ -2208,9 +2519,9 @@ export enum VerificationStatus { export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param {ConfirmShipmentRequest} payload The request body of the `confirmShipment` operation. + * @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2247,7 +2558,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2280,7 +2591,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2313,7 +2624,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2346,7 +2657,40 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. **Note**: When an order is in the Pending state (the order has been placed but payment has not been authorized), the `getOrderItems` operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the `Unshipped`, `Partially Shipped`, or `Shipped` state, the `getOrderItems` operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrderFulfillmentInstructions: async (orderId: string, options: any = {}): Promise => { + // verify required parameter 'orderId' is not null or undefined + assertParamExists('getOrderFulfillmentInstructions', 'orderId', orderId) + const localVarPath = `/orders/v0/orders/{orderId}/fulfillmentInstructions` + .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -2384,7 +2728,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -2422,7 +2766,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2455,29 +2799,29 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {Array} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values. - * @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified. - * @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time. - * @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time. - * @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time. + * Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. + * @param {Array} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. + * @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set. + * @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time. + * @param {string} [lastUpdatedAfter] Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set. + * @param {string} [lastUpdatedBefore] Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time. * @param {Array} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.) - * @param {Array} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller). - * @param {Array} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`). + * @param {Array} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). + * @param {Array} [paymentMethods] A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS). * @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address. - * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. + * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified. * @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. * @param {Array} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.) * @param {Array} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.) * @param {string} [nextToken] A string token returned in the response of your previous request. - * @param {Array} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. - * @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from. + * @param {Array} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. + * @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled. * @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered. * @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain. - * @param {string} [earliestDeliveryDateBefore] A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [earliestDeliveryDateAfter] A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [latestDeliveryDateBefore] A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [latestDeliveryDateAfter] A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {string} [earliestDeliveryDateBefore] Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [earliestDeliveryDateAfter] Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2596,7 +2940,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation. * @param {*} [options] Override http request option. @@ -2645,9 +2989,9 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = OrdersV0ApiAxiosParamCreator(configuration) return { /** - * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param {ConfirmShipmentRequest} payload The request body of the `confirmShipment` operation. + * @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2656,7 +3000,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2666,7 +3010,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2676,7 +3020,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2686,7 +3030,17 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. **Note**: When an order is in the Pending state (the order has been placed but payment has not been authorized), the `getOrderItems` operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the `Unshipped`, `Partially Shipped`, or `Shipped` state, the `getOrderItems` operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getOrderFulfillmentInstructions(orderId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderFulfillmentInstructions(orderId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -2697,7 +3051,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -2708,7 +3062,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2718,29 +3072,29 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {Array} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values. - * @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified. - * @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time. - * @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time. - * @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time. + * Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. + * @param {Array} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. + * @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set. + * @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time. + * @param {string} [lastUpdatedAfter] Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set. + * @param {string} [lastUpdatedBefore] Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time. * @param {Array} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.) - * @param {Array} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller). - * @param {Array} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`). + * @param {Array} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). + * @param {Array} [paymentMethods] A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS). * @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address. - * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. + * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified. * @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. * @param {Array} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.) * @param {Array} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.) * @param {string} [nextToken] A string token returned in the response of your previous request. - * @param {Array} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. - * @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from. + * @param {Array} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. + * @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled. * @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered. * @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain. - * @param {string} [earliestDeliveryDateBefore] A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [earliestDeliveryDateAfter] A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [latestDeliveryDateBefore] A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [latestDeliveryDateAfter] A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {string} [earliestDeliveryDateBefore] Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [earliestDeliveryDateAfter] Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2749,7 +3103,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation. * @param {*} [options] Override http request option. @@ -2770,9 +3124,9 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP const localVarFp = OrdersV0ApiFp(configuration) return { /** - * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param {ConfirmShipmentRequest} payload The request body of the `confirmShipment` operation. + * @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2780,7 +3134,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.confirmShipment(orderId, payload, options).then((request) => request(axios, basePath)); }, /** - * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2789,7 +3143,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath)); }, /** - * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2798,7 +3152,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath)); }, /** - * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2807,7 +3161,16 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderBuyerInfo(orderId, options).then((request) => request(axios, basePath)); }, /** - * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. **Note**: When an order is in the Pending state (the order has been placed but payment has not been authorized), the `getOrderItems` operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the `Unshipped`, `Partially Shipped`, or `Shipped` state, the `getOrderItems` operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrderFulfillmentInstructions(orderId: string, options?: any): AxiosPromise { + return localVarFp.getOrderFulfillmentInstructions(orderId, options).then((request) => request(axios, basePath)); + }, + /** + * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -2817,7 +3180,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -2827,7 +3190,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderItemsBuyerInfo(orderId, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2836,29 +3199,29 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderRegulatedInfo(orderId, options).then((request) => request(axios, basePath)); }, /** - * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {Array} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values. - * @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified. - * @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time. - * @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time. - * @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time. + * Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. + * @param {Array} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. + * @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set. + * @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time. + * @param {string} [lastUpdatedAfter] Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set. + * @param {string} [lastUpdatedBefore] Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time. * @param {Array} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.) - * @param {Array} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller). - * @param {Array} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`). + * @param {Array} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). + * @param {Array} [paymentMethods] A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS). * @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address. - * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. + * @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified. * @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. * @param {Array} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.) * @param {Array} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.) * @param {string} [nextToken] A string token returned in the response of your previous request. - * @param {Array} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. - * @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from. + * @param {Array} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. + * @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled. * @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered. * @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain. - * @param {string} [earliestDeliveryDateBefore] A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [earliestDeliveryDateAfter] A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [latestDeliveryDateBefore] A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. - * @param {string} [latestDeliveryDateAfter] A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {string} [earliestDeliveryDateBefore] Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [earliestDeliveryDateAfter] Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2866,7 +3229,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options).then((request) => request(axios, basePath)); }, /** - * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation. * @param {*} [options] Override http request option. @@ -2892,7 +3255,7 @@ export interface OrdersV0ApiConfirmShipmentRequest { readonly orderId: string /** - * The request body of the `confirmShipment` operation. + * Request body of `confirmShipment`. * @type {ConfirmShipmentRequest} * @memberof OrdersV0ApiConfirmShipment */ @@ -2941,6 +3304,20 @@ export interface OrdersV0ApiGetOrderBuyerInfoRequest { readonly orderId: string } +/** + * Request parameters for getOrderFulfillmentInstructions operation in OrdersV0Api. + * @export + * @interface OrdersV0ApiGetOrderFulfillmentInstructionsRequest + */ +export interface OrdersV0ApiGetOrderFulfillmentInstructionsRequest { + /** + * An Amazon-defined order identifier, in 3-7-7 format. + * @type {string} + * @memberof OrdersV0ApiGetOrderFulfillmentInstructions + */ + readonly orderId: string +} + /** * Request parameters for getOrderItems operation in OrdersV0Api. * @export @@ -3004,35 +3381,35 @@ export interface OrdersV0ApiGetOrderRegulatedInfoRequest { */ export interface OrdersV0ApiGetOrdersRequest { /** - * A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values. + * A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. * @type {Array} * @memberof OrdersV0ApiGetOrders */ readonly marketplaceIds: Array /** - * A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified. + * Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set. * @type {string} * @memberof OrdersV0ApiGetOrders */ readonly createdAfter?: string /** - * A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time. + * Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time. * @type {string} * @memberof OrdersV0ApiGetOrders */ readonly createdBefore?: string /** - * A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time. + * Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set. * @type {string} * @memberof OrdersV0ApiGetOrders */ readonly lastUpdatedAfter?: string /** - * A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time. + * Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time. * @type {string} * @memberof OrdersV0ApiGetOrders */ @@ -3046,14 +3423,14 @@ export interface OrdersV0ApiGetOrdersRequest { readonly orderStatuses?: Array /** - * A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller). + * A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). * @type {Array} * @memberof OrdersV0ApiGetOrders */ readonly fulfillmentChannels?: Array /** - * A list of payment method values. Used to select orders paid using the specified payment methods. **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`). + * A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS). * @type {Array} * @memberof OrdersV0ApiGetOrders */ @@ -3067,7 +3444,7 @@ export interface OrdersV0ApiGetOrdersRequest { readonly buyerEmail?: string /** - * An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. + * An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified. * @type {string} * @memberof OrdersV0ApiGetOrders */ @@ -3102,14 +3479,14 @@ export interface OrdersV0ApiGetOrdersRequest { readonly nextToken?: string /** - * A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. + * A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. * @type {Array} * @memberof OrdersV0ApiGetOrders */ readonly amazonOrderIds?: Array /** - * Denotes the recommended sourceId where the order should be fulfilled from. + * The `sourceId` of the location from where you want the order fulfilled. * @type {string} * @memberof OrdersV0ApiGetOrders */ @@ -3130,28 +3507,28 @@ export interface OrdersV0ApiGetOrdersRequest { readonly storeChainStoreId?: string /** - * A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @type {string} * @memberof OrdersV0ApiGetOrders */ readonly earliestDeliveryDateBefore?: string /** - * A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @type {string} * @memberof OrdersV0ApiGetOrders */ readonly earliestDeliveryDateAfter?: string /** - * A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @type {string} * @memberof OrdersV0ApiGetOrders */ readonly latestDeliveryDateBefore?: string /** - * A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. * @type {string} * @memberof OrdersV0ApiGetOrders */ @@ -3187,7 +3564,7 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest { */ export class OrdersV0Api extends BaseAPI { /** - * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3198,7 +3575,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3209,7 +3586,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3220,7 +3597,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3231,7 +3608,18 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. **Note**: When an order is in the Pending state (the order has been placed but payment has not been authorized), the `getOrderItems` operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the `Unshipped`, `Partially Shipped`, or `Shipped` state, the `getOrderItems` operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {OrdersV0ApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrdersV0Api + */ + public getOrderFulfillmentInstructions(requestParameters: OrdersV0ApiGetOrderFulfillmentInstructionsRequest, options?: any) { + return OrdersV0ApiFp(this.configuration).getOrderFulfillmentInstructions(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3242,7 +3630,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3253,7 +3641,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3264,7 +3652,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. * @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3275,7 +3663,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3294,7 +3682,7 @@ export class OrdersV0Api extends BaseAPI { export const ShipmentApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation. * @param {*} [options] Override http request option. @@ -3343,7 +3731,7 @@ export const ShipmentApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ShipmentApiAxiosParamCreator(configuration) return { /** - * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation. * @param {*} [options] Override http request option. @@ -3364,7 +3752,7 @@ export const ShipmentApiFactory = function (configuration?: Configuration, baseP const localVarFp = ShipmentApiFp(configuration) return { /** - * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation. * @param {*} [options] Override http request option. @@ -3405,7 +3793,7 @@ export interface ShipmentApiUpdateShipmentStatusRequest { */ export class ShipmentApi extends BaseAPI { /** - * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ShipmentApiUpdateShipmentStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/orders-api-model/base.ts b/src/api-models/orders-api-model/base.ts index d37dc37e..2cf1d119 100644 --- a/src/api-models/orders-api-model/base.ts +++ b/src/api-models/orders-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Orders - * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response. **Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces. + * Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response). * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/orders-api-model/common.ts b/src/api-models/orders-api-model/common.ts index dbaa1fe2..391e11e3 100644 --- a/src/api-models/orders-api-model/common.ts +++ b/src/api-models/orders-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Orders - * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response. **Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces. + * Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response). * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/orders-api-model/configuration.ts b/src/api-models/orders-api-model/configuration.ts index e4f7eed3..85cf9f47 100644 --- a/src/api-models/orders-api-model/configuration.ts +++ b/src/api-models/orders-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Orders - * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response. **Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces. + * Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response). * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/orders-api-model/index.ts b/src/api-models/orders-api-model/index.ts index 5a642a96..dbce2679 100644 --- a/src/api-models/orders-api-model/index.ts +++ b/src/api-models/orders-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Orders - * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response. **Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces. + * Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response). * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/product-pricing-api-model-v20220501/api.ts b/src/api-models/product-pricing-api-model-v20220501/api.ts index 8c7de78b..04800899 100644 --- a/src/api-models/product-pricing-api-model-v20220501/api.ts +++ b/src/api-models/product-pricing-api-model-v20220501/api.ts @@ -434,7 +434,7 @@ export interface FeaturedOfferExpectedPriceResponseBody { * @type {OfferIdentifier} * @memberof FeaturedOfferExpectedPriceResponseBody */ - offerIdentifier: OfferIdentifier; + offerIdentifier?: OfferIdentifier; /** * A list of featured offer expected price results for the requested offer. * @type {Array} diff --git a/src/api-models/sellers-api-model/api.ts b/src/api-models/sellers-api-model/api.ts index 24368dd7..c14a1b06 100644 --- a/src/api-models/sellers-api-model/api.ts +++ b/src/api-models/sellers-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Sellers - * The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace. + * The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as: - The marketplaces a seller can list in - The default language and currency of a marketplace - Whether the seller has suspended listings Refer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API\'s operations, data types, and schemas. * * The version of the OpenAPI document: v1 * @@ -22,7 +22,153 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** - * The response schema for the getMarketplaceParticipations operation. + * The response schema for the `getAccount` operation. + * @export + * @interface Account + */ +export interface Account { + /** + * A list of details of the marketplaces where the seller account is active. + * @type {Array} + * @memberof Account + */ + marketplaceLevelAttributes: Array; + /** + * The type of business registered for the seller account. + * @type {string} + * @memberof Account + */ + businessType: AccountBusinessTypeEnum | 'CHARITY' | 'CRAFTSMAN' | 'NATURAL_PERSON_COMPANY' | 'PUBLIC_LISTED' | 'PRIVATE_LIMITED' | 'SOLE_PROPRIETORSHIP' | 'STATE_OWNED' | 'INDIVIDUAL'; + /** + * + * @type {Business} + * @memberof Account + */ + business?: Business; + /** + * + * @type {PrimaryContact} + * @memberof Account + */ + primaryContact?: PrimaryContact; +} + +/** + * @export + * @enum {string} + */ +export enum AccountBusinessTypeEnum { + Charity = 'CHARITY', + Craftsman = 'CRAFTSMAN', + NaturalPersonCompany = 'NATURAL_PERSON_COMPANY', + PublicListed = 'PUBLIC_LISTED', + PrivateLimited = 'PRIVATE_LIMITED', + SoleProprietorship = 'SOLE_PROPRIETORSHIP', + StateOwned = 'STATE_OWNED', + Individual = 'INDIVIDUAL' +} + +/** + * Represents an address + * @export + * @interface Address + */ +export interface Address { + /** + * Street address information. + * @type {string} + * @memberof Address + */ + addressLine1: string; + /** + * Additional street address information. + * @type {string} + * @memberof Address + */ + addressLine2?: string; + /** + * The country code in two-character ISO 3166-1 alpha-2 format. + * @type {string} + * @memberof Address + */ + countryCode: string; + /** + * The state or province code. + * @type {string} + * @memberof Address + */ + stateOrProvinceCode?: string; + /** + * The city. + * @type {string} + * @memberof Address + */ + city?: string; + /** + * The postal code. + * @type {string} + * @memberof Address + */ + postalCode?: string; +} +/** + * Information about the seller\'s business. Certain fields may be omitted depending on the seller\'s `businessType`. + * @export + * @interface Business + */ +export interface Business { + /** + * The registered business name. + * @type {string} + * @memberof Business + */ + name: string; + /** + * + * @type {Address} + * @memberof Business + */ + registeredBusinessAddress: Address; + /** + * The seller\'s company registration number, if applicable. This field will be absent for individual sellers and sole proprietorships. + * @type {string} + * @memberof Business + */ + companyRegistrationNumber?: string; + /** + * The seller\'s company tax identification number, if applicable. This field will be present for certain business types only, such as sole proprietorships. + * @type {string} + * @memberof Business + */ + companyTaxIdentificationNumber?: string; + /** + * The non-Latin script version of the registered business name, if applicable. + * @type {string} + * @memberof Business + */ + nonLatinName?: string; +} +/** + * The response schema for the `getAccount` operation. + * @export + * @interface GetAccountResponse + */ +export interface GetAccountResponse { + /** + * + * @type {Account} + * @memberof GetAccountResponse + */ + payload?: Account; + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof GetAccountResponse + */ + errors?: Array; +} +/** + * The response schema for the `getMarketplaceParticipations` operation. * @export * @interface GetMarketplaceParticipationsResponse */ @@ -41,7 +187,7 @@ export interface GetMarketplaceParticipationsResponse { errors?: Array; } /** - * Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items. + * Information about an Amazon marketplace where a seller can list items and customers can view and purchase items. * @export * @interface Marketplace */ @@ -53,7 +199,7 @@ export interface Marketplace { */ id: string; /** - * Marketplace name. + * The marketplace name. * @type {string} * @memberof Marketplace */ @@ -83,6 +229,55 @@ export interface Marketplace { */ domainName: string; } +/** + * Attributes that define the seller\'s presence and status within a specific marketplace. These attributes include the marketplace details, store name, listing status, and the selling plan the seller is subscribed to. + * @export + * @interface MarketplaceLevelAttributes + */ +export interface MarketplaceLevelAttributes { + /** + * + * @type {Marketplace} + * @memberof MarketplaceLevelAttributes + */ + marketplace: Marketplace; + /** + * The name of the seller\'s store as displayed in the marketplace. + * @type {string} + * @memberof MarketplaceLevelAttributes + */ + storeName: string; + /** + * The current status of the seller\'s listings. + * @type {string} + * @memberof MarketplaceLevelAttributes + */ + listingStatus: MarketplaceLevelAttributesListingStatusEnum | 'ACTIVE' | 'INACTIVE'; + /** + * The selling plan details. + * @type {string} + * @memberof MarketplaceLevelAttributes + */ + sellingPlan: MarketplaceLevelAttributesSellingPlanEnum | 'PROFESSIONAL' | 'INDIVIDUAL'; +} + +/** + * @export + * @enum {string} + */ +export enum MarketplaceLevelAttributesListingStatusEnum { + Active = 'ACTIVE', + Inactive = 'INACTIVE' +} +/** + * @export + * @enum {string} + */ +export enum MarketplaceLevelAttributesSellingPlanEnum { + Professional = 'PROFESSIONAL', + Individual = 'INDIVIDUAL' +} + /** * * @export @@ -109,7 +304,7 @@ export interface MarketplaceParticipation { */ export interface ModelError { /** - * An error code that identifies the type of error that occured. + * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ @@ -121,31 +316,56 @@ export interface ModelError { */ message: string; /** - * Additional details that can help the caller understand or fix the issue. + * Additional details that can help you understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** - * Detailed information that is specific to a seller in a Marketplace. + * Information that is specific to a seller in a marketplace. * @export * @interface Participation */ export interface Participation { /** - * + * If `true`, the seller participates in the marketplace. Otherwise `false`. * @type {boolean} * @memberof Participation */ isParticipating: boolean; /** - * Specifies if the seller has suspended listings. True if the seller Listing Status is set to Inactive, otherwise False. + * Specifies if the seller has suspended listings. `true` if the seller Listing Status is set to Inactive, otherwise `false`. * @type {boolean} * @memberof Participation */ hasSuspendedListings: boolean; } +/** + * Information about the seller\'s primary contact. + * @export + * @interface PrimaryContact + */ +export interface PrimaryContact { + /** + * The full name of the seller\'s primary contact. + * @type {string} + * @memberof PrimaryContact + */ + name: string; + /** + * + * @type {Address} + * @memberof PrimaryContact + */ + address: Address; + /** + * The non-Latin script version of the primary contact\'s name, if applicable. + * @type {string} + * @memberof PrimaryContact + */ + nonLatinName?: string; +} /** * SellersApi - axios parameter creator @@ -154,7 +374,36 @@ export interface Participation { export const SellersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | 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). + * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAccount: async (options: any = {}): Promise => { + const localVarPath = `/sellers/v1/account`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -193,7 +442,16 @@ export const SellersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = SellersApiAxiosParamCreator(configuration) return { /** - * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | 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). + * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAccount(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -212,7 +470,15 @@ export const SellersApiFactory = function (configuration?: Configuration, basePa const localVarFp = SellersApiFp(configuration) return { /** - * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | 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). + * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAccount(options?: any): AxiosPromise { + return localVarFp.getAccount(options).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -230,7 +496,17 @@ export const SellersApiFactory = function (configuration?: Configuration, basePa */ export class SellersApi extends BaseAPI { /** - * Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | 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). + * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SellersApi + */ + public getAccount(options?: any) { + return SellersApiFp(this.configuration).getAccount(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SellersApi diff --git a/src/api-models/sellers-api-model/base.ts b/src/api-models/sellers-api-model/base.ts index 416794fa..ef0ed2be 100644 --- a/src/api-models/sellers-api-model/base.ts +++ b/src/api-models/sellers-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Sellers - * The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace. + * The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as: - The marketplaces a seller can list in - The default language and currency of a marketplace - Whether the seller has suspended listings Refer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API\'s operations, data types, and schemas. * * The version of the OpenAPI document: v1 * diff --git a/src/api-models/sellers-api-model/common.ts b/src/api-models/sellers-api-model/common.ts index da19c704..595ac66f 100644 --- a/src/api-models/sellers-api-model/common.ts +++ b/src/api-models/sellers-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Sellers - * The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace. + * The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as: - The marketplaces a seller can list in - The default language and currency of a marketplace - Whether the seller has suspended listings Refer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API\'s operations, data types, and schemas. * * The version of the OpenAPI document: v1 * diff --git a/src/api-models/sellers-api-model/configuration.ts b/src/api-models/sellers-api-model/configuration.ts index 8a96b2f4..7700ac2a 100644 --- a/src/api-models/sellers-api-model/configuration.ts +++ b/src/api-models/sellers-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Sellers - * The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace. + * The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as: - The marketplaces a seller can list in - The default language and currency of a marketplace - Whether the seller has suspended listings Refer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API\'s operations, data types, and schemas. * * The version of the OpenAPI document: v1 * diff --git a/src/api-models/sellers-api-model/index.ts b/src/api-models/sellers-api-model/index.ts index 6cd380af..20394ef2 100644 --- a/src/api-models/sellers-api-model/index.ts +++ b/src/api-models/sellers-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Sellers - * The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace. + * The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as: - The marketplaces a seller can list in - The default language and currency of a marketplace - Whether the seller has suspended listings Refer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API\'s operations, data types, and schemas. * * The version of the OpenAPI document: v1 * diff --git a/src/api-models/vendor-orders-api-model/api.ts b/src/api-models/vendor-orders-api-model/api.ts index 25070985..68386f62 100644 --- a/src/api-models/vendor-orders-api-model/api.ts +++ b/src/api-models/vendor-orders-api-model/api.ts @@ -22,13 +22,13 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** - * Details of the item quantity ordered + * Details of item quantity ordered * @export * @interface AcknowledgementStatusDetails */ export interface AcknowledgementStatusDetails { /** - * The date when the line item was confirmed by the vendor. Must be in ISO 8601 date/time format. + * The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format. * @type {string} * @memberof AcknowledgementStatusDetails */ @@ -101,7 +101,7 @@ export interface Address { */ stateOrRegion?: string; /** - * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. + * The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation. * @type {string} * @memberof Address */ @@ -120,7 +120,7 @@ export interface Address { phone?: string; } /** - * The response schema for the `getPurchaseOrder` operation. + * The response schema for the getPurchaseOrder operation. * @export * @interface GetPurchaseOrderResponse */ @@ -139,7 +139,7 @@ export interface GetPurchaseOrderResponse { errors?: Array; } /** - * The response schema for the `getPurchaseOrders` operation. + * The response schema for the getPurchaseOrders operation. * @export * @interface GetPurchaseOrdersResponse */ @@ -158,7 +158,7 @@ export interface GetPurchaseOrdersResponse { errors?: Array; } /** - * The response schema for the `getPurchaseOrdersStatus` operation. + * The response schema for the getPurchaseOrdersStatus operation. * @export * @interface GetPurchaseOrdersStatusResponse */ @@ -195,13 +195,13 @@ export interface ImportDetails { */ internationalCommercialTerms?: ImportDetailsInternationalCommercialTermsEnum | 'ExWorks' | 'FreeCarrier' | 'FreeOnBoard' | 'FreeAlongSideShip' | 'CarriagePaidTo' | 'CostAndFreight' | 'CarriageAndInsurancePaidTo' | 'CostInsuranceAndFreight' | 'DeliveredAtTerminal' | 'DeliveredAtPlace' | 'DeliverDutyPaid'; /** - * The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the `internationalCommercialTerms` is `FOB`. + * The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB. * @type {string} * @memberof ImportDetails */ portOfDelivery?: string; /** - * Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: `$NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE`. The list of values for the container type is: `40\'`(40-foot container), `40\'HC` (40-foot high-capacity container), `45\'`, `45\'HC`, `30\'`, `30\'HC`, `20\'`, `20\'HC`. + * Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40\'(40-foot container), 40\'HC (40-foot high-capacity container), 45\', 45\'HC, 30\', 30\'HC, 20\', 20\'HC. * @type {string} * @memberof ImportDetails */ @@ -305,7 +305,7 @@ export interface ModelError { details?: string; } /** - * An amount of money, including units in the form of currency. + * An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. * @export * @interface Money */ @@ -322,9 +322,27 @@ export interface Money { * @memberof Money */ amount?: string; + /** + * The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches. + * @type {string} + * @memberof Money + */ + unitOfMeasure?: MoneyUnitOfMeasureEnum | 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS'; } + /** - * Represents an order placed by Amazon, including the purchase order number, current state, and order details. + * @export + * @enum {string} + */ +export enum MoneyUnitOfMeasureEnum { + Pounds = 'POUNDS', + Ounces = 'OUNCES', + Grams = 'GRAMS', + Kilograms = 'KILOGRAMS' +} + +/** + * * @export * @interface Order */ @@ -360,7 +378,7 @@ export enum OrderPurchaseOrderStateEnum { } /** - * Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items. + * * @export * @interface OrderAcknowledgement */ @@ -378,7 +396,7 @@ export interface OrderAcknowledgement { */ sellingParty: PartyIdentification; /** - * The date and time when the purchase order is acknowledged, in ISO 8601 date/time format. + * The date and time when the purchase order is acknowledged, in ISO-8601 date/time format. * @type {string} * @memberof OrderAcknowledgement */ @@ -452,19 +470,19 @@ export interface OrderAcknowledgementItem { */ export interface OrderDetails { /** - * The date the purchase order was placed. Must be in ISO 8601 date/time format. + * The date the purchase order was placed. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderDetails */ purchaseOrderDate: string; /** - * The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than \'purchaseOrderDate\'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO 8601 date/time format. + * The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than \'purchaseOrderDate\'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderDetails */ purchaseOrderChangedDate?: string; /** - * The date when current purchase order state was changed. Current purchase order state is available in the field \'purchaseOrderState\'. Must be in ISO 8601 date/time format. + * The date when current purchase order state was changed. Current purchase order state is available in the field \'purchaseOrderState\'. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderDetails */ @@ -518,13 +536,13 @@ export interface OrderDetails { */ billToParty?: PartyIdentification; /** - * Defines a date time interval according to ISO 8601. Interval is separated by double hyphen (--). + * Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--). * @type {string} * @memberof OrderDetails */ shipWindow?: string; /** - * Defines a date time interval according to ISO 8601. Interval is separated by double hyphen (--). + * Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--). * @type {string} * @memberof OrderDetails */ @@ -559,7 +577,7 @@ export enum OrderDetailsPaymentMethodEnum { } /** - * Represents an individual item in an order, including item details, quantities, pricing, and backorder information. + * * @export * @interface OrderItem */ @@ -608,7 +626,7 @@ export interface OrderItem { listPrice?: Money; } /** - * Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable). + * * @export * @interface OrderItemAcknowledgement */ @@ -626,13 +644,13 @@ export interface OrderItemAcknowledgement { */ acknowledgedQuantity: ItemQuantity; /** - * Estimated ship date per line item. Must be in ISO 8601 date/time format. + * Estimated ship date per line item. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderItemAcknowledgement */ scheduledShipDate?: string; /** - * Estimated delivery date per line item. Must be in ISO 8601 date/time format. + * Estimated delivery date per line item. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderItemAcknowledgement */ @@ -665,7 +683,7 @@ export enum OrderItemAcknowledgementRejectionReasonEnum { } /** - * Represents the current status of an order item, including acknowledgement and receiving details. + * * @export * @interface OrderItemStatus */ @@ -800,7 +818,7 @@ export interface OrderItemStatusReceivingStatus { */ receivedQuantity?: ItemQuantity; /** - * The date when the most recent item was received at the buyer\'s warehouse. Must be in ISO 8601 date/time format. + * The date when the most recent item was received at the buyer\'s warehouse. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderItemStatusReceivingStatus */ @@ -818,7 +836,7 @@ export enum OrderItemStatusReceivingStatusReceiveStatusEnum { } /** - * A list of orders returned as response. + * * @export * @interface OrderList */ @@ -830,14 +848,14 @@ export interface OrderList { */ pagination?: Pagination; /** - * Represents an individual order within the `OrderList`. + * * @type {Array} * @memberof OrderList */ orders?: Array; } /** - * A list of order statuses. + * * @export * @interface OrderListStatus */ @@ -849,7 +867,7 @@ export interface OrderListStatus { */ pagination?: Pagination; /** - * Represents an order status within the `OrderListStatus`. + * * @type {Array} * @memberof OrderListStatus */ @@ -874,13 +892,13 @@ export interface OrderStatus { */ purchaseOrderStatus: OrderStatusPurchaseOrderStatusEnum | 'OPEN' | 'CLOSED'; /** - * The date the purchase order was placed. Must be in ISO 8601 date/time format. + * The date the purchase order was placed. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderStatus */ purchaseOrderDate: string; /** - * The date when the purchase order was last updated. Must be in ISO 8601 date/time format. + * The date when the purchase order was last updated. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderStatus */ @@ -915,13 +933,13 @@ export enum OrderStatusPurchaseOrderStatusEnum { } /** - * Details of the item quantity ordered. + * Details of item quantity ordered * @export * @interface OrderedQuantityDetails */ export interface OrderedQuantityDetails { /** - * The date when the line item quantity was updated by the buyer. Must be in ISO 8601 date/time format. + * The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderedQuantityDetails */ @@ -940,20 +958,20 @@ export interface OrderedQuantityDetails { cancelledQuantity?: ItemQuantity; } /** - * The pagination elements required to retrieve the remaining data. + * * @export * @interface Pagination */ export interface Pagination { /** - * A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more purchase order items to return. + * A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more purchase order items to return. * @type {string} * @memberof Pagination */ nextToken?: string; } /** - * Name, address and tax details of a party. + * * @export * @interface PartyIdentification */ @@ -978,20 +996,20 @@ export interface PartyIdentification { taxInfo?: TaxRegistrationDetails; } /** - * The request schema for the `submitAcknowledgment` operation. + * The request schema for the submitAcknowledgment operation. * @export * @interface SubmitAcknowledgementRequest */ export interface SubmitAcknowledgementRequest { /** - * An array of order acknowledgements to be submitted. + * * @type {Array} * @memberof SubmitAcknowledgementRequest */ acknowledgements?: Array; } /** - * The response schema for the `submitAcknowledgement` operation + * The response schema for the submitAcknowledgement operation * @export * @interface SubmitAcknowledgementResponse */ @@ -1022,7 +1040,7 @@ export interface TaxRegistrationDetails { */ taxRegistrationType: TaxRegistrationDetailsTaxRegistrationTypeEnum | 'VAT' | 'GST'; /** - * Tax registration number for the entity. For example, `VAT ID`. + * Tax registration number for the entity. For example, VAT ID. * @type {string} * @memberof TaxRegistrationDetails */ @@ -1039,7 +1057,7 @@ export enum TaxRegistrationDetailsTaxRegistrationTypeEnum { } /** - * Response containing the transaction ID. + * * @export * @interface TransactionId */ @@ -1059,7 +1077,7 @@ export interface TransactionId { export const VendorOrdersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1092,17 +1110,17 @@ export const VendorOrdersApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. - * @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call - * @param {boolean} [includeDetails] When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`. - * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. - * @param {boolean} [isPOChanged] When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`. + * @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. + * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. + * @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @param {*} [options] Override http request option. @@ -1189,14 +1207,14 @@ export const VendorOrdersApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit. - * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number. * @param {'OPEN' | 'CLOSED'} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. @@ -1291,8 +1309,8 @@ export const VendorOrdersApiAxiosParamCreator = function (configuration?: Config }; }, /** - * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. + * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {SubmitAcknowledgementRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1336,7 +1354,7 @@ export const VendorOrdersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VendorOrdersApiAxiosParamCreator(configuration) return { /** - * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1346,17 +1364,17 @@ export const VendorOrdersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. - * @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call - * @param {boolean} [includeDetails] When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`. - * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. - * @param {boolean} [isPOChanged] When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`. + * @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. + * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. + * @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @param {*} [options] Override http request option. @@ -1367,14 +1385,14 @@ export const VendorOrdersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit. - * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number. * @param {'OPEN' | 'CLOSED'} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. @@ -1389,8 +1407,8 @@ export const VendorOrdersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. + * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {SubmitAcknowledgementRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1409,7 +1427,7 @@ export const VendorOrdersApiFactory = function (configuration?: Configuration, b const localVarFp = VendorOrdersApiFp(configuration) return { /** - * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1418,17 +1436,17 @@ export const VendorOrdersApiFactory = function (configuration?: Configuration, b return localVarFp.getPurchaseOrder(purchaseOrderNumber, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. - * @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call - * @param {boolean} [includeDetails] When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`. - * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. - * @param {boolean} [isPOChanged] When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`. + * @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. + * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. + * @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @param {*} [options] Override http request option. @@ -1438,14 +1456,14 @@ export const VendorOrdersApiFactory = function (configuration?: Configuration, b return localVarFp.getPurchaseOrders(limit, createdAfter, createdBefore, sortOrder, nextToken, includeDetails, changedAfter, changedBefore, poItemState, isPOChanged, purchaseOrderState, orderingVendorCode, options).then((request) => request(axios, basePath)); }, /** - * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit. - * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. - * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number. * @param {'OPEN' | 'CLOSED'} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. @@ -1459,8 +1477,8 @@ export const VendorOrdersApiFactory = function (configuration?: Configuration, b return localVarFp.getPurchaseOrdersStatus(limit, sortOrder, nextToken, createdAfter, createdBefore, updatedAfter, updatedBefore, purchaseOrderNumber, purchaseOrderStatus, itemConfirmationStatus, itemReceiveStatus, orderingVendorCode, shipToPartyId, options).then((request) => request(axios, basePath)); }, /** - * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. + * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {SubmitAcknowledgementRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1498,14 +1516,14 @@ export interface VendorOrdersApiGetPurchaseOrdersRequest { readonly limit?: number /** - * Purchase orders that became available after this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly createdAfter?: string /** - * Purchase orders that became available before this time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ @@ -1526,35 +1544,35 @@ export interface VendorOrdersApiGetPurchaseOrdersRequest { readonly nextToken?: string /** - * When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`. + * When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. * @type {boolean} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly includeDetails?: boolean /** - * Purchase orders that changed after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly changedAfter?: string /** - * Purchase orders that changed before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly changedBefore?: string /** - * Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. + * Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. * @type {'Cancelled'} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly poItemState?: 'Cancelled' /** - * When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`. + * When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @type {boolean} * @memberof VendorOrdersApiGetPurchaseOrders */ @@ -1603,28 +1621,28 @@ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest { readonly nextToken?: string /** - * Purchase orders that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly createdAfter?: string /** - * Purchase orders that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly createdBefore?: string /** - * Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly updatedAfter?: string /** - * Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format. + * Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ @@ -1680,7 +1698,7 @@ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest { */ export interface VendorOrdersApiSubmitAcknowledgementRequest { /** - * Submits acknowledgements for one or more purchase orders from a vendor. + * * @type {SubmitAcknowledgementRequest} * @memberof VendorOrdersApiSubmitAcknowledgement */ @@ -1695,7 +1713,7 @@ export interface VendorOrdersApiSubmitAcknowledgementRequest { */ export class VendorOrdersApi extends BaseAPI { /** - * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiGetPurchaseOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1706,7 +1724,7 @@ export class VendorOrdersApi extends BaseAPI { } /** - * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiGetPurchaseOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1717,7 +1735,7 @@ export class VendorOrdersApi extends BaseAPI { } /** - * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiGetPurchaseOrdersStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1728,7 +1746,7 @@ export class VendorOrdersApi extends BaseAPI { } /** - * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError}