From 7f77771afb7d1a40a585407a073c91f11f8dc018 Mon Sep 17 00:00:00 2001 From: nguyentoanit <19872073+nguyentoanit@users.noreply.github.com> Date: Sun, 8 Dec 2024 01:33:12 +0000 Subject: [PATCH] chore: update api models --- .../catalog-items-api-client-v20220401.ts | 4 +- ...ulfillment-inbound-api-client-v20240320.ts | 7 +- .../listings-items-api-client-v20210801.ts | 4 +- src/api-clients/orders-api-client.ts | 9 +- src/api-clients/vendor-invoices-api-client.ts | 4 +- .../vendor-shipments-api-client.ts | 4 +- .../catalog-items-api-model-v20220401/api.ts | 92 +- .../catalog-items-api-model-v20220401/base.ts | 2 +- .../common.ts | 2 +- .../configuration.ts | 2 +- .../index.ts | 2 +- src/api-models/easy-ship-model/api.ts | 8 +- .../feeds-api-model-v20210630/api.ts | 26 +- .../feeds-api-model-v20210630/base.ts | 2 +- .../feeds-api-model-v20210630/common.ts | 2 +- .../configuration.ts | 2 +- .../feeds-api-model-v20210630/index.ts | 2 +- src/api-models/finances-api-model/api.ts | 320 ++--- src/api-models/finances-api-model/base.ts | 2 +- src/api-models/finances-api-model/common.ts | 2 +- .../finances-api-model/configuration.ts | 2 +- src/api-models/finances-api-model/index.ts | 2 +- .../api.ts | 1076 ++++++++++------- .../base.ts | 2 +- .../common.ts | 2 +- .../configuration.ts | 2 +- .../index.ts | 2 +- .../fulfillment-outbound-api-model/api.ts | 4 +- src/api-models/index.ts | 154 ++- .../listings-items-api-model-v20210801/api.ts | 319 ++--- .../base.ts | 2 +- .../common.ts | 2 +- .../configuration.ts | 2 +- .../index.ts | 2 +- .../merchant-fulfillment-api-model/api.ts | 124 +- .../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 | 470 +++---- 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 | 122 +- .../reports-api-model-v20210630/api.ts | 38 +- .../reports-api-model-v20210630/base.ts | 2 +- .../reports-api-model-v20210630/common.ts | 2 +- .../configuration.ts | 2 +- .../reports-api-model-v20210630/index.ts | 2 +- .../api.ts | 34 +- .../api.ts | 34 +- .../api.ts | 30 +- .../api.ts | 42 +- .../api.ts | 179 ++- .../api.ts | 212 ++-- .../api.ts | 10 +- .../api.ts | 12 +- .../vendor-invoices-api-model/api.ts | 145 ++- .../vendor-invoices-api-model/base.ts | 2 +- .../vendor-invoices-api-model/common.ts | 2 +- .../configuration.ts | 2 +- .../vendor-invoices-api-model/index.ts | 2 +- src/api-models/vendor-orders-api-model/api.ts | 36 +- .../vendor-shipments-api-model/api.ts | 592 ++++++++- .../vendor-shipments-api-model/base.ts | 2 +- .../vendor-shipments-api-model/common.ts | 2 +- .../configuration.ts | 2 +- .../vendor-shipments-api-model/index.ts | 2 +- .../api.ts | 10 +- 70 files changed, 2479 insertions(+), 1722 deletions(-) diff --git a/src/api-clients/catalog-items-api-client-v20220401.ts b/src/api-clients/catalog-items-api-client-v20220401.ts index 6fb248f2..f80af0d5 100644 --- a/src/api-clients/catalog-items-api-client-v20220401.ts +++ b/src/api-clients/catalog-items-api-client-v20220401.ts @@ -1,9 +1,9 @@ -import { CatalogApi, Configuration } from '../api-models/catalog-items-api-model-v20220401' +import { CatalogItemsApi, Configuration } from '../api-models/catalog-items-api-model-v20220401' import { ApiClientHelpers } from '../helpers' import { DEFAULT_API_BASE_PATH } from '../types' import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' -export class CatalogItemsApiClientV20220401 extends CatalogApi { +export class CatalogItemsApiClientV20220401 extends CatalogItemsApi { constructor(parameters: APIConfigurationParameters) { const axios = ApiClientHelpers.getAxiosInstance(parameters) diff --git a/src/api-clients/fulfillment-inbound-api-client-v20240320.ts b/src/api-clients/fulfillment-inbound-api-client-v20240320.ts index ccb5cf55..98188752 100644 --- a/src/api-clients/fulfillment-inbound-api-client-v20240320.ts +++ b/src/api-clients/fulfillment-inbound-api-client-v20240320.ts @@ -1,9 +1,12 @@ -import { Configuration, FbaInboundApi } from '../api-models/fulfillment-inbound-api-model-v20240320' +import { + Configuration, + FulfillmentInboundApi, +} from '../api-models/fulfillment-inbound-api-model-v20240320' import { ApiClientHelpers } from '../helpers' import { DEFAULT_API_BASE_PATH } from '../types' import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' -export class FulfillmentInboundApiClientV20240320 extends FbaInboundApi { +export class FulfillmentInboundApiClientV20240320 extends FulfillmentInboundApi { constructor(parameters: APIConfigurationParameters) { const axios = ApiClientHelpers.getAxiosInstance(parameters) diff --git a/src/api-clients/listings-items-api-client-v20210801.ts b/src/api-clients/listings-items-api-client-v20210801.ts index 8a82e36d..da539116 100644 --- a/src/api-clients/listings-items-api-client-v20210801.ts +++ b/src/api-clients/listings-items-api-client-v20210801.ts @@ -1,9 +1,9 @@ -import { Configuration, ListingsApi } from '../api-models/listings-items-api-model-v20210801' +import { Configuration, ListingsItemsApi } from '../api-models/listings-items-api-model-v20210801' import { ApiClientHelpers } from '../helpers' import { DEFAULT_API_BASE_PATH } from '../types' import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' -export class ListingsItemsApiClientV20210801 extends ListingsApi { +export class ListingsItemsApiClientV20210801 extends ListingsItemsApi { constructor(parameters: APIConfigurationParameters) { const axios = ApiClientHelpers.getAxiosInstance(parameters) diff --git a/src/api-clients/orders-api-client.ts b/src/api-clients/orders-api-client.ts index 7dd29623..61fe2302 100644 --- a/src/api-clients/orders-api-client.ts +++ b/src/api-clients/orders-api-client.ts @@ -1,9 +1,9 @@ -import { Configuration, OrdersV0Api, ShipmentApi } from '../api-models/orders-api-model' -import { ApiClientHelpers, applyMixins } from '../helpers' +import { Configuration, OrdersApi } from '../api-models/orders-api-model' +import { ApiClientHelpers } from '../helpers' import { DEFAULT_API_BASE_PATH } from '../types' import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' -export class OrdersApiClient extends OrdersV0Api { +export class OrdersApiClient extends OrdersApi { constructor(parameters: APIConfigurationParameters) { const axios = ApiClientHelpers.getAxiosInstance(parameters) @@ -12,6 +12,3 @@ export class OrdersApiClient extends OrdersV0Api { super(configuration, DEFAULT_API_BASE_PATH, axios) } } - -export interface OrdersApiClient extends OrdersV0Api, ShipmentApi {} -applyMixins(OrdersApiClient, [OrdersV0Api, ShipmentApi]) diff --git a/src/api-clients/vendor-invoices-api-client.ts b/src/api-clients/vendor-invoices-api-client.ts index 1cf3089a..efa0fd6c 100644 --- a/src/api-clients/vendor-invoices-api-client.ts +++ b/src/api-clients/vendor-invoices-api-client.ts @@ -1,9 +1,9 @@ -import { Configuration, VendorPaymentsApi } from '../api-models/vendor-invoices-api-model' +import { Configuration, VendorInvoicesApi } from '../api-models/vendor-invoices-api-model' import { ApiClientHelpers } from '../helpers' import { DEFAULT_API_BASE_PATH } from '../types' import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' -export class VendorInvoicesApiClient extends VendorPaymentsApi { +export class VendorInvoicesApiClient extends VendorInvoicesApi { constructor(parameters: APIConfigurationParameters) { const axios = ApiClientHelpers.getAxiosInstance(parameters) diff --git a/src/api-clients/vendor-shipments-api-client.ts b/src/api-clients/vendor-shipments-api-client.ts index 0e8cc07d..149d1fd5 100644 --- a/src/api-clients/vendor-shipments-api-client.ts +++ b/src/api-clients/vendor-shipments-api-client.ts @@ -1,9 +1,9 @@ -import { Configuration, VendorShippingApi } from '../api-models/vendor-shipments-api-model' +import { Configuration, VendorShipmentsApi } from '../api-models/vendor-shipments-api-model' import { ApiClientHelpers } from '../helpers' import { DEFAULT_API_BASE_PATH } from '../types' import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' -export class VendorShipmentsApiClient extends VendorShippingApi { +export class VendorShipmentsApiClient extends VendorShipmentsApi { constructor(parameters: APIConfigurationParameters) { const axios = ApiClientHelpers.getAxiosInstance(parameters) 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 3f36b4ec..4ec27dba 100644 --- a/src/api-models/catalog-items-api-model-v20220401/api.ts +++ b/src/api-models/catalog-items-api-model-v20220401/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Catalog Items + * Catalog Items v2022-04-01 * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * The version of the OpenAPI document: 2022-04-01 @@ -926,13 +926,14 @@ export interface Refinements { } /** - * CatalogApi - axios parameter creator + * CatalogItemsApi - axios parameter creator * @export */ -export const CatalogApiAxiosParamCreator = function (configuration?: Configuration) { +export const CatalogItemsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * 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). + * @summary getCatalogItem * @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`. @@ -983,6 +984,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 | | ---- | ---- | | 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). + * @summary searchCatalogItems * @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. @@ -1076,14 +1078,15 @@ export const CatalogApiAxiosParamCreator = function (configuration?: Configurati }; /** - * CatalogApi - functional programming interface + * CatalogItemsApi - functional programming interface * @export */ -export const CatalogApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CatalogApiAxiosParamCreator(configuration) +export const CatalogItemsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CatalogItemsApiAxiosParamCreator(configuration) return { /** * 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). + * @summary getCatalogItem * @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`. @@ -1097,6 +1100,7 @@ export const CatalogApiFp = function(configuration?: 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 | | ---- | ---- | | 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). + * @summary searchCatalogItems * @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. @@ -1120,14 +1124,15 @@ export const CatalogApiFp = function(configuration?: Configuration) { }; /** - * CatalogApi - factory interface + * CatalogItemsApi - factory interface * @export */ -export const CatalogApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CatalogApiFp(configuration) +export const CatalogItemsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CatalogItemsApiFp(configuration) return { /** * 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). + * @summary getCatalogItem * @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`. @@ -1140,6 +1145,7 @@ export const CatalogApiFactory = function (configuration?: Configuration, basePa }, /** * 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). + * @summary searchCatalogItems * @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. @@ -1162,158 +1168,160 @@ export const CatalogApiFactory = function (configuration?: Configuration, basePa }; /** - * Request parameters for getCatalogItem operation in CatalogApi. + * Request parameters for getCatalogItem operation in CatalogItemsApi. * @export - * @interface CatalogApiGetCatalogItemRequest + * @interface CatalogItemsApiGetCatalogItemRequest */ -export interface CatalogApiGetCatalogItemRequest { +export interface CatalogItemsApiGetCatalogItemRequest { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} - * @memberof CatalogApiGetCatalogItem + * @memberof CatalogItemsApiGetCatalogItem */ readonly asin: string /** * A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @type {Array} - * @memberof CatalogApiGetCatalogItem + * @memberof CatalogItemsApiGetCatalogItem */ readonly marketplaceIds: Array /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} - * @memberof CatalogApiGetCatalogItem + * @memberof CatalogItemsApiGetCatalogItem */ readonly includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'> /** * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @type {string} - * @memberof CatalogApiGetCatalogItem + * @memberof CatalogItemsApiGetCatalogItem */ readonly locale?: string } /** - * Request parameters for searchCatalogItems operation in CatalogApi. + * Request parameters for searchCatalogItems operation in CatalogItemsApi. * @export - * @interface CatalogApiSearchCatalogItemsRequest + * @interface CatalogItemsApiSearchCatalogItemsRequest */ -export interface CatalogApiSearchCatalogItemsRequest { +export interface CatalogItemsApiSearchCatalogItemsRequest { /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly marketplaceIds: Array /** * A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @type {Array} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly identifiers?: Array /** * Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. * @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC' /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'> /** * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @type {string} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly locale?: string /** * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @type {string} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly sellerId?: string /** * A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. * @type {Array} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly keywords?: Array /** * A comma-delimited list of brand names to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @type {Array} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly brandNames?: Array /** * A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @type {Array} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly classificationIds?: Array /** * Number of results to be returned per page. * @type {number} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. * @type {string} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly pageToken?: string /** * The language of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`. * @type {string} - * @memberof CatalogApiSearchCatalogItems + * @memberof CatalogItemsApiSearchCatalogItems */ readonly keywordsLocale?: string } /** - * CatalogApi - object-oriented interface + * CatalogItemsApi - object-oriented interface * @export - * @class CatalogApi + * @class CatalogItemsApi * @extends {BaseAPI} */ -export class CatalogApi extends BaseAPI { +export class CatalogItemsApi extends BaseAPI { /** * 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. + * @summary getCatalogItem + * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CatalogApi + * @memberof CatalogItemsApi */ - public getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: any) { - return CatalogApiFp(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.basePath)); + public getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: any) { + return CatalogItemsApiFp(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.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 | | ---- | ---- | | 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. + * @summary searchCatalogItems + * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CatalogApi + * @memberof CatalogItemsApi */ - public searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: any) { - return CatalogApiFp(this.configuration).searchCatalogItems(requestParameters.marketplaceIds, requestParameters.identifiers, requestParameters.identifiersType, requestParameters.includedData, requestParameters.locale, requestParameters.sellerId, requestParameters.keywords, requestParameters.brandNames, requestParameters.classificationIds, requestParameters.pageSize, requestParameters.pageToken, requestParameters.keywordsLocale, options).then((request) => request(this.axios, this.basePath)); + public searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: any) { + return CatalogItemsApiFp(this.configuration).searchCatalogItems(requestParameters.marketplaceIds, requestParameters.identifiers, requestParameters.identifiersType, requestParameters.includedData, requestParameters.locale, requestParameters.sellerId, requestParameters.keywords, requestParameters.brandNames, requestParameters.classificationIds, requestParameters.pageSize, requestParameters.pageToken, requestParameters.keywordsLocale, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/api-models/catalog-items-api-model-v20220401/base.ts b/src/api-models/catalog-items-api-model-v20220401/base.ts index 8ff925c9..94513620 100644 --- a/src/api-models/catalog-items-api-model-v20220401/base.ts +++ b/src/api-models/catalog-items-api-model-v20220401/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Catalog Items + * Catalog Items v2022-04-01 * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * The version of the OpenAPI document: 2022-04-01 diff --git a/src/api-models/catalog-items-api-model-v20220401/common.ts b/src/api-models/catalog-items-api-model-v20220401/common.ts index 96c991a6..14e7433d 100644 --- a/src/api-models/catalog-items-api-model-v20220401/common.ts +++ b/src/api-models/catalog-items-api-model-v20220401/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Catalog Items + * Catalog Items v2022-04-01 * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * The version of the OpenAPI document: 2022-04-01 diff --git a/src/api-models/catalog-items-api-model-v20220401/configuration.ts b/src/api-models/catalog-items-api-model-v20220401/configuration.ts index f1bf94e5..a632759a 100644 --- a/src/api-models/catalog-items-api-model-v20220401/configuration.ts +++ b/src/api-models/catalog-items-api-model-v20220401/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Catalog Items + * Catalog Items v2022-04-01 * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * The version of the OpenAPI document: 2022-04-01 diff --git a/src/api-models/catalog-items-api-model-v20220401/index.ts b/src/api-models/catalog-items-api-model-v20220401/index.ts index 32172510..655c6d2f 100644 --- a/src/api-models/catalog-items-api-model-v20220401/index.ts +++ b/src/api-models/catalog-items-api-model-v20220401/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Catalog Items + * Catalog Items v2022-04-01 * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * The version of the OpenAPI document: 2022-04-01 diff --git a/src/api-models/easy-ship-model/api.ts b/src/api-models/easy-ship-model/api.ts index 43d4a4d3..c00f344a 100644 --- a/src/api-models/easy-ship-model/api.ts +++ b/src/api-models/easy-ship-model/api.ts @@ -637,7 +637,7 @@ export const EasyShipApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -801,7 +801,7 @@ export const EasyShipApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -861,7 +861,7 @@ export const EasyShipApiFactory = function (configuration?: Configuration, baseP return localVarFp.createScheduledPackage(createScheduledPackageRequest, options).then((request) => request(axios, basePath)); }, /** - * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -996,7 +996,7 @@ export class EasyShipApi extends BaseAPI { } /** - * This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label\'s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn\'t be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn\'t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {EasyShipApiCreateScheduledPackageBulkRequest} 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 7c8040a5..2098f0b2 100644 --- a/src/api-models/feeds-api-model-v20210630/api.ts +++ b/src/api-models/feeds-api-model-v20210630/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Feeds + * Feeds v2021-06-30 * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 @@ -265,6 +265,7 @@ 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`](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). + * @summary cancelFeed * @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} @@ -298,6 +299,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 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). + * @summary createFeed * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -333,6 +335,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`](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). + * @summary createFeedDocument * @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -368,6 +371,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 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). + * @summary getFeed * @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} @@ -401,6 +405,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 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). + * @summary getFeedDocument * @param {string} feedDocumentId The identifier of the feed document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -434,6 +439,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 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). + * @summary getFeeds * @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. @@ -512,6 +518,7 @@ export const FeedsApiFp = 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`](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). + * @summary cancelFeed * @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} @@ -522,6 +529,7 @@ export const FeedsApiFp = 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 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). + * @summary createFeed * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -532,6 +540,7 @@ export const FeedsApiFp = 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`](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). + * @summary createFeedDocument * @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -542,6 +551,7 @@ export const FeedsApiFp = 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 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). + * @summary getFeed * @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} @@ -552,6 +562,7 @@ export const FeedsApiFp = 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 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). + * @summary getFeedDocument * @param {string} feedDocumentId The identifier of the feed document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -562,6 +573,7 @@ export const FeedsApiFp = 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 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). + * @summary getFeeds * @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. @@ -588,6 +600,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, basePath 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`](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). + * @summary cancelFeed * @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} @@ -597,6 +610,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, 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 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). + * @summary createFeed * @param {CreateFeedSpecification} body Information required to create the feed. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -606,6 +620,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, 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`](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). + * @summary createFeedDocument * @param {CreateFeedDocumentSpecification} body Specifies the content type for the createFeedDocument operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -615,6 +630,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, 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 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). + * @summary getFeed * @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} @@ -624,6 +640,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, 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 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). + * @summary getFeedDocument * @param {string} feedDocumentId The identifier of the feed document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -633,6 +650,7 @@ export const FeedsApiFactory = function (configuration?: Configuration, 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 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). + * @summary getFeeds * @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. @@ -784,6 +802,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`](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). + * @summary cancelFeed * @param {FeedsApiCancelFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -795,6 +814,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 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). + * @summary createFeed * @param {FeedsApiCreateFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -806,6 +826,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`](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). + * @summary createFeedDocument * @param {FeedsApiCreateFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -817,6 +838,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 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). + * @summary getFeed * @param {FeedsApiGetFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -828,6 +850,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 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). + * @summary getFeedDocument * @param {FeedsApiGetFeedDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -839,6 +862,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 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). + * @summary getFeeds * @param {FeedsApiGetFeedsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/feeds-api-model-v20210630/base.ts b/src/api-models/feeds-api-model-v20210630/base.ts index bd88f358..22e7c070 100644 --- a/src/api-models/feeds-api-model-v20210630/base.ts +++ b/src/api-models/feeds-api-model-v20210630/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Feeds + * Feeds v2021-06-30 * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/feeds-api-model-v20210630/common.ts b/src/api-models/feeds-api-model-v20210630/common.ts index c689037a..463826bf 100644 --- a/src/api-models/feeds-api-model-v20210630/common.ts +++ b/src/api-models/feeds-api-model-v20210630/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Feeds + * Feeds v2021-06-30 * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/feeds-api-model-v20210630/configuration.ts b/src/api-models/feeds-api-model-v20210630/configuration.ts index 9a71e427..31185086 100644 --- a/src/api-models/feeds-api-model-v20210630/configuration.ts +++ b/src/api-models/feeds-api-model-v20210630/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Feeds + * Feeds v2021-06-30 * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/feeds-api-model-v20210630/index.ts b/src/api-models/feeds-api-model-v20210630/index.ts index d4b8feb3..3163875b 100644 --- a/src/api-models/feeds-api-model-v20210630/index.ts +++ b/src/api-models/feeds-api-model-v20210630/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Feeds + * Feeds v2021-06-30 * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/finances-api-model/api.ts b/src/api-models/finances-api-model/api.ts index d2bcfef4..108ddec2 100644 --- a/src/api-models/finances-api-model/api.ts +++ b/src/api-models/finances-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Finances - * The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. + * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. * * The version of the OpenAPI document: v0 * @@ -28,13 +28,13 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr */ export interface AdhocDisbursementEvent { /** - * The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\". + * Indicates the type of transaction. Example: \"Disbursed to Amazon Gift Card balance\" * @type {string} * @memberof AdhocDisbursementEvent */ TransactionType?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof AdhocDisbursementEvent */ @@ -59,13 +59,13 @@ export interface AdhocDisbursementEvent { */ export interface AdjustmentEvent { /** - * The type of adjustment. Possible values: * `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller\'s account is held back. * `PostageBilling`: The amount paid by a seller for shipping labels. * `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded. * `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * `SellerRewards`: An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace. + * The type of adjustment. Possible values: * FBAInventoryReimbursement - An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller\'s account is held back. * PostageBilling - The amount paid by a seller for shipping labels. * PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded. * LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * SellerRewards - An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace. * @type {string} * @memberof AdjustmentEvent */ AdjustmentType?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof AdjustmentEvent */ @@ -90,7 +90,7 @@ export interface AdjustmentEvent { */ export interface AdjustmentItem { /** - * Represents the number of units in the seller\'s inventory when the `AdjustmentType` is `FBAInventoryReimbursement`. + * Represents the number of units in the seller\'s inventory when the AdustmentType is FBAInventoryReimbursement. * @type {string} * @memberof AdjustmentItem */ @@ -131,6 +131,12 @@ export interface AdjustmentItem { * @memberof AdjustmentItem */ ASIN?: string; + /** + * The transaction number that is related to the adjustment. + * @type {string} + * @memberof AdjustmentItem + */ + TransactionNumber?: string; } /** * An expense related to an affordability promotion. @@ -145,19 +151,19 @@ export interface AffordabilityExpenseEvent { */ AmazonOrderId?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof AffordabilityExpenseEvent */ PostedDate?: string; /** - * The Amazon-defined marketplace identifier. + * An encrypted, Amazon-defined marketplace identifier. * @type {string} * @memberof AffordabilityExpenseEvent */ MarketplaceId?: string; /** - * The type of transaction. Possible values: * `Charge`: an affordability promotion expense. * `Refund`: an affordability promotion expense reversal. + * Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal. * @type {string} * @memberof AffordabilityExpenseEvent */ @@ -200,13 +206,13 @@ export interface AffordabilityExpenseEvent { */ export interface CapacityReservationBillingEvent { /** - * The transaction type. For example, FBA Inventory Fee. + * Indicates the type of transaction. For example, FBA Inventory Fee * @type {string} * @memberof CapacityReservationBillingEvent */ TransactionType?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof CapacityReservationBillingEvent */ @@ -225,7 +231,7 @@ export interface CapacityReservationBillingEvent { TransactionAmount?: Currency; } /** - * A charge on the seller\'s account. Possible values: * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered. * `Tax`: The tax on the principal that is collected by the seller. * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal. * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`. * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge. * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges. * `Discount`: The promotional discount for an order item. * `TaxDiscount`: The tax that is deducted for promotional rebates. * `CODItemCharge`: The COD charge for an order item. * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`. * `CODOrderCharge`: The COD charge for an order. * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`. * `CODShippingCharge`: Shipping charges for a COD order. * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`. * `ShippingCharge`: The shipping charge. * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`. * `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * `Giftwrap`: The gift wrap charge. * `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge. * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories. * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault. * `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * `GenericDeduction`: A generic bad debt deduction. * `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces. * `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * `SAFE-TReimbursement`: The SAFE-T claim amount for the item. * `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST). * `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST). * `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). + * A charge on the seller\'s account. Possible values: * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. * Tax - The tax collected by the seller on the Principal. * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. * Discount - The promotional discount for an order item. * TaxDiscount - The tax amount deducted for promotional rebates. * CODItemCharge - The COD charge for an order item. * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. * CODOrderCharge - The COD charge for an order. * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. * CODShippingCharge - Shipping charges for a COD order. * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. * ShippingCharge - The shipping charge. * ShippingTax - The tax collected by the seller on a ShippingCharge. * Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * Giftwrap - The gift wrap charge. * GiftwrapTax - The tax collected by the seller on a Giftwrap charge. * RestockingFee - The charge applied to the buyer when returning a product in certain categories. * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. * PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * GenericDeduction - A generic bad debt deduction. * FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. * ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * SAFE-TReimbursement - The SAFE-T claim amount for the item. * TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). * TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). * TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). * @export * @interface ChargeComponent */ @@ -275,19 +281,19 @@ export interface ChargeInstrument { */ export interface ChargeRefundEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof ChargeRefundEvent */ PostedDate?: string; /** - * The reason given for a charge refund. For example, `SubscriptionFeeCorrection`. + * The reason given for a charge refund. Example: `SubscriptionFeeCorrection` * @type {string} * @memberof ChargeRefundEvent */ ReasonCode?: string; /** - * A description of the Reason Code. For example, `SubscriptionFeeCorrection`. + * A description of the Reason Code. Example: `SubscriptionFeeCorrection` * @type {string} * @memberof ChargeRefundEvent */ @@ -325,7 +331,7 @@ export interface ChargeRefundTransaction { */ export interface CouponPaymentEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof CouponPaymentEvent */ @@ -386,7 +392,7 @@ export interface Currency { */ CurrencyCode?: string; /** - * A signed decimal number. + * Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount). * @type {number} * @memberof Currency */ @@ -399,7 +405,7 @@ export interface Currency { */ export interface DebtRecoveryEvent { /** - * The debt recovery type. Possible values: * `DebtPayment` * `DebtPaymentFailure` * `DebtAdjustment` + * The debt recovery type. Possible values: * DebtPayment * DebtPaymentFailure * DebtAdjustment * @type {string} * @memberof DebtRecoveryEvent */ @@ -448,13 +454,13 @@ export interface DebtRecoveryItem { */ OriginalAmount?: Currency; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof DebtRecoveryItem */ GroupBeginDate?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof DebtRecoveryItem */ @@ -467,7 +473,7 @@ export interface DebtRecoveryItem { */ export interface DirectPayment { /** - * The type of payment. Possible values: * `StoredValueCardRevenue` - The amount that is deducted from the seller\'s account because the seller received money through a stored value card. * `StoredValueCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a stored value card is refunded. * `PrivateLabelCreditCardRevenue` - The amount that is deducted from the seller\'s account because the seller received money through a private label credit card offered by Amazon. * `PrivateLabelCreditCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a private label credit card offered by Amazon is refunded. * `CollectOnDeliveryRevenue` - The COD amount that the seller collected directly from the buyer. * `CollectOnDeliveryRefund` - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded. + * The type of payment. Possible values: * StoredValueCardRevenue - The amount that is deducted from the seller\'s account because the seller received money through a stored value card. * StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded. * PrivateLabelCreditCardRevenue - The amount that is deducted from the seller\'s account because the seller received money through a private label credit card offered by Amazon. * PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded. * CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer. * CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded. * @type {string} * @memberof DirectPayment */ @@ -486,7 +492,7 @@ export interface DirectPayment { */ export interface FBALiquidationEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof FBALiquidationEvent */ @@ -517,7 +523,7 @@ export interface FBALiquidationEvent { */ export interface FailedAdhocDisbursementEvent { /** - * The type of fund transfer. For example, `Refund`. + * The type of fund transfer. Example \"Refund\" * @type {string} * @memberof FailedAdhocDisbursementEvent */ @@ -535,13 +541,13 @@ export interface FailedAdhocDisbursementEvent { */ DisbursementId?: string; /** - * The type of payment for disbursement. For example, `CREDIT_CARD`. + * The type of payment for disbursement. Example `CREDIT_CARD` * @type {string} * @memberof FailedAdhocDisbursementEvent */ PaymentDisbursementType?: string; /** - * The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`. + * The status of the failed `AdhocDisbursement`. Example `HARD_DECLINED` * @type {string} * @memberof FailedAdhocDisbursementEvent */ @@ -553,7 +559,7 @@ export interface FailedAdhocDisbursementEvent { */ TransferAmount?: Currency; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof FailedAdhocDisbursementEvent */ @@ -591,7 +597,7 @@ export interface FinancialEventGroup { */ FinancialEventGroupId?: string; /** - * The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * `Open` * `Closed` + * The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * Open * Closed * @type {string} * @memberof FinancialEventGroup */ @@ -615,7 +621,7 @@ export interface FinancialEventGroup { */ ConvertedTotal?: Currency; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof FinancialEventGroup */ @@ -639,20 +645,20 @@ export interface FinancialEventGroup { */ BeginningBalance?: Currency; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof FinancialEventGroup */ FinancialEventGroupStart?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof FinancialEventGroup */ FinancialEventGroupEnd?: string; } /** - * All the information that is related to a financial event. + * Contains all information related to a financial event. * @export * @interface FinancialEvents */ @@ -694,13 +700,13 @@ export interface FinancialEvents { */ PayWithAmazonEventList?: Array; /** - * A list of `SolutionProviderCreditEvent`. + * A list of information about solution provider credits. * @type {Array} * @memberof FinancialEvents */ ServiceProviderCreditEventList?: Array; /** - * A list of information about `Retrocharge` or `RetrochargeReversal` events. + * A list of information about Retrocharge or RetrochargeReversal events. * @type {Array} * @memberof FinancialEvents */ @@ -748,7 +754,7 @@ export interface FinancialEvents { */ AdjustmentEventList?: Array; /** - * A list of `SAFETReimbursementEvent`. + * A list of SAFETReimbursementEvents. * @type {Array} * @memberof FinancialEvents */ @@ -802,7 +808,7 @@ export interface FinancialEvents { */ RemovalShipmentEventList?: Array; /** - * A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory. + * A comma-delimited list of Removal shipmentAdjustment details for FBA inventory. * @type {Array} * @memberof FinancialEvents */ @@ -826,7 +832,7 @@ export interface FinancialEvents { */ AdhocDisbursementEventList?: Array; /** - * A list of tax withholding events. + * A list of `TaxWithholding` events. * @type {Array} * @memberof FinancialEvents */ @@ -838,7 +844,7 @@ export interface FinancialEvents { */ ChargeRefundEventList?: Array; /** - * A list of `FailedAdhocDisbursementEvent`. + * A list of `FailedAdhocDisbursementEvent`s. * @type {Array} * @memberof FinancialEvents */ @@ -875,7 +881,7 @@ export interface ImagingServicesFeeEvent { */ ASIN?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof ImagingServicesFeeEvent */ @@ -888,7 +894,7 @@ export interface ImagingServicesFeeEvent { FeeList?: Array; } /** - * The payload for the `listFinancialEventGroups` operation. + * The payload for the listFinancialEventGroups operation. * @export * @interface ListFinancialEventGroupsPayload */ @@ -907,7 +913,7 @@ export interface ListFinancialEventGroupsPayload { FinancialEventGroupList?: Array; } /** - * The response schema for the `listFinancialEventGroups` operation. + * The response schema for the listFinancialEventGroups operation. * @export * @interface ListFinancialEventGroupsResponse */ @@ -926,7 +932,7 @@ export interface ListFinancialEventGroupsResponse { errors?: Array; } /** - * The payload for the `listFinancialEvents` operation. + * The payload for the listFinancialEvents operation. * @export * @interface ListFinancialEventsPayload */ @@ -945,7 +951,7 @@ export interface ListFinancialEventsPayload { FinancialEvents?: FinancialEvents; } /** - * The response schema for the `listFinancialEvents` operation. + * The response schema for the listFinancialEvents operation. * @export * @interface ListFinancialEventsResponse */ @@ -976,7 +982,7 @@ export interface LoanServicingEvent { */ LoanAmount?: Currency; /** - * The type of event. Possible values: * `LoanAdvance` * `LoanPayment` * `LoanRefund` + * The type of event. Possible values: * LoanAdvance * LoanPayment * LoanRefund * @type {string} * @memberof LoanServicingEvent */ @@ -1014,13 +1020,13 @@ export interface ModelError { */ export interface NetworkComminglingTransactionEvent { /** - * The type of network item swap. Possible values: * `NetCo`: A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace. * `ComminglingVAT`: A commingling VAT transaction. Available only in the Spain, UK, France, Germany, and Italy marketplaces. + * The type of network item swap. Possible values: * NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace. * ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy marketplaces. * @type {string} * @memberof NetworkComminglingTransactionEvent */ TransactionType?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof NetworkComminglingTransactionEvent */ @@ -1075,7 +1081,7 @@ export interface PayWithAmazonEvent { */ SellerOrderId?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof PayWithAmazonEvent */ @@ -1105,7 +1111,7 @@ export interface PayWithAmazonEvent { */ FeeList?: Array; /** - * The type of payment. Possible values: * `Sales` + * The type of payment. Possible values: * Sales * @type {string} * @memberof PayWithAmazonEvent */ @@ -1117,13 +1123,13 @@ export interface PayWithAmazonEvent { */ AmountDescription?: string; /** - * The fulfillment channel. Possible values: * `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon) * `MFN`: Merchant Fulfillment Network (self-fulfilled) + * The fulfillment channel. Possible values: * AFN - Amazon Fulfillment Network (Fulfillment by Amazon) * MFN - Merchant Fulfillment Network (self-fulfilled) * @type {string} * @memberof PayWithAmazonEvent */ FulfillmentChannel?: string; /** - * The name of the store where the event occurred. + * The store name where the event occurred. * @type {string} * @memberof PayWithAmazonEvent */ @@ -1136,19 +1142,19 @@ export interface PayWithAmazonEvent { */ export interface ProductAdsPaymentEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof ProductAdsPaymentEvent */ postedDate?: string; /** - * Indicates if the transaction is for a charge or a refund. Possible values: * `charge` * `refund` + * Indicates if the transaction is for a charge or a refund. Possible values: * charge - Charge * refund - Refund * @type {string} * @memberof ProductAdsPaymentEvent */ transactionType?: string; /** - * The identifier for the invoice that includes the transaction. + * Identifier for the invoice that the transaction appears in. * @type {string} * @memberof ProductAdsPaymentEvent */ @@ -1204,7 +1210,7 @@ export interface Promotion { */ export interface RemovalShipmentAdjustmentEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof RemovalShipmentAdjustmentEvent */ @@ -1228,13 +1234,13 @@ export interface RemovalShipmentAdjustmentEvent { */ OrderId?: string; /** - * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`. + * The type of removal order. Possible values: * WHOLESALE_LIQUIDATION. * @type {string} * @memberof RemovalShipmentAdjustmentEvent */ TransactionType?: string; /** - * A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory. + * A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory. * @type {Array} * @memberof RemovalShipmentAdjustmentEvent */ @@ -1247,13 +1253,13 @@ export interface RemovalShipmentAdjustmentEvent { */ export interface RemovalShipmentEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof RemovalShipmentEvent */ PostedDate?: string; /** - * The merchant removal `orderId`. + * The merchant removal orderId. * @type {string} * @memberof RemovalShipmentEvent */ @@ -1265,7 +1271,7 @@ export interface RemovalShipmentEvent { */ OrderId?: string; /** - * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION` + * The type of removal order. Possible values: * WHOLESALE_LIQUIDATION * @type {string} * @memberof RemovalShipmentEvent */ @@ -1277,7 +1283,7 @@ export interface RemovalShipmentEvent { */ StoreName?: string; /** - * A list of `RemovalShipmentItem`. + * A list of information about removal shipment items. * @type {Array} * @memberof RemovalShipmentEvent */ @@ -1296,7 +1302,7 @@ export interface RemovalShipmentItem { */ RemovalShipmentItemId?: string; /** - * The tax collection model that is applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon. + * The tax collection model applied to the item. Possible values: * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon. * @type {string} * @memberof RemovalShipmentItem */ @@ -1351,7 +1357,7 @@ export interface RemovalShipmentItemAdjustment { */ RemovalShipmentItemId?: string; /** - * The tax collection model that is applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon. + * The tax collection model applied to the item. Possible values: * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon. * @type {string} * @memberof RemovalShipmentItemAdjustment */ @@ -1363,7 +1369,7 @@ export interface RemovalShipmentItemAdjustment { */ FulfillmentNetworkSKU?: string; /** - * Adjusted quantity of `RemovalShipmentItemAdjustment` items. + * Adjusted quantity of removal shipmentItemAdjustment items. * @type {number} * @memberof RemovalShipmentItemAdjustment */ @@ -1400,19 +1406,19 @@ export interface RentalTransactionEvent { */ AmazonOrderId?: string; /** - * The type of rental event. Possible values: * `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item. * `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period. * `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item. * `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item. * `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item. + * The type of rental event. Possible values: * RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item. * RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period. * RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item. * RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item. * RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item. * @type {string} * @memberof RentalTransactionEvent */ RentalEventType?: string; /** - * The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events. + * The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events. * @type {number} * @memberof RentalTransactionEvent */ ExtensionLength?: number; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof RentalTransactionEvent */ @@ -1461,7 +1467,7 @@ export interface RentalTransactionEvent { */ export interface RetrochargeEvent { /** - * The type of event. Possible values: * `Retrocharge` * `RetrochargeReversal` + * The type of event. Possible values: * Retrocharge * RetrochargeReversal * @type {string} * @memberof RetrochargeEvent */ @@ -1473,7 +1479,7 @@ export interface RetrochargeEvent { */ AmazonOrderId?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof RetrochargeEvent */ @@ -1510,7 +1516,7 @@ export interface RetrochargeEvent { */ export interface SAFETReimbursementEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof SAFETReimbursementEvent */ @@ -1534,7 +1540,7 @@ export interface SAFETReimbursementEvent { */ ReasonCode?: string; /** - * A list of `SAFETReimbursementItem`. + * A list of SAFETReimbursementItems. * @type {Array} * @memberof SAFETReimbursementEvent */ @@ -1572,7 +1578,7 @@ export interface SAFETReimbursementItem { */ export interface SellerDealPaymentEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof SellerDealPaymentEvent */ @@ -1590,13 +1596,13 @@ export interface SellerDealPaymentEvent { */ dealDescription?: string; /** - * The type of event: `SellerDealComplete`. + * The type of event: SellerDealComplete. * @type {string} * @memberof SellerDealPaymentEvent */ eventType?: string; /** - * The type of fee: `RunLightningDealFee`. + * The type of fee: RunLightningDealFee. * @type {string} * @memberof SellerDealPaymentEvent */ @@ -1627,7 +1633,7 @@ export interface SellerDealPaymentEvent { */ export interface SellerReviewEnrollmentPaymentEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof SellerReviewEnrollmentPaymentEvent */ @@ -1791,7 +1797,7 @@ export interface ShipmentEvent { */ DirectPaymentList?: Array; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof ShipmentEvent */ @@ -1955,7 +1961,7 @@ export interface SolutionProviderCreditEvent { */ TransactionAmount?: Currency; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof SolutionProviderCreditEvent */ @@ -1968,7 +1974,7 @@ export interface SolutionProviderCreditEvent { */ export interface TDSReimbursementEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof TDSReimbursementEvent */ @@ -1993,7 +1999,7 @@ export interface TDSReimbursementEvent { */ export interface TaxWithheldComponent { /** - * The tax collection model applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon. + * The tax collection model applied to the item. Possible values: * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon. * @type {string} * @memberof TaxWithheldComponent */ @@ -2006,13 +2012,13 @@ export interface TaxWithheldComponent { TaxesWithheld?: Array; } /** - * A tax withholding event on a seller\'s account. + * A TaxWithholding event on seller\'s account. * @export * @interface TaxWithholdingEvent */ export interface TaxWithholdingEvent { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof TaxWithholdingEvent */ @@ -2037,19 +2043,19 @@ export interface TaxWithholdingEvent { TaxWithholdingPeriod?: TaxWithholdingPeriod; } /** - * The period during which tax withholding on a seller\'s account is calculated. + * Period which taxwithholding on seller\'s account is calculated. * @export * @interface TaxWithholdingPeriod */ export interface TaxWithholdingPeriod { /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof TaxWithholdingPeriod */ StartDate?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof TaxWithholdingPeriod */ @@ -2074,7 +2080,7 @@ export interface TrialShipmentEvent { */ FinancialEventGroupId?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof TrialShipmentEvent */ @@ -2099,13 +2105,13 @@ export interface TrialShipmentEvent { */ export interface ValueAddedServiceChargeEvent { /** - * The transaction type. For example, \'Other Support Service fees\' + * Indicates the type of transaction. Example: \'Other Support Service fees\' * @type {string} * @memberof ValueAddedServiceChargeEvent */ TransactionType?: string; /** - * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate). * @type {string} * @memberof ValueAddedServiceChargeEvent */ @@ -2131,11 +2137,11 @@ export interface ValueAddedServiceChargeEvent { export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). - * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned. - * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **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 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 {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [financialEventGroupStartedBefore] A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. + * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2184,11 +2190,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 can have higher rate and burst values than 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). - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. - * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 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 {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2237,12 +2243,12 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 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} eventGroupId The identifier of the financial event group to which the events belong. - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. - * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2294,10 +2300,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **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 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} orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2347,11 +2353,11 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) return { /** - * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). - * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned. - * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **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 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 {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [financialEventGroupStartedBefore] A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. + * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2360,11 +2366,11 @@ export const DefaultApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 can have higher rate and burst values than 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). - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. - * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 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 {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2373,12 +2379,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 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} eventGroupId The identifier of the financial event group to which the events belong. - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. - * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2387,10 +2393,10 @@ export const DefaultApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **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 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} orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2409,11 +2415,11 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa const localVarFp = DefaultApiFp(configuration) return { /** - * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). - * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned. - * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **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 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 {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [financialEventGroupStartedBefore] A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. + * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2421,11 +2427,11 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 can have higher rate and burst values than 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). - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. - * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 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 {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2433,12 +2439,12 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 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} eventGroupId The identifier of the financial event group to which the events belong. - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. - * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2446,10 +2452,10 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, postedAfter, postedBefore, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **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 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} orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. - * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. + * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2466,28 +2472,28 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa */ export interface DefaultApiListFinancialEventGroupsRequest { /** - * The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. * @type {number} * @memberof DefaultApiListFinancialEventGroups */ readonly maxResultsPerPage?: number /** - * A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned. + * A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. * @type {string} * @memberof DefaultApiListFinancialEventGroups */ readonly financialEventGroupStartedBefore?: string /** - * A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request. + * A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted. * @type {string} * @memberof DefaultApiListFinancialEventGroups */ readonly financialEventGroupStartedAfter?: string /** - * The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * A string token returned in the response of your previous request. * @type {string} * @memberof DefaultApiListFinancialEventGroups */ @@ -2501,28 +2507,28 @@ export interface DefaultApiListFinancialEventGroupsRequest { */ export interface DefaultApiListFinancialEventsRequest { /** - * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. * @type {number} * @memberof DefaultApiListFinancialEvents */ readonly maxResultsPerPage?: number /** - * The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. + * A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. * @type {string} * @memberof DefaultApiListFinancialEvents */ readonly postedAfter?: string /** - * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. + * A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. * @type {string} * @memberof DefaultApiListFinancialEvents */ readonly postedBefore?: string /** - * The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * A string token returned in the response of your previous request. * @type {string} * @memberof DefaultApiListFinancialEvents */ @@ -2543,28 +2549,28 @@ export interface DefaultApiListFinancialEventsByGroupIdRequest { readonly eventGroupId: string /** - * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. * @type {number} * @memberof DefaultApiListFinancialEventsByGroupId */ readonly maxResultsPerPage?: number /** - * The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. + * A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. * @type {string} * @memberof DefaultApiListFinancialEventsByGroupId */ readonly postedAfter?: string /** - * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request. + * A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes. * @type {string} * @memberof DefaultApiListFinancialEventsByGroupId */ readonly postedBefore?: string /** - * The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * A string token returned in the response of your previous request. * @type {string} * @memberof DefaultApiListFinancialEventsByGroupId */ @@ -2585,14 +2591,14 @@ export interface DefaultApiListFinancialEventsByOrderIdRequest { readonly orderId: string /** - * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'. * @type {number} * @memberof DefaultApiListFinancialEventsByOrderId */ readonly maxResultsPerPage?: number /** - * The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * A string token returned in the response of your previous request. * @type {string} * @memberof DefaultApiListFinancialEventsByOrderId */ @@ -2607,7 +2613,7 @@ export interface DefaultApiListFinancialEventsByOrderIdRequest { */ export class DefaultApi extends BaseAPI { /** - * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). + * Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **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 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 {DefaultApiListFinancialEventGroupsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2618,7 +2624,7 @@ export class DefaultApi extends BaseAPI { } /** - * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 can have higher rate and burst values than 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). + * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **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 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 {DefaultApiListFinancialEventsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2629,7 +2635,7 @@ export class DefaultApi extends BaseAPI { } /** - * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 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 {DefaultApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2640,7 +2646,7 @@ export class DefaultApi extends BaseAPI { } /** - * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **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 can have higher rate and burst values than 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). + * Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **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 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 {DefaultApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/finances-api-model/base.ts b/src/api-models/finances-api-model/base.ts index ed810a31..4173b9b3 100644 --- a/src/api-models/finances-api-model/base.ts +++ b/src/api-models/finances-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Finances - * The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. + * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/finances-api-model/common.ts b/src/api-models/finances-api-model/common.ts index e5851181..1e25ded8 100644 --- a/src/api-models/finances-api-model/common.ts +++ b/src/api-models/finances-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Finances - * The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. + * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/finances-api-model/configuration.ts b/src/api-models/finances-api-model/configuration.ts index 8c3c119f..17d6af5e 100644 --- a/src/api-models/finances-api-model/configuration.ts +++ b/src/api-models/finances-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Finances - * The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. + * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/finances-api-model/index.ts b/src/api-models/finances-api-model/index.ts index 00478cdc..e5d66b84 100644 --- a/src/api-models/finances-api-model/index.ts +++ b/src/api-models/finances-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Finances - * The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. + * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. * * The version of the OpenAPI document: v0 * diff --git a/src/api-models/fulfillment-inbound-api-model-v20240320/api.ts b/src/api-models/fulfillment-inbound-api-model-v20240320/api.ts index c1c83789..d9790683 100644 --- a/src/api-models/fulfillment-inbound-api-model-v20240320/api.ts +++ b/src/api-models/fulfillment-inbound-api-model-v20240320/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for FBA inbound operations. + * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 @@ -3097,13 +3097,14 @@ export interface WindowInput { } /** - * FbaInboundApi - axios parameter creator + * FulfillmentInboundApi - axios parameter creator * @export */ -export const FbaInboundApiAxiosParamCreator = function (configuration?: Configuration) { +export const FulfillmentInboundApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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). + * @summary cancelInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3137,6 +3138,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Cancels a self-ship appointment slot against a shipment. **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 preceding table contains 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). + * @summary cancelSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`. @@ -3180,6 +3182,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **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 preceding table contains 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). + * @summary confirmDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to confirm the delivery window option for. * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed. @@ -3221,6 +3224,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Confirms the packing option for an inbound plan. **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 preceding table contains 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). + * @summary confirmPackingOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. @@ -3258,6 +3262,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **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 preceding table contains 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). + * @summary confirmPlacementOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @param {*} [options] Override http request option. @@ -3295,6 +3300,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Confirm a shipment content update preview and accept the changes in transportation cost. **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 preceding table contains 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). + * @summary confirmShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. @@ -3336,6 +3342,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **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 preceding table contains 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). + * @summary confirmTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. @@ -3375,6 +3382,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **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 preceding table contains 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). + * @summary createInboundPlan * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3410,6 +3418,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * For a given marketplace - creates labels for a list of MSKUs. **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 preceding table contains 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). + * @summary createMarketplaceItemLabels * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3445,6 +3454,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Generates available delivery window options for a given shipment. **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 preceding table contains 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). + * @summary generateDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to generate delivery window options for. * @param {*} [options] Override http request option. @@ -3482,6 +3492,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Generates available packing options for the inbound plan. **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 preceding table contains 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). + * @summary generatePackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3515,6 +3526,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Generates placement options for the inbound plan. **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 preceding table contains 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). + * @summary generatePlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. @@ -3554,6 +3566,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Initiates the process of generating the appointment slots list. **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 preceding table contains 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). + * @summary generateSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`. @@ -3597,6 +3610,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **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 preceding table contains 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). + * @summary generateShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`. @@ -3640,6 +3654,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Generates available transportation options for a given placement option. **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 preceding table contains 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). + * @summary generateTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. @@ -3679,6 +3694,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getDeliveryChallanDocument * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. @@ -3716,6 +3732,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getInboundOperationStatus * @param {string} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3749,6 +3766,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3782,6 +3800,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query. @@ -3829,6 +3848,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getShipment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. @@ -3866,6 +3886,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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). + * @summary getShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. @@ -3907,6 +3928,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **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 preceding table contains 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). + * @summary listDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to get delivery window options for. * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query. @@ -3954,6 +3976,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -3997,6 +4020,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -4040,6 +4064,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -4083,6 +4108,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlans * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan. @@ -4137,6 +4163,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listItemComplianceDetails * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {*} [options] Override http request option. @@ -4180,6 +4207,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **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 preceding table contains 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). + * @summary listPackingGroupBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query. @@ -4227,6 +4255,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **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 preceding table contains 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). + * @summary listPackingGroupItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. @@ -4274,6 +4303,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listPackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of packing options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -4317,6 +4347,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listPlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of placement options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -4360,6 +4391,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Get preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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). + * @summary listPrepDetails * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {*} [options] Override http request option. @@ -4403,6 +4435,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a paginated list of box packages in a shipment. **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 preceding table contains 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). + * @summary listShipmentBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. @@ -4450,6 +4483,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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). + * @summary listShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of content update previews to return. @@ -4497,6 +4531,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a paginated list of item packages in a shipment. **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 preceding table contains 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). + * @summary listShipmentItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of items to return in the response matching the given query. @@ -4544,6 +4579,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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). + * @summary listShipmentPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. @@ -4591,6 +4627,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of transportation options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -4644,6 +4681,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Confirms or reschedules a self-ship appointment slot against a 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 preceding table contains 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). + * @summary scheduleSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} slotId An identifier to a self-ship appointment slot. @@ -4691,6 +4729,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **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 preceding table contains 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). + * @summary setPackingInformation * @param {string} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. @@ -4730,6 +4769,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Set the preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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). + * @summary setPrepDetails * @param {SetPrepDetailsRequest} body The body of the request to `setPrepDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4765,6 +4805,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Updates the name of an existing inbound plan. **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 preceding table contains 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). + * @summary updateInboundPlanName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. * @param {*} [options] Override http request option. @@ -4804,6 +4845,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary updateItemComplianceDetails * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. @@ -4846,6 +4888,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Updates the name of an existing shipment. **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 preceding table contains 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). + * @summary updateShipmentName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`. @@ -4889,6 +4932,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source 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 preceding table contains 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). + * @summary updateShipmentSourceAddress * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`. @@ -4932,6 +4976,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }, /** * Updates a shipment\'s tracking details. **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 preceding table contains 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). + * @summary updateShipmentTrackingDetails * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. @@ -4977,14 +5022,15 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; /** - * FbaInboundApi - functional programming interface + * FulfillmentInboundApi - functional programming interface * @export */ -export const FbaInboundApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = FbaInboundApiAxiosParamCreator(configuration) +export const FulfillmentInboundApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = FulfillmentInboundApiAxiosParamCreator(configuration) return { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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). + * @summary cancelInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4995,6 +5041,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Cancels a self-ship appointment slot against a shipment. **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 preceding table contains 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). + * @summary cancelSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`. @@ -5007,6 +5054,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **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 preceding table contains 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). + * @summary confirmDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to confirm the delivery window option for. * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed. @@ -5019,6 +5067,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Confirms the packing option for an inbound plan. **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 preceding table contains 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). + * @summary confirmPackingOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. @@ -5030,6 +5079,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **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 preceding table contains 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). + * @summary confirmPlacementOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @param {*} [options] Override http request option. @@ -5041,6 +5091,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Confirm a shipment content update preview and accept the changes in transportation cost. **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 preceding table contains 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). + * @summary confirmShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. @@ -5053,6 +5104,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **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 preceding table contains 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). + * @summary confirmTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. @@ -5064,6 +5116,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **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 preceding table contains 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). + * @summary createInboundPlan * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5074,6 +5127,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * For a given marketplace - creates labels for a list of MSKUs. **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 preceding table contains 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). + * @summary createMarketplaceItemLabels * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5084,6 +5138,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Generates available delivery window options for a given shipment. **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 preceding table contains 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). + * @summary generateDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to generate delivery window options for. * @param {*} [options] Override http request option. @@ -5095,6 +5150,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Generates available packing options for the inbound plan. **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 preceding table contains 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). + * @summary generatePackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5105,6 +5161,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Generates placement options for the inbound plan. **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 preceding table contains 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). + * @summary generatePlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. @@ -5116,6 +5173,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Initiates the process of generating the appointment slots list. **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 preceding table contains 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). + * @summary generateSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`. @@ -5128,6 +5186,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **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 preceding table contains 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). + * @summary generateShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`. @@ -5140,6 +5199,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Generates available transportation options for a given placement option. **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 preceding table contains 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). + * @summary generateTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. @@ -5151,6 +5211,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getDeliveryChallanDocument * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. @@ -5162,6 +5223,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getInboundOperationStatus * @param {string} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5172,6 +5234,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5182,6 +5245,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query. @@ -5195,6 +5259,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getShipment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. @@ -5206,6 +5271,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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). + * @summary getShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. @@ -5218,6 +5284,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **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 preceding table contains 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). + * @summary listDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to get delivery window options for. * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query. @@ -5231,6 +5298,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5243,6 +5311,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5255,6 +5324,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5267,6 +5337,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlans * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan. @@ -5281,6 +5352,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listItemComplianceDetails * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {*} [options] Override http request option. @@ -5292,6 +5364,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **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 preceding table contains 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). + * @summary listPackingGroupBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query. @@ -5305,6 +5378,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **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 preceding table contains 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). + * @summary listPackingGroupItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. @@ -5318,6 +5392,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listPackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of packing options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5330,6 +5405,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listPlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of placement options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5342,6 +5418,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Get preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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). + * @summary listPrepDetails * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {*} [options] Override http request option. @@ -5353,6 +5430,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a paginated list of box packages in a shipment. **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 preceding table contains 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). + * @summary listShipmentBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. @@ -5366,6 +5444,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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). + * @summary listShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of content update previews to return. @@ -5379,6 +5458,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a paginated list of item packages in a shipment. **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 preceding table contains 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). + * @summary listShipmentItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of items to return in the response matching the given query. @@ -5392,6 +5472,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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). + * @summary listShipmentPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. @@ -5405,6 +5486,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of transportation options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5419,6 +5501,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Confirms or reschedules a self-ship appointment slot against a 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 preceding table contains 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). + * @summary scheduleSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} slotId An identifier to a self-ship appointment slot. @@ -5432,6 +5515,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **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 preceding table contains 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). + * @summary setPackingInformation * @param {string} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. @@ -5443,6 +5527,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Set the preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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). + * @summary setPrepDetails * @param {SetPrepDetailsRequest} body The body of the request to `setPrepDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5453,6 +5538,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Updates the name of an existing inbound plan. **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 preceding table contains 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). + * @summary updateInboundPlanName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. * @param {*} [options] Override http request option. @@ -5464,6 +5550,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary updateItemComplianceDetails * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. @@ -5475,6 +5562,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Updates the name of an existing shipment. **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 preceding table contains 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). + * @summary updateShipmentName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`. @@ -5487,6 +5575,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source 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 preceding table contains 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). + * @summary updateShipmentSourceAddress * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`. @@ -5499,6 +5588,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }, /** * Updates a shipment\'s tracking details. **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 preceding table contains 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). + * @summary updateShipmentTrackingDetails * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. @@ -5513,14 +5603,15 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { }; /** - * FbaInboundApi - factory interface + * FulfillmentInboundApi - factory interface * @export */ -export const FbaInboundApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = FbaInboundApiFp(configuration) +export const FulfillmentInboundApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = FulfillmentInboundApiFp(configuration) return { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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). + * @summary cancelInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5530,6 +5621,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Cancels a self-ship appointment slot against a shipment. **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 preceding table contains 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). + * @summary cancelSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`. @@ -5541,6 +5633,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **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 preceding table contains 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). + * @summary confirmDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to confirm the delivery window option for. * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed. @@ -5552,6 +5645,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Confirms the packing option for an inbound plan. **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 preceding table contains 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). + * @summary confirmPackingOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. @@ -5562,6 +5656,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **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 preceding table contains 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). + * @summary confirmPlacementOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @param {*} [options] Override http request option. @@ -5572,6 +5667,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Confirm a shipment content update preview and accept the changes in transportation cost. **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 preceding table contains 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). + * @summary confirmShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. @@ -5583,6 +5679,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **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 preceding table contains 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). + * @summary confirmTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. @@ -5593,6 +5690,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **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 preceding table contains 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). + * @summary createInboundPlan * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5602,6 +5700,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * For a given marketplace - creates labels for a list of MSKUs. **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 preceding table contains 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). + * @summary createMarketplaceItemLabels * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5611,6 +5710,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Generates available delivery window options for a given shipment. **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 preceding table contains 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). + * @summary generateDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to generate delivery window options for. * @param {*} [options] Override http request option. @@ -5621,6 +5721,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Generates available packing options for the inbound plan. **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 preceding table contains 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). + * @summary generatePackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5630,6 +5731,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Generates placement options for the inbound plan. **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 preceding table contains 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). + * @summary generatePlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. @@ -5640,6 +5742,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Initiates the process of generating the appointment slots list. **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 preceding table contains 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). + * @summary generateSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`. @@ -5651,6 +5754,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **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 preceding table contains 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). + * @summary generateShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`. @@ -5662,6 +5766,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Generates available transportation options for a given placement option. **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 preceding table contains 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). + * @summary generateTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. @@ -5672,6 +5777,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getDeliveryChallanDocument * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. @@ -5682,6 +5788,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getInboundOperationStatus * @param {string} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5691,6 +5798,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5700,6 +5808,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query. @@ -5712,6 +5821,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary getShipment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. @@ -5722,6 +5832,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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). + * @summary getShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. @@ -5733,6 +5844,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **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 preceding table contains 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). + * @summary listDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to get delivery window options for. * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query. @@ -5745,6 +5857,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5756,6 +5869,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5767,6 +5881,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlanPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5778,6 +5893,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listInboundPlans * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan. @@ -5791,6 +5907,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listItemComplianceDetails * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {*} [options] Override http request option. @@ -5801,6 +5918,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **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 preceding table contains 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). + * @summary listPackingGroupBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query. @@ -5813,6 +5931,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **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 preceding table contains 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). + * @summary listPackingGroupItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. @@ -5825,6 +5944,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listPackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of packing options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5836,6 +5956,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listPlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of placement options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5847,6 +5968,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Get preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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). + * @summary listPrepDetails * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {*} [options] Override http request option. @@ -5857,6 +5979,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a paginated list of box packages in a shipment. **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 preceding table contains 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). + * @summary listShipmentBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. @@ -5869,6 +5992,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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). + * @summary listShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of content update previews to return. @@ -5881,6 +6005,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a paginated list of item packages in a shipment. **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 preceding table contains 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). + * @summary listShipmentItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of items to return in the response matching the given query. @@ -5893,6 +6018,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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). + * @summary listShipmentPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. @@ -5905,6 +6031,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary listTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of transportation options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. @@ -5918,6 +6045,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Confirms or reschedules a self-ship appointment slot against a 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 preceding table contains 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). + * @summary scheduleSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} slotId An identifier to a self-ship appointment slot. @@ -5930,6 +6058,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **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 preceding table contains 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). + * @summary setPackingInformation * @param {string} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. @@ -5940,6 +6069,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Set the preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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). + * @summary setPrepDetails * @param {SetPrepDetailsRequest} body The body of the request to `setPrepDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5949,6 +6079,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Updates the name of an existing inbound plan. **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 preceding table contains 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). + * @summary updateInboundPlanName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. * @param {*} [options] Override http request option. @@ -5959,6 +6090,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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). + * @summary updateItemComplianceDetails * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. @@ -5969,6 +6101,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Updates the name of an existing shipment. **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 preceding table contains 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). + * @summary updateShipmentName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`. @@ -5980,6 +6113,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source 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 preceding table contains 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). + * @summary updateShipmentSourceAddress * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`. @@ -5991,6 +6125,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }, /** * Updates a shipment\'s tracking details. **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 preceding table contains 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). + * @summary updateShipmentTrackingDetails * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. @@ -6004,1667 +6139,1712 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas }; /** - * Request parameters for cancelInboundPlan operation in FbaInboundApi. + * Request parameters for cancelInboundPlan operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiCancelInboundPlanRequest + * @interface FulfillmentInboundApiCancelInboundPlanRequest */ -export interface FbaInboundApiCancelInboundPlanRequest { +export interface FulfillmentInboundApiCancelInboundPlanRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiCancelInboundPlan + * @memberof FulfillmentInboundApiCancelInboundPlan */ readonly inboundPlanId: string } /** - * Request parameters for cancelSelfShipAppointment operation in FbaInboundApi. + * Request parameters for cancelSelfShipAppointment operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiCancelSelfShipAppointmentRequest + * @interface FulfillmentInboundApiCancelSelfShipAppointmentRequest */ -export interface FbaInboundApiCancelSelfShipAppointmentRequest { +export interface FulfillmentInboundApiCancelSelfShipAppointmentRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiCancelSelfShipAppointment + * @memberof FulfillmentInboundApiCancelSelfShipAppointment */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiCancelSelfShipAppointment + * @memberof FulfillmentInboundApiCancelSelfShipAppointment */ readonly shipmentId: string /** * The body of the request to `cancelSelfShipAppointment`. * @type {CancelSelfShipAppointmentRequest} - * @memberof FbaInboundApiCancelSelfShipAppointment + * @memberof FulfillmentInboundApiCancelSelfShipAppointment */ readonly body: CancelSelfShipAppointmentRequest } /** - * Request parameters for confirmDeliveryWindowOptions operation in FbaInboundApi. + * Request parameters for confirmDeliveryWindowOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiConfirmDeliveryWindowOptionsRequest + * @interface FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest */ -export interface FbaInboundApiConfirmDeliveryWindowOptionsRequest { +export interface FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiConfirmDeliveryWindowOptions + * @memberof FulfillmentInboundApiConfirmDeliveryWindowOptions */ readonly inboundPlanId: string /** * The shipment to confirm the delivery window option for. * @type {string} - * @memberof FbaInboundApiConfirmDeliveryWindowOptions + * @memberof FulfillmentInboundApiConfirmDeliveryWindowOptions */ readonly shipmentId: string /** * The id of the delivery window option to be confirmed. * @type {string} - * @memberof FbaInboundApiConfirmDeliveryWindowOptions + * @memberof FulfillmentInboundApiConfirmDeliveryWindowOptions */ readonly deliveryWindowOptionId: string } /** - * Request parameters for confirmPackingOption operation in FbaInboundApi. + * Request parameters for confirmPackingOption operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiConfirmPackingOptionRequest + * @interface FulfillmentInboundApiConfirmPackingOptionRequest */ -export interface FbaInboundApiConfirmPackingOptionRequest { +export interface FulfillmentInboundApiConfirmPackingOptionRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiConfirmPackingOption + * @memberof FulfillmentInboundApiConfirmPackingOption */ readonly inboundPlanId: string /** * Identifier of a packing option. * @type {string} - * @memberof FbaInboundApiConfirmPackingOption + * @memberof FulfillmentInboundApiConfirmPackingOption */ readonly packingOptionId: string } /** - * Request parameters for confirmPlacementOption operation in FbaInboundApi. + * Request parameters for confirmPlacementOption operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiConfirmPlacementOptionRequest + * @interface FulfillmentInboundApiConfirmPlacementOptionRequest */ -export interface FbaInboundApiConfirmPlacementOptionRequest { +export interface FulfillmentInboundApiConfirmPlacementOptionRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiConfirmPlacementOption + * @memberof FulfillmentInboundApiConfirmPlacementOption */ readonly inboundPlanId: string /** * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} - * @memberof FbaInboundApiConfirmPlacementOption + * @memberof FulfillmentInboundApiConfirmPlacementOption */ readonly placementOptionId: string } /** - * Request parameters for confirmShipmentContentUpdatePreview operation in FbaInboundApi. + * Request parameters for confirmShipmentContentUpdatePreview operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiConfirmShipmentContentUpdatePreviewRequest + * @interface FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest */ -export interface FbaInboundApiConfirmShipmentContentUpdatePreviewRequest { +export interface FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiConfirmShipmentContentUpdatePreview + * @memberof FulfillmentInboundApiConfirmShipmentContentUpdatePreview */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiConfirmShipmentContentUpdatePreview + * @memberof FulfillmentInboundApiConfirmShipmentContentUpdatePreview */ readonly shipmentId: string /** * Identifier of a content update preview. * @type {string} - * @memberof FbaInboundApiConfirmShipmentContentUpdatePreview + * @memberof FulfillmentInboundApiConfirmShipmentContentUpdatePreview */ readonly contentUpdatePreviewId: string } /** - * Request parameters for confirmTransportationOptions operation in FbaInboundApi. + * Request parameters for confirmTransportationOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiConfirmTransportationOptionsRequest + * @interface FulfillmentInboundApiConfirmTransportationOptionsRequest */ -export interface FbaInboundApiConfirmTransportationOptionsRequest { +export interface FulfillmentInboundApiConfirmTransportationOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiConfirmTransportationOptions + * @memberof FulfillmentInboundApiConfirmTransportationOptions */ readonly inboundPlanId: string /** * The body of the request to `confirmTransportationOptions`. * @type {ConfirmTransportationOptionsRequest} - * @memberof FbaInboundApiConfirmTransportationOptions + * @memberof FulfillmentInboundApiConfirmTransportationOptions */ readonly body: ConfirmTransportationOptionsRequest } /** - * Request parameters for createInboundPlan operation in FbaInboundApi. + * Request parameters for createInboundPlan operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiCreateInboundPlanRequest + * @interface FulfillmentInboundApiCreateInboundPlanRequest */ -export interface FbaInboundApiCreateInboundPlanRequest { +export interface FulfillmentInboundApiCreateInboundPlanRequest { /** * The body of the request to `createInboundPlan`. * @type {CreateInboundPlanRequest} - * @memberof FbaInboundApiCreateInboundPlan + * @memberof FulfillmentInboundApiCreateInboundPlan */ readonly body: CreateInboundPlanRequest } /** - * Request parameters for createMarketplaceItemLabels operation in FbaInboundApi. + * Request parameters for createMarketplaceItemLabels operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiCreateMarketplaceItemLabelsRequest + * @interface FulfillmentInboundApiCreateMarketplaceItemLabelsRequest */ -export interface FbaInboundApiCreateMarketplaceItemLabelsRequest { +export interface FulfillmentInboundApiCreateMarketplaceItemLabelsRequest { /** * The body of the request to `createMarketplaceItemLabels`. * @type {CreateMarketplaceItemLabelsRequest} - * @memberof FbaInboundApiCreateMarketplaceItemLabels + * @memberof FulfillmentInboundApiCreateMarketplaceItemLabels */ readonly body: CreateMarketplaceItemLabelsRequest } /** - * Request parameters for generateDeliveryWindowOptions operation in FbaInboundApi. + * Request parameters for generateDeliveryWindowOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGenerateDeliveryWindowOptionsRequest + * @interface FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest */ -export interface FbaInboundApiGenerateDeliveryWindowOptionsRequest { +export interface FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGenerateDeliveryWindowOptions + * @memberof FulfillmentInboundApiGenerateDeliveryWindowOptions */ readonly inboundPlanId: string /** * The shipment to generate delivery window options for. * @type {string} - * @memberof FbaInboundApiGenerateDeliveryWindowOptions + * @memberof FulfillmentInboundApiGenerateDeliveryWindowOptions */ readonly shipmentId: string } /** - * Request parameters for generatePackingOptions operation in FbaInboundApi. + * Request parameters for generatePackingOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGeneratePackingOptionsRequest + * @interface FulfillmentInboundApiGeneratePackingOptionsRequest */ -export interface FbaInboundApiGeneratePackingOptionsRequest { +export interface FulfillmentInboundApiGeneratePackingOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGeneratePackingOptions + * @memberof FulfillmentInboundApiGeneratePackingOptions */ readonly inboundPlanId: string } /** - * Request parameters for generatePlacementOptions operation in FbaInboundApi. + * Request parameters for generatePlacementOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGeneratePlacementOptionsRequest + * @interface FulfillmentInboundApiGeneratePlacementOptionsRequest */ -export interface FbaInboundApiGeneratePlacementOptionsRequest { +export interface FulfillmentInboundApiGeneratePlacementOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGeneratePlacementOptions + * @memberof FulfillmentInboundApiGeneratePlacementOptions */ readonly inboundPlanId: string /** * The body of the request to `generatePlacementOptions`. * @type {GeneratePlacementOptionsRequest} - * @memberof FbaInboundApiGeneratePlacementOptions + * @memberof FulfillmentInboundApiGeneratePlacementOptions */ readonly body: GeneratePlacementOptionsRequest } /** - * Request parameters for generateSelfShipAppointmentSlots operation in FbaInboundApi. + * Request parameters for generateSelfShipAppointmentSlots operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGenerateSelfShipAppointmentSlotsRequest + * @interface FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest */ -export interface FbaInboundApiGenerateSelfShipAppointmentSlotsRequest { +export interface FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGenerateSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGenerateSelfShipAppointmentSlots */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiGenerateSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGenerateSelfShipAppointmentSlots */ readonly shipmentId: string /** * The body of the request to `generateSelfShipAppointmentSlots`. * @type {GenerateSelfShipAppointmentSlotsRequest} - * @memberof FbaInboundApiGenerateSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGenerateSelfShipAppointmentSlots */ readonly body: GenerateSelfShipAppointmentSlotsRequest } /** - * Request parameters for generateShipmentContentUpdatePreviews operation in FbaInboundApi. + * Request parameters for generateShipmentContentUpdatePreviews operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest + * @interface FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest */ -export interface FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest { +export interface FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGenerateShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiGenerateShipmentContentUpdatePreviews */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiGenerateShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiGenerateShipmentContentUpdatePreviews */ readonly shipmentId: string /** * The body of the request to `generateShipmentContentUpdatePreviews`. * @type {GenerateShipmentContentUpdatePreviewsRequest} - * @memberof FbaInboundApiGenerateShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiGenerateShipmentContentUpdatePreviews */ readonly body: GenerateShipmentContentUpdatePreviewsRequest } /** - * Request parameters for generateTransportationOptions operation in FbaInboundApi. + * Request parameters for generateTransportationOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGenerateTransportationOptionsRequest + * @interface FulfillmentInboundApiGenerateTransportationOptionsRequest */ -export interface FbaInboundApiGenerateTransportationOptionsRequest { +export interface FulfillmentInboundApiGenerateTransportationOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGenerateTransportationOptions + * @memberof FulfillmentInboundApiGenerateTransportationOptions */ readonly inboundPlanId: string /** * The body of the request to `generateTransportationOptions`. * @type {GenerateTransportationOptionsRequest} - * @memberof FbaInboundApiGenerateTransportationOptions + * @memberof FulfillmentInboundApiGenerateTransportationOptions */ readonly body: GenerateTransportationOptionsRequest } /** - * Request parameters for getDeliveryChallanDocument operation in FbaInboundApi. + * Request parameters for getDeliveryChallanDocument operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGetDeliveryChallanDocumentRequest + * @interface FulfillmentInboundApiGetDeliveryChallanDocumentRequest */ -export interface FbaInboundApiGetDeliveryChallanDocumentRequest { +export interface FulfillmentInboundApiGetDeliveryChallanDocumentRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGetDeliveryChallanDocument + * @memberof FulfillmentInboundApiGetDeliveryChallanDocument */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiGetDeliveryChallanDocument + * @memberof FulfillmentInboundApiGetDeliveryChallanDocument */ readonly shipmentId: string } /** - * Request parameters for getInboundOperationStatus operation in FbaInboundApi. + * Request parameters for getInboundOperationStatus operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGetInboundOperationStatusRequest + * @interface FulfillmentInboundApiGetInboundOperationStatusRequest */ -export interface FbaInboundApiGetInboundOperationStatusRequest { +export interface FulfillmentInboundApiGetInboundOperationStatusRequest { /** * Identifier of an asynchronous operation. * @type {string} - * @memberof FbaInboundApiGetInboundOperationStatus + * @memberof FulfillmentInboundApiGetInboundOperationStatus */ readonly operationId: string } /** - * Request parameters for getInboundPlan operation in FbaInboundApi. + * Request parameters for getInboundPlan operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGetInboundPlanRequest + * @interface FulfillmentInboundApiGetInboundPlanRequest */ -export interface FbaInboundApiGetInboundPlanRequest { +export interface FulfillmentInboundApiGetInboundPlanRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGetInboundPlan + * @memberof FulfillmentInboundApiGetInboundPlan */ readonly inboundPlanId: string } /** - * Request parameters for getSelfShipAppointmentSlots operation in FbaInboundApi. + * Request parameters for getSelfShipAppointmentSlots operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGetSelfShipAppointmentSlotsRequest + * @interface FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest */ -export interface FbaInboundApiGetSelfShipAppointmentSlotsRequest { +export interface FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGetSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiGetSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly shipmentId: string /** * The number of self ship appointment slots to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiGetSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiGetSelfShipAppointmentSlots + * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly paginationToken?: string } /** - * Request parameters for getShipment operation in FbaInboundApi. + * Request parameters for getShipment operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGetShipmentRequest + * @interface FulfillmentInboundApiGetShipmentRequest */ -export interface FbaInboundApiGetShipmentRequest { +export interface FulfillmentInboundApiGetShipmentRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGetShipment + * @memberof FulfillmentInboundApiGetShipment */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiGetShipment + * @memberof FulfillmentInboundApiGetShipment */ readonly shipmentId: string } /** - * Request parameters for getShipmentContentUpdatePreview operation in FbaInboundApi. + * Request parameters for getShipmentContentUpdatePreview operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiGetShipmentContentUpdatePreviewRequest + * @interface FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest */ -export interface FbaInboundApiGetShipmentContentUpdatePreviewRequest { +export interface FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiGetShipmentContentUpdatePreview + * @memberof FulfillmentInboundApiGetShipmentContentUpdatePreview */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiGetShipmentContentUpdatePreview + * @memberof FulfillmentInboundApiGetShipmentContentUpdatePreview */ readonly shipmentId: string /** * Identifier of a content update preview. * @type {string} - * @memberof FbaInboundApiGetShipmentContentUpdatePreview + * @memberof FulfillmentInboundApiGetShipmentContentUpdatePreview */ readonly contentUpdatePreviewId: string } /** - * Request parameters for listDeliveryWindowOptions operation in FbaInboundApi. + * Request parameters for listDeliveryWindowOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListDeliveryWindowOptionsRequest + * @interface FulfillmentInboundApiListDeliveryWindowOptionsRequest */ -export interface FbaInboundApiListDeliveryWindowOptionsRequest { +export interface FulfillmentInboundApiListDeliveryWindowOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListDeliveryWindowOptions + * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly inboundPlanId: string /** * The shipment to get delivery window options for. * @type {string} - * @memberof FbaInboundApiListDeliveryWindowOptions + * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly shipmentId: string /** * The number of delivery window options to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListDeliveryWindowOptions + * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListDeliveryWindowOptions + * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlanBoxes operation in FbaInboundApi. + * Request parameters for listInboundPlanBoxes operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListInboundPlanBoxesRequest + * @interface FulfillmentInboundApiListInboundPlanBoxesRequest */ -export interface FbaInboundApiListInboundPlanBoxesRequest { +export interface FulfillmentInboundApiListInboundPlanBoxesRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListInboundPlanBoxes + * @memberof FulfillmentInboundApiListInboundPlanBoxes */ readonly inboundPlanId: string /** * The number of boxes to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlanBoxes + * @memberof FulfillmentInboundApiListInboundPlanBoxes */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListInboundPlanBoxes + * @memberof FulfillmentInboundApiListInboundPlanBoxes */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlanItems operation in FbaInboundApi. + * Request parameters for listInboundPlanItems operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListInboundPlanItemsRequest + * @interface FulfillmentInboundApiListInboundPlanItemsRequest */ -export interface FbaInboundApiListInboundPlanItemsRequest { +export interface FulfillmentInboundApiListInboundPlanItemsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListInboundPlanItems + * @memberof FulfillmentInboundApiListInboundPlanItems */ readonly inboundPlanId: string /** * The number of items to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlanItems + * @memberof FulfillmentInboundApiListInboundPlanItems */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListInboundPlanItems + * @memberof FulfillmentInboundApiListInboundPlanItems */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlanPallets operation in FbaInboundApi. + * Request parameters for listInboundPlanPallets operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListInboundPlanPalletsRequest + * @interface FulfillmentInboundApiListInboundPlanPalletsRequest */ -export interface FbaInboundApiListInboundPlanPalletsRequest { +export interface FulfillmentInboundApiListInboundPlanPalletsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListInboundPlanPallets + * @memberof FulfillmentInboundApiListInboundPlanPallets */ readonly inboundPlanId: string /** * The number of pallets to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlanPallets + * @memberof FulfillmentInboundApiListInboundPlanPallets */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListInboundPlanPallets + * @memberof FulfillmentInboundApiListInboundPlanPallets */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlans operation in FbaInboundApi. + * Request parameters for listInboundPlans operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListInboundPlansRequest + * @interface FulfillmentInboundApiListInboundPlansRequest */ -export interface FbaInboundApiListInboundPlansRequest { +export interface FulfillmentInboundApiListInboundPlansRequest { /** * The number of inbound plans to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlans + * @memberof FulfillmentInboundApiListInboundPlans */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListInboundPlans + * @memberof FulfillmentInboundApiListInboundPlans */ readonly paginationToken?: string /** * The status of an inbound plan. * @type {'ACTIVE' | 'VOIDED' | 'SHIPPED'} - * @memberof FbaInboundApiListInboundPlans + * @memberof FulfillmentInboundApiListInboundPlans */ readonly status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED' /** * Sort by field. * @type {'LAST_UPDATED_TIME' | 'CREATION_TIME'} - * @memberof FbaInboundApiListInboundPlans + * @memberof FulfillmentInboundApiListInboundPlans */ readonly sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME' /** * The sort order. * @type {'ASC' | 'DESC'} - * @memberof FbaInboundApiListInboundPlans + * @memberof FulfillmentInboundApiListInboundPlans */ readonly sortOrder?: 'ASC' | 'DESC' } /** - * Request parameters for listItemComplianceDetails operation in FbaInboundApi. + * Request parameters for listItemComplianceDetails operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListItemComplianceDetailsRequest + * @interface FulfillmentInboundApiListItemComplianceDetailsRequest */ -export interface FbaInboundApiListItemComplianceDetailsRequest { +export interface FulfillmentInboundApiListItemComplianceDetailsRequest { /** * A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @type {Array} - * @memberof FbaInboundApiListItemComplianceDetails + * @memberof FulfillmentInboundApiListItemComplianceDetails */ readonly mskus: Array /** * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} - * @memberof FbaInboundApiListItemComplianceDetails + * @memberof FulfillmentInboundApiListItemComplianceDetails */ readonly marketplaceId: string } /** - * Request parameters for listPackingGroupBoxes operation in FbaInboundApi. + * Request parameters for listPackingGroupBoxes operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListPackingGroupBoxesRequest + * @interface FulfillmentInboundApiListPackingGroupBoxesRequest */ -export interface FbaInboundApiListPackingGroupBoxesRequest { +export interface FulfillmentInboundApiListPackingGroupBoxesRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPackingGroupBoxes + * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly inboundPlanId: string /** * Identifier of a packing group. * @type {string} - * @memberof FbaInboundApiListPackingGroupBoxes + * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly packingGroupId: string /** * The number of packing group boxes to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListPackingGroupBoxes + * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListPackingGroupBoxes + * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly paginationToken?: string } /** - * Request parameters for listPackingGroupItems operation in FbaInboundApi. + * Request parameters for listPackingGroupItems operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListPackingGroupItemsRequest + * @interface FulfillmentInboundApiListPackingGroupItemsRequest */ -export interface FbaInboundApiListPackingGroupItemsRequest { +export interface FulfillmentInboundApiListPackingGroupItemsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly inboundPlanId: string /** * Identifier of a packing group. * @type {string} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly packingGroupId: string /** * The number of packing group items to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly paginationToken?: string } /** - * Request parameters for listPackingOptions operation in FbaInboundApi. + * Request parameters for listPackingOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListPackingOptionsRequest + * @interface FulfillmentInboundApiListPackingOptionsRequest */ -export interface FbaInboundApiListPackingOptionsRequest { +export interface FulfillmentInboundApiListPackingOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPackingOptions + * @memberof FulfillmentInboundApiListPackingOptions */ readonly inboundPlanId: string /** * The number of packing options to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListPackingOptions + * @memberof FulfillmentInboundApiListPackingOptions */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListPackingOptions + * @memberof FulfillmentInboundApiListPackingOptions */ readonly paginationToken?: string } /** - * Request parameters for listPlacementOptions operation in FbaInboundApi. + * Request parameters for listPlacementOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListPlacementOptionsRequest + * @interface FulfillmentInboundApiListPlacementOptionsRequest */ -export interface FbaInboundApiListPlacementOptionsRequest { +export interface FulfillmentInboundApiListPlacementOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPlacementOptions + * @memberof FulfillmentInboundApiListPlacementOptions */ readonly inboundPlanId: string /** * The number of placement options to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListPlacementOptions + * @memberof FulfillmentInboundApiListPlacementOptions */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListPlacementOptions + * @memberof FulfillmentInboundApiListPlacementOptions */ readonly paginationToken?: string } /** - * Request parameters for listPrepDetails operation in FbaInboundApi. + * Request parameters for listPrepDetails operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListPrepDetailsRequest + * @interface FulfillmentInboundApiListPrepDetailsRequest */ -export interface FbaInboundApiListPrepDetailsRequest { +export interface FulfillmentInboundApiListPrepDetailsRequest { /** * The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} - * @memberof FbaInboundApiListPrepDetails + * @memberof FulfillmentInboundApiListPrepDetails */ readonly marketplaceId: string /** * A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @type {Array} - * @memberof FbaInboundApiListPrepDetails + * @memberof FulfillmentInboundApiListPrepDetails */ readonly mskus: Array } /** - * Request parameters for listShipmentBoxes operation in FbaInboundApi. + * Request parameters for listShipmentBoxes operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListShipmentBoxesRequest + * @interface FulfillmentInboundApiListShipmentBoxesRequest */ -export interface FbaInboundApiListShipmentBoxesRequest { +export interface FulfillmentInboundApiListShipmentBoxesRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListShipmentBoxes + * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiListShipmentBoxes + * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly shipmentId: string /** * The number of boxes to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListShipmentBoxes + * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListShipmentBoxes + * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly paginationToken?: string } /** - * Request parameters for listShipmentContentUpdatePreviews operation in FbaInboundApi. + * Request parameters for listShipmentContentUpdatePreviews operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListShipmentContentUpdatePreviewsRequest + * @interface FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest */ -export interface FbaInboundApiListShipmentContentUpdatePreviewsRequest { +export interface FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiListShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly shipmentId: string /** * The number of content update previews to return. * @type {number} - * @memberof FbaInboundApiListShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListShipmentContentUpdatePreviews + * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly paginationToken?: string } /** - * Request parameters for listShipmentItems operation in FbaInboundApi. + * Request parameters for listShipmentItems operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListShipmentItemsRequest + * @interface FulfillmentInboundApiListShipmentItemsRequest */ -export interface FbaInboundApiListShipmentItemsRequest { +export interface FulfillmentInboundApiListShipmentItemsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListShipmentItems + * @memberof FulfillmentInboundApiListShipmentItems */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiListShipmentItems + * @memberof FulfillmentInboundApiListShipmentItems */ readonly shipmentId: string /** * The number of items to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListShipmentItems + * @memberof FulfillmentInboundApiListShipmentItems */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListShipmentItems + * @memberof FulfillmentInboundApiListShipmentItems */ readonly paginationToken?: string } /** - * Request parameters for listShipmentPallets operation in FbaInboundApi. + * Request parameters for listShipmentPallets operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListShipmentPalletsRequest + * @interface FulfillmentInboundApiListShipmentPalletsRequest */ -export interface FbaInboundApiListShipmentPalletsRequest { +export interface FulfillmentInboundApiListShipmentPalletsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListShipmentPallets + * @memberof FulfillmentInboundApiListShipmentPallets */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiListShipmentPallets + * @memberof FulfillmentInboundApiListShipmentPallets */ readonly shipmentId: string /** * The number of pallets to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListShipmentPallets + * @memberof FulfillmentInboundApiListShipmentPallets */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListShipmentPallets + * @memberof FulfillmentInboundApiListShipmentPallets */ readonly paginationToken?: string } /** - * Request parameters for listTransportationOptions operation in FbaInboundApi. + * Request parameters for listTransportationOptions operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiListTransportationOptionsRequest + * @interface FulfillmentInboundApiListTransportationOptionsRequest */ -export interface FbaInboundApiListTransportationOptionsRequest { +export interface FulfillmentInboundApiListTransportationOptionsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListTransportationOptions + * @memberof FulfillmentInboundApiListTransportationOptions */ readonly inboundPlanId: string /** * The number of transportation options to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListTransportationOptions + * @memberof FulfillmentInboundApiListTransportationOptions */ readonly pageSize?: number /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} - * @memberof FbaInboundApiListTransportationOptions + * @memberof FulfillmentInboundApiListTransportationOptions */ readonly paginationToken?: string /** * The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @type {string} - * @memberof FbaInboundApiListTransportationOptions + * @memberof FulfillmentInboundApiListTransportationOptions */ readonly placementOptionId?: string /** * The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @type {string} - * @memberof FbaInboundApiListTransportationOptions + * @memberof FulfillmentInboundApiListTransportationOptions */ readonly shipmentId?: string } /** - * Request parameters for scheduleSelfShipAppointment operation in FbaInboundApi. + * Request parameters for scheduleSelfShipAppointment operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiScheduleSelfShipAppointmentRequest + * @interface FulfillmentInboundApiScheduleSelfShipAppointmentRequest */ -export interface FbaInboundApiScheduleSelfShipAppointmentRequest { +export interface FulfillmentInboundApiScheduleSelfShipAppointmentRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiScheduleSelfShipAppointment + * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiScheduleSelfShipAppointment + * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly shipmentId: string /** * An identifier to a self-ship appointment slot. * @type {string} - * @memberof FbaInboundApiScheduleSelfShipAppointment + * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly slotId: string /** * The body of the request to `scheduleSelfShipAppointment`. * @type {ScheduleSelfShipAppointmentRequest} - * @memberof FbaInboundApiScheduleSelfShipAppointment + * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly body: ScheduleSelfShipAppointmentRequest } /** - * Request parameters for setPackingInformation operation in FbaInboundApi. + * Request parameters for setPackingInformation operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiSetPackingInformationRequest + * @interface FulfillmentInboundApiSetPackingInformationRequest */ -export interface FbaInboundApiSetPackingInformationRequest { +export interface FulfillmentInboundApiSetPackingInformationRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiSetPackingInformation + * @memberof FulfillmentInboundApiSetPackingInformation */ readonly inboundPlanId: string /** * The body of the request to `setPackingInformation`. * @type {SetPackingInformationRequest} - * @memberof FbaInboundApiSetPackingInformation + * @memberof FulfillmentInboundApiSetPackingInformation */ readonly body: SetPackingInformationRequest } /** - * Request parameters for setPrepDetails operation in FbaInboundApi. + * Request parameters for setPrepDetails operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiSetPrepDetailsRequest + * @interface FulfillmentInboundApiSetPrepDetailsRequest */ -export interface FbaInboundApiSetPrepDetailsRequest { +export interface FulfillmentInboundApiSetPrepDetailsRequest { /** * The body of the request to `setPrepDetails`. * @type {SetPrepDetailsRequest} - * @memberof FbaInboundApiSetPrepDetails + * @memberof FulfillmentInboundApiSetPrepDetails */ readonly body: SetPrepDetailsRequest } /** - * Request parameters for updateInboundPlanName operation in FbaInboundApi. + * Request parameters for updateInboundPlanName operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiUpdateInboundPlanNameRequest + * @interface FulfillmentInboundApiUpdateInboundPlanNameRequest */ -export interface FbaInboundApiUpdateInboundPlanNameRequest { +export interface FulfillmentInboundApiUpdateInboundPlanNameRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiUpdateInboundPlanName + * @memberof FulfillmentInboundApiUpdateInboundPlanName */ readonly inboundPlanId: string /** * The body of the request to `updateInboundPlanName`. * @type {UpdateInboundPlanNameRequest} - * @memberof FbaInboundApiUpdateInboundPlanName + * @memberof FulfillmentInboundApiUpdateInboundPlanName */ readonly body: UpdateInboundPlanNameRequest } /** - * Request parameters for updateItemComplianceDetails operation in FbaInboundApi. + * Request parameters for updateItemComplianceDetails operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiUpdateItemComplianceDetailsRequest + * @interface FulfillmentInboundApiUpdateItemComplianceDetailsRequest */ -export interface FbaInboundApiUpdateItemComplianceDetailsRequest { +export interface FulfillmentInboundApiUpdateItemComplianceDetailsRequest { /** * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} - * @memberof FbaInboundApiUpdateItemComplianceDetails + * @memberof FulfillmentInboundApiUpdateItemComplianceDetails */ readonly marketplaceId: string /** * The body of the request to `updateItemComplianceDetails`. * @type {UpdateItemComplianceDetailsRequest} - * @memberof FbaInboundApiUpdateItemComplianceDetails + * @memberof FulfillmentInboundApiUpdateItemComplianceDetails */ readonly body: UpdateItemComplianceDetailsRequest } /** - * Request parameters for updateShipmentName operation in FbaInboundApi. + * Request parameters for updateShipmentName operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiUpdateShipmentNameRequest + * @interface FulfillmentInboundApiUpdateShipmentNameRequest */ -export interface FbaInboundApiUpdateShipmentNameRequest { +export interface FulfillmentInboundApiUpdateShipmentNameRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiUpdateShipmentName + * @memberof FulfillmentInboundApiUpdateShipmentName */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiUpdateShipmentName + * @memberof FulfillmentInboundApiUpdateShipmentName */ readonly shipmentId: string /** * The body of the request to `updateShipmentName`. * @type {UpdateShipmentNameRequest} - * @memberof FbaInboundApiUpdateShipmentName + * @memberof FulfillmentInboundApiUpdateShipmentName */ readonly body: UpdateShipmentNameRequest } /** - * Request parameters for updateShipmentSourceAddress operation in FbaInboundApi. + * Request parameters for updateShipmentSourceAddress operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiUpdateShipmentSourceAddressRequest + * @interface FulfillmentInboundApiUpdateShipmentSourceAddressRequest */ -export interface FbaInboundApiUpdateShipmentSourceAddressRequest { +export interface FulfillmentInboundApiUpdateShipmentSourceAddressRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiUpdateShipmentSourceAddress + * @memberof FulfillmentInboundApiUpdateShipmentSourceAddress */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiUpdateShipmentSourceAddress + * @memberof FulfillmentInboundApiUpdateShipmentSourceAddress */ readonly shipmentId: string /** * The body of the request to `updateShipmentSourceAddress`. * @type {UpdateShipmentSourceAddressRequest} - * @memberof FbaInboundApiUpdateShipmentSourceAddress + * @memberof FulfillmentInboundApiUpdateShipmentSourceAddress */ readonly body: UpdateShipmentSourceAddressRequest } /** - * Request parameters for updateShipmentTrackingDetails operation in FbaInboundApi. + * Request parameters for updateShipmentTrackingDetails operation in FulfillmentInboundApi. * @export - * @interface FbaInboundApiUpdateShipmentTrackingDetailsRequest + * @interface FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest */ -export interface FbaInboundApiUpdateShipmentTrackingDetailsRequest { +export interface FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest { /** * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiUpdateShipmentTrackingDetails + * @memberof FulfillmentInboundApiUpdateShipmentTrackingDetails */ readonly inboundPlanId: string /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiUpdateShipmentTrackingDetails + * @memberof FulfillmentInboundApiUpdateShipmentTrackingDetails */ readonly shipmentId: string /** * The body of the request to `updateShipmentTrackingDetails`. * @type {UpdateShipmentTrackingDetailsRequest} - * @memberof FbaInboundApiUpdateShipmentTrackingDetails + * @memberof FulfillmentInboundApiUpdateShipmentTrackingDetails */ readonly body: UpdateShipmentTrackingDetailsRequest } /** - * FbaInboundApi - object-oriented interface + * FulfillmentInboundApi - object-oriented interface * @export - * @class FbaInboundApi + * @class FulfillmentInboundApi * @extends {BaseAPI} */ -export class FbaInboundApi extends BaseAPI { +export class FulfillmentInboundApi extends BaseAPI { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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 {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters. + * @summary cancelInboundPlan + * @param {FulfillmentInboundApiCancelInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public cancelInboundPlan(requestParameters: FbaInboundApiCancelInboundPlanRequest, options?: any) { - return FbaInboundApiFp(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath)); + public cancelInboundPlan(requestParameters: FulfillmentInboundApiCancelInboundPlanRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath)); } /** * Cancels a self-ship appointment slot against a shipment. **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 preceding table contains 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 {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters. + * @summary cancelSelfShipAppointment + * @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public cancelSelfShipAppointment(requestParameters: FbaInboundApiCancelSelfShipAppointmentRequest, options?: any) { - return FbaInboundApiFp(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public cancelSelfShipAppointment(requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **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 preceding table contains 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 {FbaInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters. + * @summary confirmDeliveryWindowOptions + * @param {FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public confirmDeliveryWindowOptions(requestParameters: FbaInboundApiConfirmDeliveryWindowOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).confirmDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.deliveryWindowOptionId, options).then((request) => request(this.axios, this.basePath)); + public confirmDeliveryWindowOptions(requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).confirmDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.deliveryWindowOptionId, options).then((request) => request(this.axios, this.basePath)); } /** * Confirms the packing option for an inbound plan. **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 preceding table contains 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 {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters. + * @summary confirmPackingOption + * @param {FulfillmentInboundApiConfirmPackingOptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public confirmPackingOption(requestParameters: FbaInboundApiConfirmPackingOptionRequest, options?: any) { - return FbaInboundApiFp(this.configuration).confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(this.axios, this.basePath)); + public confirmPackingOption(requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(this.axios, this.basePath)); } /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **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 preceding table contains 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 {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters. + * @summary confirmPlacementOption + * @param {FulfillmentInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public confirmPlacementOption(requestParameters: FbaInboundApiConfirmPlacementOptionRequest, options?: any) { - return FbaInboundApiFp(this.configuration).confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(this.axios, this.basePath)); + public confirmPlacementOption(requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(this.axios, this.basePath)); } /** * Confirm a shipment content update preview and accept the changes in transportation cost. **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 preceding table contains 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 {FbaInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters. + * @summary confirmShipmentContentUpdatePreview + * @param {FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public confirmShipmentContentUpdatePreview(requestParameters: FbaInboundApiConfirmShipmentContentUpdatePreviewRequest, options?: any) { - return FbaInboundApiFp(this.configuration).confirmShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath)); + public confirmShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).confirmShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath)); } /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **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 preceding table contains 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 {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters. + * @summary confirmTransportationOptions + * @param {FulfillmentInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public confirmTransportationOptions(requestParameters: FbaInboundApiConfirmTransportationOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public confirmTransportationOptions(requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **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 preceding table contains 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 {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters. + * @summary createInboundPlan + * @param {FulfillmentInboundApiCreateInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public createInboundPlan(requestParameters: FbaInboundApiCreateInboundPlanRequest, options?: any) { - return FbaInboundApiFp(this.configuration).createInboundPlan(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public createInboundPlan(requestParameters: FulfillmentInboundApiCreateInboundPlanRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).createInboundPlan(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * For a given marketplace - creates labels for a list of MSKUs. **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 preceding table contains 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 {FbaInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters. + * @summary createMarketplaceItemLabels + * @param {FulfillmentInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public createMarketplaceItemLabels(requestParameters: FbaInboundApiCreateMarketplaceItemLabelsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).createMarketplaceItemLabels(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public createMarketplaceItemLabels(requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).createMarketplaceItemLabels(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Generates available delivery window options for a given shipment. **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 preceding table contains 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 {FbaInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters. + * @summary generateDeliveryWindowOptions + * @param {FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public generateDeliveryWindowOptions(requestParameters: FbaInboundApiGenerateDeliveryWindowOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).generateDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); + public generateDeliveryWindowOptions(requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).generateDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); } /** * Generates available packing options for the inbound plan. **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 preceding table contains 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 {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters. + * @summary generatePackingOptions + * @param {FulfillmentInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public generatePackingOptions(requestParameters: FbaInboundApiGeneratePackingOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath)); + public generatePackingOptions(requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath)); } /** * Generates placement options for the inbound plan. **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 preceding table contains 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 {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters. + * @summary generatePlacementOptions + * @param {FulfillmentInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public generatePlacementOptions(requestParameters: FbaInboundApiGeneratePlacementOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public generatePlacementOptions(requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Initiates the process of generating the appointment slots list. **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 preceding table contains 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 {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters. + * @summary generateSelfShipAppointmentSlots + * @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public generateSelfShipAppointmentSlots(requestParameters: FbaInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public generateSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **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 preceding table contains 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 {FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. + * @summary generateShipmentContentUpdatePreviews + * @param {FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public generateShipmentContentUpdatePreviews(requestParameters: FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).generateShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public generateShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).generateShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Generates available transportation options for a given placement option. **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 preceding table contains 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 {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters. + * @summary generateTransportationOptions + * @param {FulfillmentInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public generateTransportationOptions(requestParameters: FbaInboundApiGenerateTransportationOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public generateTransportationOptions(requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters. + * @summary getDeliveryChallanDocument + * @param {FulfillmentInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public getDeliveryChallanDocument(requestParameters: FbaInboundApiGetDeliveryChallanDocumentRequest, options?: any) { - return FbaInboundApiFp(this.configuration).getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); + public getDeliveryChallanDocument(requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); } /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters. + * @summary getInboundOperationStatus + * @param {FulfillmentInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public getInboundOperationStatus(requestParameters: FbaInboundApiGetInboundOperationStatusRequest, options?: any) { - return FbaInboundApiFp(this.configuration).getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(this.axios, this.basePath)); + public getInboundOperationStatus(requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters. + * @summary getInboundPlan + * @param {FulfillmentInboundApiGetInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public getInboundPlan(requestParameters: FbaInboundApiGetInboundPlanRequest, options?: any) { - return FbaInboundApiFp(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath)); + public getInboundPlan(requestParameters: FulfillmentInboundApiGetInboundPlanRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters. + * @summary getSelfShipAppointmentSlots + * @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public getSelfShipAppointmentSlots(requestParameters: FbaInboundApiGetSelfShipAppointmentSlotsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public getSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiGetShipmentRequest} requestParameters Request parameters. + * @summary getShipment + * @param {FulfillmentInboundApiGetShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public getShipment(requestParameters: FbaInboundApiGetShipmentRequest, options?: any) { - return FbaInboundApiFp(this.configuration).getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); + public getShipment(requestParameters: FulfillmentInboundApiGetShipmentRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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 {FbaInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters. + * @summary getShipmentContentUpdatePreview + * @param {FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public getShipmentContentUpdatePreview(requestParameters: FbaInboundApiGetShipmentContentUpdatePreviewRequest, options?: any) { - return FbaInboundApiFp(this.configuration).getShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath)); + public getShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).getShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **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 preceding table contains 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 {FbaInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters. + * @summary listDeliveryWindowOptions + * @param {FulfillmentInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listDeliveryWindowOptions(requestParameters: FbaInboundApiListDeliveryWindowOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listDeliveryWindowOptions(requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters. + * @summary listInboundPlanBoxes + * @param {FulfillmentInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listInboundPlanBoxes(requestParameters: FbaInboundApiListInboundPlanBoxesRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listInboundPlanBoxes(requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters. + * @summary listInboundPlanItems + * @param {FulfillmentInboundApiListInboundPlanItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listInboundPlanItems(requestParameters: FbaInboundApiListInboundPlanItemsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listInboundPlanItems(requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters. + * @summary listInboundPlanPallets + * @param {FulfillmentInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listInboundPlanPallets(requestParameters: FbaInboundApiListInboundPlanPalletsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listInboundPlanPallets(requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters. + * @summary listInboundPlans + * @param {FulfillmentInboundApiListInboundPlansRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listInboundPlans(requestParameters: FbaInboundApiListInboundPlansRequest = {}, options?: any) { - return FbaInboundApiFp(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath)); + public listInboundPlans(requestParameters: FulfillmentInboundApiListInboundPlansRequest = {}, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath)); } /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters. + * @summary listItemComplianceDetails + * @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listItemComplianceDetails(requestParameters: FbaInboundApiListItemComplianceDetailsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath)); + public listItemComplianceDetails(requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **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 preceding table contains 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 {FbaInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters. + * @summary listPackingGroupBoxes + * @param {FulfillmentInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listPackingGroupBoxes(requestParameters: FbaInboundApiListPackingGroupBoxesRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listPackingGroupBoxes(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listPackingGroupBoxes(requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listPackingGroupBoxes(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **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 preceding table contains 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 {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters. + * @summary listPackingGroupItems + * @param {FulfillmentInboundApiListPackingGroupItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listPackingGroupItems(requestParameters: FbaInboundApiListPackingGroupItemsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listPackingGroupItems(requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters. + * @summary listPackingOptions + * @param {FulfillmentInboundApiListPackingOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listPackingOptions(requestParameters: FbaInboundApiListPackingOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listPackingOptions(requestParameters: FulfillmentInboundApiListPackingOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters. + * @summary listPlacementOptions + * @param {FulfillmentInboundApiListPlacementOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listPlacementOptions(requestParameters: FbaInboundApiListPlacementOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listPlacementOptions(requestParameters: FulfillmentInboundApiListPlacementOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Get preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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 {FbaInboundApiListPrepDetailsRequest} requestParameters Request parameters. + * @summary listPrepDetails + * @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listPrepDetails(requestParameters: FbaInboundApiListPrepDetailsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listPrepDetails(requestParameters.marketplaceId, requestParameters.mskus, options).then((request) => request(this.axios, this.basePath)); + public listPrepDetails(requestParameters: FulfillmentInboundApiListPrepDetailsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listPrepDetails(requestParameters.marketplaceId, requestParameters.mskus, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a paginated list of box packages in a shipment. **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 preceding table contains 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 {FbaInboundApiListShipmentBoxesRequest} requestParameters Request parameters. + * @summary listShipmentBoxes + * @param {FulfillmentInboundApiListShipmentBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listShipmentBoxes(requestParameters: FbaInboundApiListShipmentBoxesRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listShipmentBoxes(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listShipmentBoxes(requestParameters: FulfillmentInboundApiListShipmentBoxesRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listShipmentBoxes(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **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 preceding table contains 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 {FbaInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. + * @summary listShipmentContentUpdatePreviews + * @param {FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listShipmentContentUpdatePreviews(requestParameters: FbaInboundApiListShipmentContentUpdatePreviewsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a paginated list of item packages in a shipment. **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 preceding table contains 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 {FbaInboundApiListShipmentItemsRequest} requestParameters Request parameters. + * @summary listShipmentItems + * @param {FulfillmentInboundApiListShipmentItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listShipmentItems(requestParameters: FbaInboundApiListShipmentItemsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listShipmentItems(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listShipmentItems(requestParameters: FulfillmentInboundApiListShipmentItemsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listShipmentItems(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **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 preceding table contains 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 {FbaInboundApiListShipmentPalletsRequest} requestParameters Request parameters. + * @summary listShipmentPallets + * @param {FulfillmentInboundApiListShipmentPalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listShipmentPallets(requestParameters: FbaInboundApiListShipmentPalletsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listShipmentPallets(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + public listShipmentPallets(requestParameters: FulfillmentInboundApiListShipmentPalletsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listShipmentPallets(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); } /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters. + * @summary listTransportationOptions + * @param {FulfillmentInboundApiListTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public listTransportationOptions(requestParameters: FbaInboundApiListTransportationOptionsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); + public listTransportationOptions(requestParameters: FulfillmentInboundApiListTransportationOptionsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); } /** * Confirms or reschedules a self-ship appointment slot against a 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 preceding table contains 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 {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters. + * @summary scheduleSelfShipAppointment + * @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public scheduleSelfShipAppointment(requestParameters: FbaInboundApiScheduleSelfShipAppointmentRequest, options?: any) { - return FbaInboundApiFp(this.configuration).scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public scheduleSelfShipAppointment(requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **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 preceding table contains 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 {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters. + * @summary setPackingInformation + * @param {FulfillmentInboundApiSetPackingInformationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public setPackingInformation(requestParameters: FbaInboundApiSetPackingInformationRequest, options?: any) { - return FbaInboundApiFp(this.configuration).setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public setPackingInformation(requestParameters: FulfillmentInboundApiSetPackingInformationRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Set the preparation details for a list of MSKUs in a specified marketplace. **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 preceding table contains 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 {FbaInboundApiSetPrepDetailsRequest} requestParameters Request parameters. + * @summary setPrepDetails + * @param {FulfillmentInboundApiSetPrepDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public setPrepDetails(requestParameters: FbaInboundApiSetPrepDetailsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).setPrepDetails(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public setPrepDetails(requestParameters: FulfillmentInboundApiSetPrepDetailsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).setPrepDetails(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Updates the name of an existing inbound plan. **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 preceding table contains 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 {FbaInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters. + * @summary updateInboundPlanName + * @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public updateInboundPlanName(requestParameters: FbaInboundApiUpdateInboundPlanNameRequest, options?: any) { - return FbaInboundApiFp(this.configuration).updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public updateInboundPlanName(requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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 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 {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters. + * @summary updateItemComplianceDetails + * @param {FulfillmentInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public updateItemComplianceDetails(requestParameters: FbaInboundApiUpdateItemComplianceDetailsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public updateItemComplianceDetails(requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Updates the name of an existing shipment. **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 preceding table contains 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 {FbaInboundApiUpdateShipmentNameRequest} requestParameters Request parameters. + * @summary updateShipmentName + * @param {FulfillmentInboundApiUpdateShipmentNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public updateShipmentName(requestParameters: FbaInboundApiUpdateShipmentNameRequest, options?: any) { - return FbaInboundApiFp(this.configuration).updateShipmentName(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public updateShipmentName(requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).updateShipmentName(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source 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 preceding table contains 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 {FbaInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters. + * @summary updateShipmentSourceAddress + * @param {FulfillmentInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public updateShipmentSourceAddress(requestParameters: FbaInboundApiUpdateShipmentSourceAddressRequest, options?: any) { - return FbaInboundApiFp(this.configuration).updateShipmentSourceAddress(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public updateShipmentSourceAddress(requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).updateShipmentSourceAddress(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Updates a shipment\'s tracking details. **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 preceding table contains 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 {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters. + * @summary updateShipmentTrackingDetails + * @param {FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FbaInboundApi + * @memberof FulfillmentInboundApi */ - public updateShipmentTrackingDetails(requestParameters: FbaInboundApiUpdateShipmentTrackingDetailsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).updateShipmentTrackingDetails(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public updateShipmentTrackingDetails(requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest, options?: any) { + return FulfillmentInboundApiFp(this.configuration).updateShipmentTrackingDetails(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/api-models/fulfillment-inbound-api-model-v20240320/base.ts b/src/api-models/fulfillment-inbound-api-model-v20240320/base.ts index 55fc619c..1e70abe4 100644 --- a/src/api-models/fulfillment-inbound-api-model-v20240320/base.ts +++ b/src/api-models/fulfillment-inbound-api-model-v20240320/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for FBA inbound operations. + * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 diff --git a/src/api-models/fulfillment-inbound-api-model-v20240320/common.ts b/src/api-models/fulfillment-inbound-api-model-v20240320/common.ts index a7d6ccdc..666df152 100644 --- a/src/api-models/fulfillment-inbound-api-model-v20240320/common.ts +++ b/src/api-models/fulfillment-inbound-api-model-v20240320/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for FBA inbound operations. + * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 diff --git a/src/api-models/fulfillment-inbound-api-model-v20240320/configuration.ts b/src/api-models/fulfillment-inbound-api-model-v20240320/configuration.ts index 928f1f0e..bc160559 100644 --- a/src/api-models/fulfillment-inbound-api-model-v20240320/configuration.ts +++ b/src/api-models/fulfillment-inbound-api-model-v20240320/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for FBA inbound operations. + * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 diff --git a/src/api-models/fulfillment-inbound-api-model-v20240320/index.ts b/src/api-models/fulfillment-inbound-api-model-v20240320/index.ts index ca40c72a..8359a2a3 100644 --- a/src/api-models/fulfillment-inbound-api-model-v20240320/index.ts +++ b/src/api-models/fulfillment-inbound-api-model-v20240320/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * The Selling Partner API for FBA inbound operations. + * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 diff --git a/src/api-models/fulfillment-outbound-api-model/api.ts b/src/api-models/fulfillment-outbound-api-model/api.ts index 75caad10..b0056a04 100644 --- a/src/api-models/fulfillment-outbound-api-model/api.ts +++ b/src/api-models/fulfillment-outbound-api-model/api.ts @@ -618,7 +618,7 @@ export interface DeliveryPolicy { message?: DeliveryMessage; } /** - * The delivery preferences applied to the destination address. These preferences will be applied when possible and are best effort. This feature is currently supported only in the JP marketplace and not applicable for other marketplaces. + * The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort. This feature is currently supported only in the JP marketplace and not applicable for other marketplaces. For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise. * @export * @interface DeliveryPreferences */ @@ -2349,7 +2349,7 @@ export interface ScheduledDeliveryInfo { deliveryWindows: Array; } /** - * The shipping method used for the fulfillment order. When this value is `ScheduledDelivery`, choose Ship for the `fulfillmentAction`. Hold is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. + * The shipping method used for the fulfillment order. When this value is `ScheduledDelivery`, choose `Ship` for the `fulfillmentAction`. `Hold` is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the [Seller Central](https://developer-docs.amazon.com/sp-api/docs/seller-central-urls) website in their marketplace for shipping method service level agreements and fulfillment fees. * @export * @enum {string} */ diff --git a/src/api-models/index.ts b/src/api-models/index.ts index 3d65d227..8ea8f2e1 100644 --- a/src/api-models/index.ts +++ b/src/api-models/index.ts @@ -216,8 +216,8 @@ export { ModelError as CatalogItemsApiModelV20220401ModelError, Pagination as CatalogItemsApiModelV20220401Pagination, Refinements as CatalogItemsApiModelV20220401Refinements, - CatalogApiGetCatalogItemRequest as CatalogItemsApiModelV20220401CatalogApiGetCatalogItemRequest, - CatalogApiSearchCatalogItemsRequest as CatalogItemsApiModelV20220401CatalogApiSearchCatalogItemsRequest, + CatalogItemsApiGetCatalogItemRequest as CatalogItemsApiModelV20220401CatalogItemsApiGetCatalogItemRequest, + CatalogItemsApiSearchCatalogItemsRequest as CatalogItemsApiModelV20220401CatalogItemsApiSearchCatalogItemsRequest, } from './catalog-items-api-model-v20220401' export { QueryProcessingStatusEnum as DataKioskApiModelQueryProcessingStatusEnum, @@ -669,51 +669,51 @@ export { Weight as FulfillmentInboundApiModelV20240320Weight, Window as FulfillmentInboundApiModelV20240320Window, WindowInput as FulfillmentInboundApiModelV20240320WindowInput, - FbaInboundApiCancelInboundPlanRequest as FulfillmentInboundApiModelV20240320FbaInboundApiCancelInboundPlanRequest, - FbaInboundApiCancelSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320FbaInboundApiCancelSelfShipAppointmentRequest, - FbaInboundApiConfirmDeliveryWindowOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiConfirmDeliveryWindowOptionsRequest, - FbaInboundApiConfirmPackingOptionRequest as FulfillmentInboundApiModelV20240320FbaInboundApiConfirmPackingOptionRequest, - FbaInboundApiConfirmPlacementOptionRequest as FulfillmentInboundApiModelV20240320FbaInboundApiConfirmPlacementOptionRequest, - FbaInboundApiConfirmShipmentContentUpdatePreviewRequest as FulfillmentInboundApiModelV20240320FbaInboundApiConfirmShipmentContentUpdatePreviewRequest, - FbaInboundApiConfirmTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiConfirmTransportationOptionsRequest, - FbaInboundApiCreateInboundPlanRequest as FulfillmentInboundApiModelV20240320FbaInboundApiCreateInboundPlanRequest, - FbaInboundApiCreateMarketplaceItemLabelsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiCreateMarketplaceItemLabelsRequest, - FbaInboundApiGenerateDeliveryWindowOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGenerateDeliveryWindowOptionsRequest, - FbaInboundApiGeneratePackingOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGeneratePackingOptionsRequest, - FbaInboundApiGeneratePlacementOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGeneratePlacementOptionsRequest, - FbaInboundApiGenerateSelfShipAppointmentSlotsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGenerateSelfShipAppointmentSlotsRequest, - FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest, - FbaInboundApiGenerateTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGenerateTransportationOptionsRequest, - FbaInboundApiGetDeliveryChallanDocumentRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGetDeliveryChallanDocumentRequest, - FbaInboundApiGetInboundOperationStatusRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGetInboundOperationStatusRequest, - FbaInboundApiGetInboundPlanRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGetInboundPlanRequest, - FbaInboundApiGetSelfShipAppointmentSlotsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGetSelfShipAppointmentSlotsRequest, - FbaInboundApiGetShipmentRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGetShipmentRequest, - FbaInboundApiGetShipmentContentUpdatePreviewRequest as FulfillmentInboundApiModelV20240320FbaInboundApiGetShipmentContentUpdatePreviewRequest, - FbaInboundApiListDeliveryWindowOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListDeliveryWindowOptionsRequest, - FbaInboundApiListInboundPlanBoxesRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListInboundPlanBoxesRequest, - FbaInboundApiListInboundPlanItemsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListInboundPlanItemsRequest, - FbaInboundApiListInboundPlanPalletsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListInboundPlanPalletsRequest, - FbaInboundApiListInboundPlansRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListInboundPlansRequest, - FbaInboundApiListItemComplianceDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListItemComplianceDetailsRequest, - FbaInboundApiListPackingGroupBoxesRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListPackingGroupBoxesRequest, - FbaInboundApiListPackingGroupItemsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListPackingGroupItemsRequest, - FbaInboundApiListPackingOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListPackingOptionsRequest, - FbaInboundApiListPlacementOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListPlacementOptionsRequest, - FbaInboundApiListPrepDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListPrepDetailsRequest, - FbaInboundApiListShipmentBoxesRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentBoxesRequest, - FbaInboundApiListShipmentContentUpdatePreviewsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentContentUpdatePreviewsRequest, - FbaInboundApiListShipmentItemsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentItemsRequest, - FbaInboundApiListShipmentPalletsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentPalletsRequest, - FbaInboundApiListTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListTransportationOptionsRequest, - FbaInboundApiScheduleSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320FbaInboundApiScheduleSelfShipAppointmentRequest, - FbaInboundApiSetPackingInformationRequest as FulfillmentInboundApiModelV20240320FbaInboundApiSetPackingInformationRequest, - FbaInboundApiSetPrepDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiSetPrepDetailsRequest, - FbaInboundApiUpdateInboundPlanNameRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateInboundPlanNameRequest, - FbaInboundApiUpdateItemComplianceDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateItemComplianceDetailsRequest, - FbaInboundApiUpdateShipmentNameRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentNameRequest, - FbaInboundApiUpdateShipmentSourceAddressRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentSourceAddressRequest, - FbaInboundApiUpdateShipmentTrackingDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentTrackingDetailsRequest, + FulfillmentInboundApiCancelInboundPlanRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiCancelInboundPlanRequest, + FulfillmentInboundApiCancelSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiCancelSelfShipAppointmentRequest, + FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest, + FulfillmentInboundApiConfirmPackingOptionRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiConfirmPackingOptionRequest, + FulfillmentInboundApiConfirmPlacementOptionRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiConfirmPlacementOptionRequest, + FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest, + FulfillmentInboundApiConfirmTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiConfirmTransportationOptionsRequest, + FulfillmentInboundApiCreateInboundPlanRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiCreateInboundPlanRequest, + FulfillmentInboundApiCreateMarketplaceItemLabelsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiCreateMarketplaceItemLabelsRequest, + FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest, + FulfillmentInboundApiGeneratePackingOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGeneratePackingOptionsRequest, + FulfillmentInboundApiGeneratePlacementOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGeneratePlacementOptionsRequest, + FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest, + FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest, + FulfillmentInboundApiGenerateTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGenerateTransportationOptionsRequest, + FulfillmentInboundApiGetDeliveryChallanDocumentRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGetDeliveryChallanDocumentRequest, + FulfillmentInboundApiGetInboundOperationStatusRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGetInboundOperationStatusRequest, + FulfillmentInboundApiGetInboundPlanRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGetInboundPlanRequest, + FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest, + FulfillmentInboundApiGetShipmentRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGetShipmentRequest, + FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest, + FulfillmentInboundApiListDeliveryWindowOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListDeliveryWindowOptionsRequest, + FulfillmentInboundApiListInboundPlanBoxesRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListInboundPlanBoxesRequest, + FulfillmentInboundApiListInboundPlanItemsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListInboundPlanItemsRequest, + FulfillmentInboundApiListInboundPlanPalletsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListInboundPlanPalletsRequest, + FulfillmentInboundApiListInboundPlansRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListInboundPlansRequest, + FulfillmentInboundApiListItemComplianceDetailsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListItemComplianceDetailsRequest, + FulfillmentInboundApiListPackingGroupBoxesRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListPackingGroupBoxesRequest, + FulfillmentInboundApiListPackingGroupItemsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListPackingGroupItemsRequest, + FulfillmentInboundApiListPackingOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListPackingOptionsRequest, + FulfillmentInboundApiListPlacementOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListPlacementOptionsRequest, + FulfillmentInboundApiListPrepDetailsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListPrepDetailsRequest, + FulfillmentInboundApiListShipmentBoxesRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListShipmentBoxesRequest, + FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest, + FulfillmentInboundApiListShipmentItemsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListShipmentItemsRequest, + FulfillmentInboundApiListShipmentPalletsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListShipmentPalletsRequest, + FulfillmentInboundApiListTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiListTransportationOptionsRequest, + FulfillmentInboundApiScheduleSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiScheduleSelfShipAppointmentRequest, + FulfillmentInboundApiSetPackingInformationRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiSetPackingInformationRequest, + FulfillmentInboundApiSetPrepDetailsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiSetPrepDetailsRequest, + FulfillmentInboundApiUpdateInboundPlanNameRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiUpdateInboundPlanNameRequest, + FulfillmentInboundApiUpdateItemComplianceDetailsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiUpdateItemComplianceDetailsRequest, + FulfillmentInboundApiUpdateShipmentNameRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiUpdateShipmentNameRequest, + FulfillmentInboundApiUpdateShipmentSourceAddressRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiUpdateShipmentSourceAddressRequest, + FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest as FulfillmentInboundApiModelV20240320FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest, } from './fulfillment-inbound-api-model-v20240320' export { AdditionalLocationInfo as FulfillmentOutboundApiModelAdditionalLocationInfo, @@ -900,11 +900,10 @@ export { Pagination as ListingsItemsApiModelV20210801Pagination, PatchOperation as ListingsItemsApiModelV20210801PatchOperation, Points as ListingsItemsApiModelV20210801Points, - ListingsApiDeleteListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiDeleteListingsItemRequest, - ListingsApiGetListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiGetListingsItemRequest, - ListingsApiPatchListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiPatchListingsItemRequest, - ListingsApiPutListingsItemRequest as ListingsItemsApiModelV20210801ListingsApiPutListingsItemRequest, - ListingsApiSearchListingsItemsRequest as ListingsItemsApiModelV20210801ListingsApiSearchListingsItemsRequest, + ListingsItemsApiDeleteListingsItemRequest as ListingsItemsApiModelV20210801ListingsItemsApiDeleteListingsItemRequest, + ListingsItemsApiGetListingsItemRequest as ListingsItemsApiModelV20210801ListingsItemsApiGetListingsItemRequest, + ListingsItemsApiPatchListingsItemRequest as ListingsItemsApiModelV20210801ListingsItemsApiPatchListingsItemRequest, + ListingsItemsApiPutListingsItemRequest as ListingsItemsApiModelV20210801ListingsItemsApiPutListingsItemRequest, } from './listings-items-api-model-v20210801' export { LinkVerbEnum as ListingsRestrictionsApiModelLinkVerbEnum, @@ -1155,16 +1154,16 @@ export { UpdateVerificationStatusRequestBody as OrdersApiModelUpdateVerificationStatusRequestBody, ValidVerificationDetail as OrdersApiModelValidVerificationDetail, VerificationDetails as OrdersApiModelVerificationDetails, - OrdersV0ApiConfirmShipmentRequest as OrdersApiModelOrdersV0ApiConfirmShipmentRequest, - OrdersV0ApiGetOrderRequest as OrdersApiModelOrdersV0ApiGetOrderRequest, - OrdersV0ApiGetOrderAddressRequest as OrdersApiModelOrdersV0ApiGetOrderAddressRequest, - OrdersV0ApiGetOrderBuyerInfoRequest as OrdersApiModelOrdersV0ApiGetOrderBuyerInfoRequest, - OrdersV0ApiGetOrderItemsRequest as OrdersApiModelOrdersV0ApiGetOrderItemsRequest, - OrdersV0ApiGetOrderItemsBuyerInfoRequest as OrdersApiModelOrdersV0ApiGetOrderItemsBuyerInfoRequest, - OrdersV0ApiGetOrderRegulatedInfoRequest as OrdersApiModelOrdersV0ApiGetOrderRegulatedInfoRequest, - OrdersV0ApiGetOrdersRequest as OrdersApiModelOrdersV0ApiGetOrdersRequest, - OrdersV0ApiUpdateVerificationStatusRequest as OrdersApiModelOrdersV0ApiUpdateVerificationStatusRequest, - ShipmentApiUpdateShipmentStatusRequest as OrdersApiModelShipmentApiUpdateShipmentStatusRequest, + OrdersApiConfirmShipmentRequest as OrdersApiModelOrdersApiConfirmShipmentRequest, + OrdersApiGetOrderRequest as OrdersApiModelOrdersApiGetOrderRequest, + OrdersApiGetOrderAddressRequest as OrdersApiModelOrdersApiGetOrderAddressRequest, + OrdersApiGetOrderBuyerInfoRequest as OrdersApiModelOrdersApiGetOrderBuyerInfoRequest, + OrdersApiGetOrderItemsRequest as OrdersApiModelOrdersApiGetOrderItemsRequest, + OrdersApiGetOrderItemsBuyerInfoRequest as OrdersApiModelOrdersApiGetOrderItemsBuyerInfoRequest, + OrdersApiGetOrderRegulatedInfoRequest as OrdersApiModelOrdersApiGetOrderRegulatedInfoRequest, + OrdersApiGetOrdersRequest as OrdersApiModelOrdersApiGetOrdersRequest, + OrdersApiUpdateShipmentStatusRequest as OrdersApiModelOrdersApiUpdateShipmentStatusRequest, + OrdersApiUpdateVerificationStatusRequest as OrdersApiModelOrdersApiUpdateVerificationStatusRequest, } from './orders-api-model' export { IdType as ProductFeesApiModelIdType, @@ -2003,7 +2002,9 @@ export { VendorShippingLabelsApiSubmitShippingLabelRequestRequest as VendorDirectFulfillmentShippingApiModelVendorShippingLabelsApiSubmitShippingLabelRequestRequest, } from './vendor-direct-fulfillment-shipping-api-model' export { + CarrierId as VendorDirectFulfillmentShippingApiModelV20211228CarrierId, ContainerContainerTypeEnum as VendorDirectFulfillmentShippingApiModelV20211228ContainerContainerTypeEnum, + ContainerLabelFormat as VendorDirectFulfillmentShippingApiModelV20211228ContainerLabelFormat, DimensionsUnitOfMeasureEnum as VendorDirectFulfillmentShippingApiModelV20211228DimensionsUnitOfMeasureEnum, PackingSlipContentTypeEnum as VendorDirectFulfillmentShippingApiModelV20211228PackingSlipContentTypeEnum, ShipmentDetailsShipmentStatusEnum as VendorDirectFulfillmentShippingApiModelV20211228ShipmentDetailsShipmentStatusEnum, @@ -2012,6 +2013,9 @@ export { WeightUnitOfMeasureEnum as VendorDirectFulfillmentShippingApiModelV20211228WeightUnitOfMeasureEnum, Address as VendorDirectFulfillmentShippingApiModelV20211228Address, Container as VendorDirectFulfillmentShippingApiModelV20211228Container, + ContainerLabel as VendorDirectFulfillmentShippingApiModelV20211228ContainerLabel, + CreateContainerLabelRequest as VendorDirectFulfillmentShippingApiModelV20211228CreateContainerLabelRequest, + CreateContainerLabelResponse as VendorDirectFulfillmentShippingApiModelV20211228CreateContainerLabelResponse, CreateShippingLabelsRequest as VendorDirectFulfillmentShippingApiModelV20211228CreateShippingLabelsRequest, CustomerInvoice as VendorDirectFulfillmentShippingApiModelV20211228CustomerInvoice, CustomerInvoiceList as VendorDirectFulfillmentShippingApiModelV20211228CustomerInvoiceList, @@ -2021,6 +2025,7 @@ export { ItemQuantity as VendorDirectFulfillmentShippingApiModelV20211228ItemQuantity, LabelData as VendorDirectFulfillmentShippingApiModelV20211228LabelData, ModelError as VendorDirectFulfillmentShippingApiModelV20211228ModelError, + Package as VendorDirectFulfillmentShippingApiModelV20211228Package, PackedItem as VendorDirectFulfillmentShippingApiModelV20211228PackedItem, PackingSlip as VendorDirectFulfillmentShippingApiModelV20211228PackingSlip, PackingSlipList as VendorDirectFulfillmentShippingApiModelV20211228PackingSlipList, @@ -2073,9 +2078,11 @@ export { ChargeDetailsTypeEnum as VendorInvoicesApiModelChargeDetailsTypeEnum, InvoiceInvoiceTypeEnum as VendorInvoicesApiModelInvoiceInvoiceTypeEnum, ItemQuantityUnitOfMeasureEnum as VendorInvoicesApiModelItemQuantityUnitOfMeasureEnum, + NetCostUnitOfMeasure as VendorInvoicesApiModelNetCostUnitOfMeasure, PaymentTermsTypeEnum as VendorInvoicesApiModelPaymentTermsTypeEnum, TaxDetailsTaxTypeEnum as VendorInvoicesApiModelTaxDetailsTaxTypeEnum, TaxRegistrationDetailsTaxRegistrationTypeEnum as VendorInvoicesApiModelTaxRegistrationDetailsTaxRegistrationTypeEnum, + TotalWeightUnitOfMeasureEnum as VendorInvoicesApiModelTotalWeightUnitOfMeasureEnum, AdditionalDetails as VendorInvoicesApiModelAdditionalDetails, Address as VendorInvoicesApiModelAddress, AllowanceDetails as VendorInvoicesApiModelAllowanceDetails, @@ -2092,8 +2099,9 @@ export { SubmitInvoicesResponse as VendorInvoicesApiModelSubmitInvoicesResponse, TaxDetails as VendorInvoicesApiModelTaxDetails, TaxRegistrationDetails as VendorInvoicesApiModelTaxRegistrationDetails, + TotalWeight as VendorInvoicesApiModelTotalWeight, TransactionId as VendorInvoicesApiModelTransactionId, - VendorPaymentsApiSubmitInvoicesRequest as VendorInvoicesApiModelVendorPaymentsApiSubmitInvoicesRequest, + VendorInvoicesApiSubmitInvoicesRequest as VendorInvoicesApiModelVendorInvoicesApiSubmitInvoicesRequest, } from './vendor-invoices-api-model' export { ImportDetailsMethodOfPaymentEnum as VendorOrdersApiModelImportDetailsMethodOfPaymentEnum, @@ -2152,15 +2160,19 @@ export { ImportDetailsHandlingInstructionsEnum as VendorShipmentsApiModelImportDetailsHandlingInstructionsEnum, ItemDetailsHandlingCodeEnum as VendorShipmentsApiModelItemDetailsHandlingCodeEnum, ItemQuantityUnitOfMeasureEnum as VendorShipmentsApiModelItemQuantityUnitOfMeasureEnum, + LabelDataLabelFormatEnum as VendorShipmentsApiModelLabelDataLabelFormatEnum, + PackedQuantityUnitOfMeasureEnum as VendorShipmentsApiModelPackedQuantityUnitOfMeasureEnum, ShipmentTransactionTypeEnum as VendorShipmentsApiModelShipmentTransactionTypeEnum, ShipmentCurrentShipmentStatusEnum as VendorShipmentsApiModelShipmentCurrentShipmentStatusEnum, ShipmentShipmentFreightTermEnum as VendorShipmentsApiModelShipmentShipmentFreightTermEnum, ShipmentConfirmationShipmentConfirmationTypeEnum as VendorShipmentsApiModelShipmentConfirmationShipmentConfirmationTypeEnum, ShipmentConfirmationShipmentTypeEnum as VendorShipmentsApiModelShipmentConfirmationShipmentTypeEnum, ShipmentConfirmationShipmentStructureEnum as VendorShipmentsApiModelShipmentConfirmationShipmentStructureEnum, + ShipmentInformationShipModeEnum as VendorShipmentsApiModelShipmentInformationShipModeEnum, ShipmentStatusDetailsShipmentStatusEnum as VendorShipmentsApiModelShipmentStatusDetailsShipmentStatusEnum, StopFunctionCodeEnum as VendorShipmentsApiModelStopFunctionCodeEnum, TaxRegistrationDetailsTaxRegistrationTypeEnum as VendorShipmentsApiModelTaxRegistrationDetailsTaxRegistrationTypeEnum, + TotalWeightUnitOfMeasureEnum as VendorShipmentsApiModelTotalWeightUnitOfMeasureEnum, TransportationDetailsShipModeEnum as VendorShipmentsApiModelTransportationDetailsShipModeEnum, TransportationDetailsTransportationModeEnum as VendorShipmentsApiModelTransportationDetailsTransportationModeEnum, TransportationDetailsForShipmentConfirmationTransportationModeEnum as VendorShipmentsApiModelTransportationDetailsForShipmentConfirmationTransportationModeEnum, @@ -2179,25 +2191,30 @@ export { Duration as VendorShipmentsApiModelDuration, Expiry as VendorShipmentsApiModelExpiry, GetShipmentDetailsResponse as VendorShipmentsApiModelGetShipmentDetailsResponse, + GetShipmentLabels as VendorShipmentsApiModelGetShipmentLabels, ImportDetails as VendorShipmentsApiModelImportDetails, InnerContainersDetails as VendorShipmentsApiModelInnerContainersDetails, Item as VendorShipmentsApiModelItem, ItemDetails as VendorShipmentsApiModelItemDetails, ItemQuantity as VendorShipmentsApiModelItemQuantity, + LabelData as VendorShipmentsApiModelLabelData, Location as VendorShipmentsApiModelLocation, ModelError as VendorShipmentsApiModelModelError, Money as VendorShipmentsApiModelMoney, PackageItemDetails as VendorShipmentsApiModelPackageItemDetails, PackedItems as VendorShipmentsApiModelPackedItems, + PackedQuantity as VendorShipmentsApiModelPackedQuantity, Pagination as VendorShipmentsApiModelPagination, Pallet as VendorShipmentsApiModelPallet, PartyIdentification as VendorShipmentsApiModelPartyIdentification, + PurchaseOrderItemDetails as VendorShipmentsApiModelPurchaseOrderItemDetails, PurchaseOrderItems as VendorShipmentsApiModelPurchaseOrderItems, PurchaseOrders as VendorShipmentsApiModelPurchaseOrders, Route as VendorShipmentsApiModelRoute, Shipment as VendorShipmentsApiModelShipment, ShipmentConfirmation as VendorShipmentsApiModelShipmentConfirmation, ShipmentDetails as VendorShipmentsApiModelShipmentDetails, + ShipmentInformation as VendorShipmentsApiModelShipmentInformation, ShipmentMeasurements as VendorShipmentsApiModelShipmentMeasurements, ShipmentStatusDetails as VendorShipmentsApiModelShipmentStatusDetails, Stop as VendorShipmentsApiModelStop, @@ -2205,15 +2222,20 @@ export { SubmitShipmentConfirmationsResponse as VendorShipmentsApiModelSubmitShipmentConfirmationsResponse, SubmitShipments as VendorShipmentsApiModelSubmitShipments, TaxRegistrationDetails as VendorShipmentsApiModelTaxRegistrationDetails, + TotalWeight as VendorShipmentsApiModelTotalWeight, TransactionReference as VendorShipmentsApiModelTransactionReference, + TransportLabel as VendorShipmentsApiModelTransportLabel, TransportShipmentMeasurements as VendorShipmentsApiModelTransportShipmentMeasurements, TransportationDetails as VendorShipmentsApiModelTransportationDetails, TransportationDetailsForShipmentConfirmation as VendorShipmentsApiModelTransportationDetailsForShipmentConfirmation, + TransportationLabels as VendorShipmentsApiModelTransportationLabels, + VendorDetails as VendorShipmentsApiModelVendorDetails, Volume as VendorShipmentsApiModelVolume, Weight as VendorShipmentsApiModelWeight, - VendorShippingApiGetShipmentDetailsRequest as VendorShipmentsApiModelVendorShippingApiGetShipmentDetailsRequest, - VendorShippingApiSubmitShipmentConfirmationsRequest as VendorShipmentsApiModelVendorShippingApiSubmitShipmentConfirmationsRequest, - VendorShippingApiSubmitShipmentsRequest as VendorShipmentsApiModelVendorShippingApiSubmitShipmentsRequest, + VendorShipmentsApiGetShipmentDetailsRequest as VendorShipmentsApiModelVendorShipmentsApiGetShipmentDetailsRequest, + VendorShipmentsApiGetShipmentLabelsRequest as VendorShipmentsApiModelVendorShipmentsApiGetShipmentLabelsRequest, + VendorShipmentsApiSubmitShipmentConfirmationsRequest as VendorShipmentsApiModelVendorShipmentsApiSubmitShipmentConfirmationsRequest, + VendorShipmentsApiSubmitShipmentsRequest as VendorShipmentsApiModelVendorShipmentsApiSubmitShipmentsRequest, } from './vendor-shipments-api-model' export { TransactionStatusEnum as VendorTransactionStatusApiModelTransactionStatusEnum, 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 a4519c96..c49f0796 100644 --- a/src/api-models/listings-items-api-model-v20210801/api.ts +++ b/src/api-models/listings-items-api-model-v20210801/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Listings Items + * Listings Items v2021-08-01 * The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-01 @@ -679,13 +679,14 @@ export interface Points { } /** - * ListingsApi - axios parameter creator + * ListingsItemsApi - axios parameter creator * @export */ -export const ListingsApiAxiosParamCreator = function (configuration?: Configuration) { +export const ListingsItemsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary deleteListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -735,6 +736,7 @@ export const ListingsApiAxiosParamCreator = function (configuration?: Configurat }, /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary getListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -789,6 +791,7 @@ export const ListingsApiAxiosParamCreator = function (configuration?: Configurat }, /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary patchListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -854,6 +857,7 @@ export const ListingsApiAxiosParamCreator = function (configuration?: Configurat }, /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary putListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -912,76 +916,6 @@ 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, @@ -991,14 +925,15 @@ export const ListingsApiAxiosParamCreator = function (configuration?: Configurat }; /** - * ListingsApi - functional programming interface + * ListingsItemsApi - functional programming interface * @export */ -export const ListingsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ListingsApiAxiosParamCreator(configuration) +export const ListingsItemsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ListingsItemsApiAxiosParamCreator(configuration) return { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary deleteListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1012,6 +947,7 @@ export const ListingsApiFp = function(configuration?: Configuration) { }, /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary getListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1026,6 +962,7 @@ export const ListingsApiFp = function(configuration?: Configuration) { }, /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary patchListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1042,6 +979,7 @@ export const ListingsApiFp = function(configuration?: Configuration) { }, /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary putListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1056,35 +994,19 @@ 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); - }, } }; /** - * ListingsApi - factory interface + * ListingsItemsApi - factory interface * @export */ -export const ListingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ListingsApiFp(configuration) +export const ListingsItemsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ListingsItemsApiFp(configuration) return { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary deleteListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1097,6 +1019,7 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP }, /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary getListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1110,6 +1033,7 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP }, /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary patchListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1125,6 +1049,7 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP }, /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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). + * @summary putListingsItem * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. @@ -1138,337 +1063,251 @@ 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)); - }, }; }; /** - * Request parameters for deleteListingsItem operation in ListingsApi. + * Request parameters for deleteListingsItem operation in ListingsItemsApi. * @export - * @interface ListingsApiDeleteListingsItemRequest + * @interface ListingsItemsApiDeleteListingsItemRequest */ -export interface ListingsApiDeleteListingsItemRequest { +export interface ListingsItemsApiDeleteListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} - * @memberof ListingsApiDeleteListingsItem + * @memberof ListingsItemsApiDeleteListingsItem */ readonly sellerId: string /** * A selling partner provided identifier for an Amazon listing. * @type {string} - * @memberof ListingsApiDeleteListingsItem + * @memberof ListingsItemsApiDeleteListingsItem */ readonly sku: string /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} - * @memberof ListingsApiDeleteListingsItem + * @memberof ListingsItemsApiDeleteListingsItem */ readonly marketplaceIds: Array /** * 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 ListingsApiDeleteListingsItem + * @memberof ListingsItemsApiDeleteListingsItem */ readonly issueLocale?: string } /** - * Request parameters for getListingsItem operation in ListingsApi. + * Request parameters for getListingsItem operation in ListingsItemsApi. * @export - * @interface ListingsApiGetListingsItemRequest + * @interface ListingsItemsApiGetListingsItemRequest */ -export interface ListingsApiGetListingsItemRequest { +export interface ListingsItemsApiGetListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} - * @memberof ListingsApiGetListingsItem + * @memberof ListingsItemsApiGetListingsItem */ readonly sellerId: string /** * A selling partner provided identifier for an Amazon listing. * @type {string} - * @memberof ListingsApiGetListingsItem + * @memberof ListingsItemsApiGetListingsItem */ readonly sku: string /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} - * @memberof ListingsApiGetListingsItem + * @memberof ListingsItemsApiGetListingsItem */ readonly marketplaceIds: Array /** * 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 ListingsApiGetListingsItem + * @memberof ListingsItemsApiGetListingsItem */ readonly issueLocale?: string /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. * @type {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'>} - * @memberof ListingsApiGetListingsItem + * @memberof ListingsItemsApiGetListingsItem */ readonly includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement'> } /** - * Request parameters for patchListingsItem operation in ListingsApi. + * Request parameters for patchListingsItem operation in ListingsItemsApi. * @export - * @interface ListingsApiPatchListingsItemRequest + * @interface ListingsItemsApiPatchListingsItemRequest */ -export interface ListingsApiPatchListingsItemRequest { +export interface ListingsItemsApiPatchListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} - * @memberof ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly sellerId: string /** * A selling partner provided identifier for an Amazon listing. * @type {string} - * @memberof ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly sku: string /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} - * @memberof ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly marketplaceIds: Array /** * The request body schema for the `patchListingsItem` operation. * @type {ListingsItemPatchRequest} - * @memberof ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly body: ListingsItemPatchRequest /** * A comma-delimited list of data sets to include in the response. Default: `issues`. * @type {Array<'identifiers' | 'issues'>} - * @memberof ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly includedData?: Array<'identifiers' | 'issues'> /** * The mode of operation for the request. * @type {'VALIDATION_PREVIEW'} - * @memberof ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly mode?: 'VALIDATION_PREVIEW' /** * 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 ListingsApiPatchListingsItem + * @memberof ListingsItemsApiPatchListingsItem */ readonly issueLocale?: string } /** - * Request parameters for putListingsItem operation in ListingsApi. + * Request parameters for putListingsItem operation in ListingsItemsApi. * @export - * @interface ListingsApiPutListingsItemRequest + * @interface ListingsItemsApiPutListingsItemRequest */ -export interface ListingsApiPutListingsItemRequest { +export interface ListingsItemsApiPutListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} - * @memberof ListingsApiPutListingsItem + * @memberof ListingsItemsApiPutListingsItem */ readonly sellerId: string /** * A selling partner provided identifier for an Amazon listing. * @type {string} - * @memberof ListingsApiPutListingsItem + * @memberof ListingsItemsApiPutListingsItem */ readonly sku: string /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} - * @memberof ListingsApiPutListingsItem + * @memberof ListingsItemsApiPutListingsItem */ readonly marketplaceIds: Array /** * The request body schema for the `putListingsItem` operation. * @type {ListingsItemPutRequest} - * @memberof ListingsApiPutListingsItem + * @memberof ListingsItemsApiPutListingsItem */ readonly body: ListingsItemPutRequest /** * A comma-delimited list of data sets to include in the response. Default: `issues`. * @type {Array<'identifiers' | 'issues'>} - * @memberof ListingsApiPutListingsItem + * @memberof ListingsItemsApiPutListingsItem */ readonly includedData?: Array<'identifiers' | 'issues'> /** * The mode of operation for the request. * @type {'VALIDATION_PREVIEW'} - * @memberof ListingsApiPutListingsItem + * @memberof ListingsItemsApiPutListingsItem */ readonly mode?: 'VALIDATION_PREVIEW' /** * 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 ListingsApiPutListingsItem - */ - 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 + * @memberof ListingsItemsApiPutListingsItem */ readonly issueLocale?: string } /** - * ListingsApi - object-oriented interface + * ListingsItemsApi - object-oriented interface * @export - * @class ListingsApi + * @class ListingsItemsApi * @extends {BaseAPI} */ -export class ListingsApi extends BaseAPI { +export class ListingsItemsApi extends BaseAPI { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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 {ListingsApiDeleteListingsItemRequest} requestParameters Request parameters. + * @summary deleteListingsItem + * @param {ListingsItemsApiDeleteListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ListingsApi + * @memberof ListingsItemsApi */ - public deleteListingsItem(requestParameters: ListingsApiDeleteListingsItemRequest, options?: any) { - return ListingsApiFp(this.configuration).deleteListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.issueLocale, options).then((request) => request(this.axios, this.basePath)); + public deleteListingsItem(requestParameters: ListingsItemsApiDeleteListingsItemRequest, options?: any) { + return ListingsItemsApiFp(this.configuration).deleteListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.issueLocale, options).then((request) => request(this.axios, this.basePath)); } /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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 {ListingsApiGetListingsItemRequest} requestParameters Request parameters. + * @summary getListingsItem + * @param {ListingsItemsApiGetListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ListingsApi + * @memberof ListingsItemsApi */ - public getListingsItem(requestParameters: ListingsApiGetListingsItemRequest, options?: any) { - return ListingsApiFp(this.configuration).getListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.issueLocale, requestParameters.includedData, options).then((request) => request(this.axios, this.basePath)); + public getListingsItem(requestParameters: ListingsItemsApiGetListingsItemRequest, options?: any) { + return ListingsItemsApiFp(this.configuration).getListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.issueLocale, requestParameters.includedData, options).then((request) => request(this.axios, this.basePath)); } /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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 {ListingsApiPatchListingsItemRequest} requestParameters Request parameters. + * @summary patchListingsItem + * @param {ListingsItemsApiPatchListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ListingsApi + * @memberof ListingsItemsApi */ - public patchListingsItem(requestParameters: ListingsApiPatchListingsItemRequest, options?: any) { - return ListingsApiFp(this.configuration).patchListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.body, requestParameters.includedData, requestParameters.mode, requestParameters.issueLocale, options).then((request) => request(this.axios, this.basePath)); + public patchListingsItem(requestParameters: ListingsItemsApiPatchListingsItemRequest, options?: any) { + return ListingsItemsApiFp(this.configuration).patchListingsItem(requestParameters.sellerId, requestParameters.sku, requestParameters.marketplaceIds, requestParameters.body, requestParameters.includedData, requestParameters.mode, requestParameters.issueLocale, options).then((request) => request(this.axios, this.basePath)); } /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. 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 | | ---- | ---- | | 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 {ListingsApiPutListingsItemRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ListingsApi - */ - 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. + * @summary putListingsItem + * @param {ListingsItemsApiPutListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ListingsApi + * @memberof ListingsItemsApi */ - 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)); + public putListingsItem(requestParameters: ListingsItemsApiPutListingsItemRequest, options?: any) { + return ListingsItemsApiFp(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)); } } diff --git a/src/api-models/listings-items-api-model-v20210801/base.ts b/src/api-models/listings-items-api-model-v20210801/base.ts index db2b74e4..8b543765 100644 --- a/src/api-models/listings-items-api-model-v20210801/base.ts +++ b/src/api-models/listings-items-api-model-v20210801/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Listings Items + * Listings Items v2021-08-01 * The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-01 diff --git a/src/api-models/listings-items-api-model-v20210801/common.ts b/src/api-models/listings-items-api-model-v20210801/common.ts index 65551ef7..47119ece 100644 --- a/src/api-models/listings-items-api-model-v20210801/common.ts +++ b/src/api-models/listings-items-api-model-v20210801/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Listings Items + * Listings Items v2021-08-01 * The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-01 diff --git a/src/api-models/listings-items-api-model-v20210801/configuration.ts b/src/api-models/listings-items-api-model-v20210801/configuration.ts index 978edcd2..1b5ebd47 100644 --- a/src/api-models/listings-items-api-model-v20210801/configuration.ts +++ b/src/api-models/listings-items-api-model-v20210801/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Listings Items + * Listings Items v2021-08-01 * The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-01 diff --git a/src/api-models/listings-items-api-model-v20210801/index.ts b/src/api-models/listings-items-api-model-v20210801/index.ts index 77b80635..cc4c63ad 100644 --- a/src/api-models/listings-items-api-model-v20210801/index.ts +++ b/src/api-models/listings-items-api-model-v20210801/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Listings Items + * Listings Items v2021-08-01 * The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-01 diff --git a/src/api-models/merchant-fulfillment-api-model/api.ts b/src/api-models/merchant-fulfillment-api-model/api.ts index f0cbf2b5..fdde3b9f 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 - * 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. + * 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 version of the OpenAPI document: v0 * @@ -169,7 +169,7 @@ export interface Address { */ City: string; /** - * The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China. + * The state or province code. This is a required field in Canada, US, and UK marketplaces, and for shipments that originate in China. * @type {string} * @memberof Address */ @@ -181,7 +181,7 @@ export interface Address { */ PostalCode: string; /** - * The country code. A two-character country code, in ISO 3166-1 alpha-2 format. + * The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format. * @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 (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 + * 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. * @export * @interface Benefits */ @@ -263,7 +263,7 @@ export interface Benefits { */ IncludedBenefits?: Array; /** - * A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation. + * A list of excluded benefits. 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/items that are being shipped. + * Details related to any dangerous goods or items that are shipped. * @export * @interface DangerousGoodsDetails */ @@ -412,7 +412,7 @@ export interface DangerousGoodsDetails { */ UnitedNationsRegulatoryId?: string; /** - * The specific regulatory class of the item being shipped. + * The specific regulatory class of the shipped item. * @type {string} * @memberof DangerousGoodsDetails */ @@ -486,19 +486,19 @@ export enum DeliveryExperienceType { } /** - * Object representing an excluded benefit that is excluded for a shipping offer or rate. + * An object representing an excluded benefit that is excluded for a shipping offer or rate. * @export * @interface ExcludedBenefit */ export interface ExcludedBenefit { /** - * Benefit that is being excluded from a shipment. + * A benefit that is being excluded from a shipment. * @type {string} * @memberof ExcludedBenefit */ Benefit?: string; /** - * List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer. + * List of reasons why a benefit is excluded for a shipping offer (for example, `LATE_DELIVERY_RISK`). * @type {Array} * @memberof ExcludedBenefit */ @@ -511,7 +511,7 @@ export interface ExcludedBenefit { */ export interface FileContents { /** - * Data for printing labels, in the form of a Base64-encoded, GZip-compressed string. + * Data for printing labels encoded into a Base64, GZip-compressed string. * @type {string} * @memberof FileContents */ @@ -523,7 +523,7 @@ export interface FileContents { */ FileType: FileType | 'application/pdf' | 'application/zpl' | 'image/png'; /** - * An MD5 hash to validate the PDF document data, in the form of a Base64-encoded string. + * An MD5 hash to validate the PDF document data, in the form of a Base64 string. * @type {string} * @memberof FileContents */ @@ -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 were for some reason unavailable for this request + * List of services that are 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 occured. + * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ @@ -1002,19 +1002,19 @@ export interface ModelError { */ export interface PackageDimensions { /** - * Number representing the given package dimension. + * A number that represents the given package dimension. * @type {number} * @memberof PackageDimensions */ Length?: number; /** - * Number representing the given package dimension. + * A number that represents the given package dimension. * @type {number} * @memberof PackageDimensions */ Width?: number; /** - * Number representing the given package dimension. + * A number that represents 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: 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. + * 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. * @export * @enum {string} */ @@ -1097,13 +1097,13 @@ export enum PredefinedPackageDimensions { */ export interface RejectedShippingService { /** - * The rejected shipping carrier name. e.g. USPS + * The rejected shipping carrier name. For example, USPS. * @type {string} * @memberof RejectedShippingService */ CarrierName: string; /** - * The rejected shipping service localized name. e.g. FedEx Standard Overnight + * The rejected shipping service localized name. For example, FedEx Standard Overnight. * @type {string} * @memberof RejectedShippingService */ @@ -1115,7 +1115,7 @@ export interface RejectedShippingService { */ ShippingServiceId: string; /** - * A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX + * A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`. * @type {string} * @memberof RejectedShippingService */ @@ -1177,7 +1177,7 @@ export interface SellerInputDefinition { RestrictedSetValues?: Array; } /** - * The details of a shipment, including the shipment status. + * The details of a shipment. Includes the shipment status. * @export * @interface Shipment */ @@ -1201,7 +1201,7 @@ export interface Shipment { */ SellerOrderId?: string; /** - * The list of items to be included in a shipment. + * The list of items you want to include in a shipment. * @type {Array} * @memberof Shipment */ @@ -1292,7 +1292,7 @@ export interface ShipmentRequestDetails { */ SellerOrderId?: string; /** - * The list of items to be included in a shipment. + * The list of items you want to include in a shipment. * @type {Array} * @memberof ShipmentRequestDetails */ @@ -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 were applied to the requested operation, 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). + * 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 have 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 {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 were applied to the requested operation, 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. + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 have 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 The request schema for the `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 were applied to the requested operation, 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. + * 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 have 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 The request schema for the `GetAdditionalSellerInputs` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1696,8 +1696,8 @@ 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 were applied to the requested operation, 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. + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | 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 have 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 {GetEligibleShipmentServicesRequest} body The request schema for the `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 were applied to the requested operation, 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 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 have 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 {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 were applied to the requested operation, 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). + * 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 have 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 {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 were applied to the requested operation, 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. + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 have 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 The request schema for the `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 were applied to the requested operation, 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. + * 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 have 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 The request schema for the `GetAdditionalSellerInputs` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1804,8 +1804,8 @@ 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 were applied to the requested operation, 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. + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | 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 have 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 {GetEligibleShipmentServicesRequest} body The request schema for the `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 were applied to the requested operation, 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 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 have 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 {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 were applied to the requested operation, 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). + * 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 have 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 {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 were applied to the requested operation, 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. + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 have 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 The request schema for the `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 were applied to the requested operation, 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. + * 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 have 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 The request schema for the `GetAdditionalSellerInputs` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1861,8 +1861,8 @@ 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 were applied to the requested operation, 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. + * Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | 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 have 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 {GetEligibleShipmentServicesRequest} body The request schema for the `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 were applied to the requested operation, 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 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 have 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 {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. + * The request schema for the `CreateShipment` operation. * @type {CreateShipmentRequest} * @memberof MerchantFulfillmentApiCreateShipment */ @@ -1916,7 +1916,7 @@ export interface MerchantFulfillmentApiCreateShipmentRequest { */ export interface MerchantFulfillmentApiGetAdditionalSellerInputsRequest { /** - * Request schema for GetAdditionalSellerInputs operation. + * The request schema for the `GetAdditionalSellerInputs` operation. * @type {GetAdditionalSellerInputsRequest} * @memberof MerchantFulfillmentApiGetAdditionalSellerInputs */ @@ -1930,7 +1930,7 @@ export interface MerchantFulfillmentApiGetAdditionalSellerInputsRequest { */ export interface MerchantFulfillmentApiGetEligibleShipmentServicesRequest { /** - * Request schema for GetEligibleShipmentServices operation. + * The request schema for the `GetEligibleShipmentServices` operation. * @type {GetEligibleShipmentServicesRequest} * @memberof MerchantFulfillmentApiGetEligibleShipmentServices */ @@ -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 were applied to the requested operation, 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). + * 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 have 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 {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 were applied to the requested operation, 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). + * Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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 have 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 {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 were applied to the requested operation, 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). + * 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 have 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 {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 were applied to the requested operation, 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 a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | 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 have 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 {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 were applied to the requested operation, 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 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 have 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 {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 14e70251..8150797c 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 - * 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. + * 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 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 37a4c8e0..4f990343 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 - * 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. + * 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 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 6cef0db3..d03b5494 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 - * 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. + * 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 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 e46327e8..4c667df4 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 - * 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. + * 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 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 deb12462..85e64e54 100644 --- a/src/api-models/orders-api-model/api.ts +++ b/src/api-models/orders-api-model/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Orders + * Orders v0 * 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 @@ -2332,13 +2332,14 @@ export enum VerificationStatus { /** - * OrdersV0Api - axios parameter creator + * OrdersApi - axios parameter creator * @export */ -export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configuration) { +export const OrdersApiAxiosParamCreator = 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 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). + * @summary confirmShipment * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`. * @param {*} [options] Override http request option. @@ -2378,6 +2379,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 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). + * @summary getOrder * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2411,6 +2413,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 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). + * @summary getOrderAddress * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2444,6 +2447,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 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). + * @summary getOrderBuyerInfo * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2477,6 +2481,7 @@ 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 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). + * @summary getOrderItems * @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. @@ -2515,6 +2520,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 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). + * @summary getOrderItemsBuyerInfo * @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. @@ -2553,6 +2559,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 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). + * @summary getOrderRegulatedInfo * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2586,6 +2593,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }, /** * 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. + * @summary getOrders * @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. @@ -2725,8 +2733,49 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat options: localVarRequestOptions, }; }, + /** + * 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). + * @summary updateShipmentStatus + * @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. + * @throws {RequiredError} + */ + updateShipmentStatus: async (orderId: string, payload: UpdateShipmentStatusRequest, options: any = {}): Promise => { + // verify required parameter 'orderId' is not null or undefined + assertParamExists('updateShipmentStatus', 'orderId', orderId) + // verify required parameter 'payload' is not null or undefined + assertParamExists('updateShipmentStatus', 'payload', payload) + const localVarPath = `/orders/v0/orders/{orderId}/shipment` + .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: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * 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). + * @summary updateVerificationStatus * @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. @@ -2768,14 +2817,15 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; /** - * OrdersV0Api - functional programming interface + * OrdersApi - functional programming interface * @export */ -export const OrdersV0ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OrdersV0ApiAxiosParamCreator(configuration) +export const OrdersApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(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 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). + * @summary confirmShipment * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`. * @param {*} [options] Override http request option. @@ -2787,6 +2837,7 @@ export const OrdersV0ApiFp = function(configuration?: 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 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). + * @summary getOrder * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2797,6 +2848,7 @@ export const OrdersV0ApiFp = function(configuration?: 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 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). + * @summary getOrderAddress * @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,6 +2859,7 @@ export const OrdersV0ApiFp = function(configuration?: 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 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). + * @summary getOrderBuyerInfo * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2817,6 +2870,7 @@ export const OrdersV0ApiFp = function(configuration?: 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). + * @summary getOrderItems * @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. @@ -2828,6 +2882,7 @@ export const OrdersV0ApiFp = function(configuration?: 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 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). + * @summary getOrderItemsBuyerInfo * @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. @@ -2839,6 +2894,7 @@ export const OrdersV0ApiFp = function(configuration?: 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 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). + * @summary getOrderRegulatedInfo * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2849,6 +2905,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { }, /** * 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. + * @summary getOrders * @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. @@ -2878,8 +2935,21 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * 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). + * @summary updateShipmentStatus + * @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. + * @throws {RequiredError} + */ + async updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options); + 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 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). + * @summary updateVerificationStatus * @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. @@ -2893,14 +2963,15 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { }; /** - * OrdersV0Api - factory interface + * OrdersApi - factory interface * @export */ -export const OrdersV0ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OrdersV0ApiFp(configuration) +export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = OrdersApiFp(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 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). + * @summary confirmShipment * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`. * @param {*} [options] Override http request option. @@ -2911,6 +2982,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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). + * @summary getOrder * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2920,6 +2992,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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). + * @summary getOrderAddress * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2929,6 +3002,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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). + * @summary getOrderBuyerInfo * @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2938,6 +3012,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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). + * @summary getOrderItems * @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. @@ -2948,6 +3023,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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). + * @summary getOrderItemsBuyerInfo * @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. @@ -2958,6 +3034,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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). + * @summary getOrderRegulatedInfo * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2967,6 +3044,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }, /** * 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. + * @summary getOrders * @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. @@ -2995,8 +3073,20 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP getOrders(marketplaceIds: Array, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array, fulfillmentChannels?: Array, paymentMethods?: Array, buyerEmail?: string, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array, electronicInvoiceStatuses?: Array, nextToken?: string, amazonOrderIds?: Array, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: any): AxiosPromise { 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)); }, + /** + * 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). + * @summary updateShipmentStatus + * @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. + * @throws {RequiredError} + */ + updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise { + return localVarFp.updateShipmentStatus(orderId, payload, 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 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). + * @summary updateVerificationStatus * @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. @@ -3009,540 +3099,452 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP }; /** - * Request parameters for confirmShipment operation in OrdersV0Api. + * Request parameters for confirmShipment operation in OrdersApi. * @export - * @interface OrdersV0ApiConfirmShipmentRequest + * @interface OrdersApiConfirmShipmentRequest */ -export interface OrdersV0ApiConfirmShipmentRequest { +export interface OrdersApiConfirmShipmentRequest { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiConfirmShipment + * @memberof OrdersApiConfirmShipment */ readonly orderId: string /** * Request body of `confirmShipment`. * @type {ConfirmShipmentRequest} - * @memberof OrdersV0ApiConfirmShipment + * @memberof OrdersApiConfirmShipment */ readonly payload: ConfirmShipmentRequest } /** - * Request parameters for getOrder operation in OrdersV0Api. + * Request parameters for getOrder operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrderRequest + * @interface OrdersApiGetOrderRequest */ -export interface OrdersV0ApiGetOrderRequest { +export interface OrdersApiGetOrderRequest { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiGetOrder + * @memberof OrdersApiGetOrder */ readonly orderId: string } /** - * Request parameters for getOrderAddress operation in OrdersV0Api. + * Request parameters for getOrderAddress operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrderAddressRequest + * @interface OrdersApiGetOrderAddressRequest */ -export interface OrdersV0ApiGetOrderAddressRequest { +export interface OrdersApiGetOrderAddressRequest { /** * An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiGetOrderAddress + * @memberof OrdersApiGetOrderAddress */ readonly orderId: string } /** - * Request parameters for getOrderBuyerInfo operation in OrdersV0Api. + * Request parameters for getOrderBuyerInfo operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrderBuyerInfoRequest + * @interface OrdersApiGetOrderBuyerInfoRequest */ -export interface OrdersV0ApiGetOrderBuyerInfoRequest { +export interface OrdersApiGetOrderBuyerInfoRequest { /** * An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiGetOrderBuyerInfo + * @memberof OrdersApiGetOrderBuyerInfo */ readonly orderId: string } /** - * Request parameters for getOrderItems operation in OrdersV0Api. + * Request parameters for getOrderItems operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrderItemsRequest + * @interface OrdersApiGetOrderItemsRequest */ -export interface OrdersV0ApiGetOrderItemsRequest { +export interface OrdersApiGetOrderItemsRequest { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiGetOrderItems + * @memberof OrdersApiGetOrderItems */ readonly orderId: string /** * A string token returned in the response of your previous request. * @type {string} - * @memberof OrdersV0ApiGetOrderItems + * @memberof OrdersApiGetOrderItems */ readonly nextToken?: string } /** - * Request parameters for getOrderItemsBuyerInfo operation in OrdersV0Api. + * Request parameters for getOrderItemsBuyerInfo operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrderItemsBuyerInfoRequest + * @interface OrdersApiGetOrderItemsBuyerInfoRequest */ -export interface OrdersV0ApiGetOrderItemsBuyerInfoRequest { +export interface OrdersApiGetOrderItemsBuyerInfoRequest { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiGetOrderItemsBuyerInfo + * @memberof OrdersApiGetOrderItemsBuyerInfo */ readonly orderId: string /** * A string token returned in the response of your previous request. * @type {string} - * @memberof OrdersV0ApiGetOrderItemsBuyerInfo + * @memberof OrdersApiGetOrderItemsBuyerInfo */ readonly nextToken?: string } /** - * Request parameters for getOrderRegulatedInfo operation in OrdersV0Api. + * Request parameters for getOrderRegulatedInfo operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrderRegulatedInfoRequest + * @interface OrdersApiGetOrderRegulatedInfoRequest */ -export interface OrdersV0ApiGetOrderRegulatedInfoRequest { +export interface OrdersApiGetOrderRegulatedInfoRequest { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiGetOrderRegulatedInfo + * @memberof OrdersApiGetOrderRegulatedInfo */ readonly orderId: string } /** - * Request parameters for getOrders operation in OrdersV0Api. + * Request parameters for getOrders operation in OrdersApi. * @export - * @interface OrdersV0ApiGetOrdersRequest + * @interface OrdersApiGetOrdersRequest */ -export interface OrdersV0ApiGetOrdersRequest { +export interface OrdersApiGetOrdersRequest { /** * 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 + * @memberof OrdersApiGetOrders */ readonly marketplaceIds: Array /** * 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 + * @memberof OrdersApiGetOrders */ readonly createdAfter?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly createdBefore?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly lastUpdatedAfter?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly lastUpdatedBefore?: string /** * 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.) * @type {Array} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly orderStatuses?: Array /** * 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 + * @memberof OrdersApiGetOrders */ readonly fulfillmentChannels?: Array /** * 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 + * @memberof OrdersApiGetOrders */ readonly paymentMethods?: Array /** * The email address of a buyer. Used to select orders that contain the specified email address. * @type {string} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ 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. * @type {string} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly sellerOrderId?: string /** * A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. * @type {number} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly maxResultsPerPage?: number /** * 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.) * @type {Array} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly easyShipShipmentStatuses?: Array /** * 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.) * @type {Array} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly electronicInvoiceStatuses?: Array /** * A string token returned in the response of your previous request. * @type {string} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly nextToken?: string /** * A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. * @type {Array} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly amazonOrderIds?: Array /** * The `sourceId` of the location from where you want the order fulfilled. * @type {string} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly actualFulfillmentSupplySourceId?: string /** * When true, this order is marked to be picked up from a store rather than delivered. * @type {boolean} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly isISPU?: boolean /** * The store chain store identifier. Linked to a specific store in a store chain. * @type {string} - * @memberof OrdersV0ApiGetOrders + * @memberof OrdersApiGetOrders */ readonly storeChainStoreId?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly earliestDeliveryDateBefore?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly earliestDeliveryDateAfter?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly latestDeliveryDateBefore?: string /** * 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 + * @memberof OrdersApiGetOrders */ readonly latestDeliveryDateAfter?: string } /** - * Request parameters for updateVerificationStatus operation in OrdersV0Api. + * Request parameters for updateShipmentStatus operation in OrdersApi. + * @export + * @interface OrdersApiUpdateShipmentStatusRequest + */ +export interface OrdersApiUpdateShipmentStatusRequest { + /** + * An Amazon-defined order identifier, in 3-7-7 format. + * @type {string} + * @memberof OrdersApiUpdateShipmentStatus + */ + readonly orderId: string + + /** + * The request body for the `updateShipmentStatus` operation. + * @type {UpdateShipmentStatusRequest} + * @memberof OrdersApiUpdateShipmentStatus + */ + readonly payload: UpdateShipmentStatusRequest +} + +/** + * Request parameters for updateVerificationStatus operation in OrdersApi. * @export - * @interface OrdersV0ApiUpdateVerificationStatusRequest + * @interface OrdersApiUpdateVerificationStatusRequest */ -export interface OrdersV0ApiUpdateVerificationStatusRequest { +export interface OrdersApiUpdateVerificationStatusRequest { /** * An Amazon-defined order identifier, in 3-7-7 format. * @type {string} - * @memberof OrdersV0ApiUpdateVerificationStatus + * @memberof OrdersApiUpdateVerificationStatus */ readonly orderId: string /** * The request body for the `updateVerificationStatus` operation. * @type {UpdateVerificationStatusRequest} - * @memberof OrdersV0ApiUpdateVerificationStatus + * @memberof OrdersApiUpdateVerificationStatus */ readonly payload: UpdateVerificationStatusRequest } /** - * OrdersV0Api - object-oriented interface + * OrdersApi - object-oriented interface * @export - * @class OrdersV0Api + * @class OrdersApi * @extends {BaseAPI} */ -export class OrdersV0Api extends BaseAPI { +export class OrdersApi 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 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. + * @summary confirmShipment + * @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath)); + public confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: any) { + return OrdersApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.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 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. + * @summary getOrder + * @param {OrdersApiGetOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); + public getOrder(requestParameters: OrdersApiGetOrderRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.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 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. + * @summary getOrderAddress + * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); + public getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.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 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. + * @summary getOrderBuyerInfo + * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); + public getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrderBuyerInfo(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. + * @summary getOrderItems + * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath)); + public getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.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 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. + * @summary getOrderItemsBuyerInfo + * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath)); + public getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.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 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. + * @summary getOrderRegulatedInfo + * @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); + public getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); } /** * 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. + * @summary getOrders + * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(this.axios, this.basePath)); + public getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: any) { + return OrdersApiFp(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(this.axios, this.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 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. + * 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). + * @summary updateShipmentStatus + * @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof OrdersV0Api + * @memberof OrdersApi */ - public updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?: any) { - return OrdersV0ApiFp(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath)); + public updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: any) { + return OrdersApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath)); } -} - -/** - * ShipmentApi - axios parameter creator - * @export - */ -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 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. - * @throws {RequiredError} - */ - updateShipmentStatus: async (orderId: string, payload: UpdateShipmentStatusRequest, options: any = {}): Promise => { - // verify required parameter 'orderId' is not null or undefined - assertParamExists('updateShipmentStatus', 'orderId', orderId) - // verify required parameter 'payload' is not null or undefined - assertParamExists('updateShipmentStatus', 'payload', payload) - const localVarPath = `/orders/v0/orders/{orderId}/shipment` - .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: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * ShipmentApi - functional programming interface - * @export - */ -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 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. - * @throws {RequiredError} - */ - async updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * ShipmentApi - factory interface - * @export - */ -export const ShipmentApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - 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 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. - * @throws {RequiredError} - */ - updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise { - return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for updateShipmentStatus operation in ShipmentApi. - * @export - * @interface ShipmentApiUpdateShipmentStatusRequest - */ -export interface ShipmentApiUpdateShipmentStatusRequest { - /** - * An Amazon-defined order identifier, in 3-7-7 format. - * @type {string} - * @memberof ShipmentApiUpdateShipmentStatus - */ - readonly orderId: string - - /** - * The request body for the `updateShipmentStatus` operation. - * @type {UpdateShipmentStatusRequest} - * @memberof ShipmentApiUpdateShipmentStatus - */ - readonly payload: UpdateShipmentStatusRequest -} - -/** - * ShipmentApi - object-oriented interface - * @export - * @class ShipmentApi - * @extends {BaseAPI} - */ -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 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. + * 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). + * @summary updateVerificationStatus + * @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ShipmentApi + * @memberof OrdersApi */ - public updateShipmentStatus(requestParameters: ShipmentApiUpdateShipmentStatusRequest, options?: any) { - return ShipmentApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath)); + public updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: any) { + return OrdersApiFp(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/api-models/orders-api-model/base.ts b/src/api-models/orders-api-model/base.ts index 2cf1d119..75074b32 100644 --- a/src/api-models/orders-api-model/base.ts +++ b/src/api-models/orders-api-model/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Orders + * Orders v0 * 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 391e11e3..f6a24a2d 100644 --- a/src/api-models/orders-api-model/common.ts +++ b/src/api-models/orders-api-model/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Orders + * Orders v0 * 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 85cf9f47..71cf9cbd 100644 --- a/src/api-models/orders-api-model/configuration.ts +++ b/src/api-models/orders-api-model/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Orders + * Orders v0 * 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 dbce2679..93e0884c 100644 --- a/src/api-models/orders-api-model/index.ts +++ b/src/api-models/orders-api-model/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Orders + * Orders v0 * 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 04800899..b2fa6360 100644 --- a/src/api-models/product-pricing-api-model-v20220501/api.ts +++ b/src/api-models/product-pricing-api-model-v20220501/api.ts @@ -28,7 +28,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr */ export interface BatchRequest { /** - * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this should be `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`. + * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`. * @type {string} * @memberof BatchRequest */ @@ -40,13 +40,13 @@ export interface BatchRequest { */ method: HttpMethod | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | 'POST'; /** - * Additional HTTP body information associated with an individual request within a batch. + * Additional HTTP body information that is associated with an individual request within a batch. * @type {{ [key: string]: object; }} * @memberof BatchRequest */ body?: { [key: string]: object; }; /** - * A mapping of additional HTTP headers to send/receive for an individual request within a batch. + * A mapping of additional HTTP headers to send or receive for an individual request within a batch. * @type {{ [key: string]: string; }} * @memberof BatchRequest */ @@ -59,7 +59,7 @@ export interface BatchRequest { */ export interface BatchResponse { /** - * A mapping of additional HTTP headers to send/receive for an individual request within a batch. + * A mapping of additional HTTP headers to send or receive for an individual request within a batch. * @type {{ [key: string]: string; }} * @memberof BatchResponse */ @@ -85,20 +85,20 @@ export interface CompetitiveSummaryBatchRequest { requests: Array; } /** - * The response schema of the `competitiveSummaryBatch` operation. + * The response schema for the `competitiveSummaryBatch` operation. * @export * @interface CompetitiveSummaryBatchResponse */ export interface CompetitiveSummaryBatchResponse { /** - * The response list of the `competitiveSummaryBatch` operation. + * The response list for the `competitiveSummaryBatch` operation. * @type {Array} * @memberof CompetitiveSummaryBatchResponse */ responses: Array; } /** - * The supported types of data in the `getCompetitiveSummary` API. + * The supported data types in the `getCompetitiveSummary` API. * @export * @enum {string} */ @@ -115,7 +115,7 @@ export enum CompetitiveSummaryIncludedData { */ export interface CompetitiveSummaryRequest { /** - * The Amazon Standard Identification Number (ASIN) of the item. + * The ASIN of the item. * @type {string} * @memberof CompetitiveSummaryRequest */ @@ -133,7 +133,7 @@ export interface CompetitiveSummaryRequest { */ includedData: Array<(CompetitiveSummaryIncludedData | 'featuredBuyingOptions' | 'referencePrices' | 'lowestPricedOffers')>; /** - * The list of `lowestPricedOffersInput` parameters used to build the `lowestPricedOffers` in the response. This attribute is valid only if `lowestPricedOffers` is requested in `includedData`. + * The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData` * @type {Array} * @memberof CompetitiveSummaryRequest */ @@ -145,7 +145,7 @@ export interface CompetitiveSummaryRequest { */ method: HttpMethod | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | 'POST'; /** - * The URI associated with the individual APIs being called as part of the batch request. + * The URI associated with the individual APIs that are called as part of the batch request. * @type {string} * @memberof CompetitiveSummaryRequest */ @@ -177,7 +177,7 @@ export interface CompetitiveSummaryResponse { */ export interface CompetitiveSummaryResponseBody { /** - * The Amazon Standard Identification Number (ASIN) of the item. + * The ASIN of the item. * @type {string} * @memberof CompetitiveSummaryResponseBody */ @@ -189,25 +189,25 @@ export interface CompetitiveSummaryResponseBody { */ marketplaceId: string; /** - * A list of featured buying options for the given ASIN `marketplaceId` combination. + * A list of featured buying options for the specified ASIN `marketplaceId` combination. * @type {Array} * @memberof CompetitiveSummaryResponseBody */ featuredBuyingOptions?: Array; /** - * A list of the lowest priced offers for the given ASIN `marketplaceId` combination. + * A list of lowest priced offers for the specified ASIN `marketplaceId` combination. * @type {Array} * @memberof CompetitiveSummaryResponseBody */ lowestPricedOffers?: Array; /** - * A list of reference prices for the given ASIN `marketplaceId` combination. + * A list of reference prices for the specified ASIN `marketplaceId` combination. * @type {Array} * @memberof CompetitiveSummaryResponseBody */ referencePrices?: Array; /** - * A list of error responses returned when a request is unsuccessful. + * A list of error responses that are returned when a request is unsuccessful. * @type {Array} * @memberof CompetitiveSummaryResponseBody */ @@ -233,26 +233,26 @@ export enum Condition { */ export interface Errors { /** - * A list of error responses returned when a request is unsuccessful. + * A list of error responses that are returned when a request is unsuccessful. * @type {Array} * @memberof Errors */ errors: Array; } /** - * Describes a featured buying option which includes a list of segmented featured offers for a particular item condition. + * Describes a featured buying option, which includes a list of segmented featured offers for a particular item condition. * @export * @interface FeaturedBuyingOption */ export interface FeaturedBuyingOption { /** - * The buying option type of the featured offer. This field represents the buying options that a customer sees on the detail page. For example, B2B, Fresh, and Subscribe n Save. Currently supports `NEW` + * The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value. * @type {string} * @memberof FeaturedBuyingOption */ buyingOptionType: FeaturedBuyingOptionBuyingOptionTypeEnum | 'New'; /** - * A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region or postal code and buying option. + * A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option. * @type {Array} * @memberof FeaturedBuyingOption */ @@ -312,13 +312,13 @@ export interface FeaturedOfferExpectedPrice { points?: Points; } /** - * An individual featured offer expected price request for a particular SKU. + * An individual FOEP request for a particular SKU. * @export * @interface FeaturedOfferExpectedPriceRequest */ export interface FeaturedOfferExpectedPriceRequest { /** - * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this should be `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`. + * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`. * @type {string} * @memberof FeaturedOfferExpectedPriceRequest */ @@ -330,13 +330,13 @@ export interface FeaturedOfferExpectedPriceRequest { */ method: HttpMethod | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | 'POST'; /** - * Additional HTTP body information associated with an individual request within a batch. + * Additional HTTP body information that is associated with an individual request within a batch. * @type {{ [key: string]: object; }} * @memberof FeaturedOfferExpectedPriceRequest */ body?: { [key: string]: object; }; /** - * A mapping of additional HTTP headers to send/receive for an individual request within a batch. + * A mapping of additional HTTP headers to send or receive for an individual request within a batch. * @type {{ [key: string]: string; }} * @memberof FeaturedOfferExpectedPriceRequest */ @@ -374,13 +374,13 @@ export interface FeaturedOfferExpectedPriceRequestParams { sku: string; } /** - * Schema for an individual featured offer expected price response. + * Schema for an individual FOEP response. * @export * @interface FeaturedOfferExpectedPriceResponse */ export interface FeaturedOfferExpectedPriceResponse { /** - * A mapping of additional HTTP headers to send/receive for an individual request within a batch. + * A mapping of additional HTTP headers to send or receive for an individual request within a batch. * @type {{ [key: string]: string; }} * @memberof FeaturedOfferExpectedPriceResponse */ @@ -424,7 +424,7 @@ export interface FeaturedOfferExpectedPriceResponseAllOf { body?: FeaturedOfferExpectedPriceResponseBody; } /** - * The featured offer expected price response data for a requested SKU. + * The FOEP response data for a requested SKU. * @export * @interface FeaturedOfferExpectedPriceResponseBody */ @@ -436,20 +436,20 @@ export interface FeaturedOfferExpectedPriceResponseBody { */ offerIdentifier?: OfferIdentifier; /** - * A list of featured offer expected price results for the requested offer. + * A list of FOEP results for the requested offer. * @type {Array} * @memberof FeaturedOfferExpectedPriceResponseBody */ featuredOfferExpectedPriceResults?: Array; /** - * A list of error responses returned when a request is unsuccessful. + * A list of error responses that are returned when a request is unsuccessful. * @type {Array} * @memberof FeaturedOfferExpectedPriceResponseBody */ errors?: Array; } /** - * The featured offer expected price result data for the requested offer. + * The FOEP result data for the requested offer. * @export * @interface FeaturedOfferExpectedPriceResult */ @@ -461,7 +461,7 @@ export interface FeaturedOfferExpectedPriceResult { */ featuredOfferExpectedPrice?: FeaturedOfferExpectedPrice; /** - * The status of the featured offer expected price computation. Possible values include `VALID_FOEP`, `NO_COMPETING_OFFER`, `OFFER_NOT_ELIGIBLE`, `OFFER_NOT_FOUND`, `ASIN_NOT_ELIGIBLE`. Additional values may be added in the future. + * The status of the FOEP computation. Possible values include `VALID_FOEP`, `NO_COMPETING_OFFER`, `OFFER_NOT_ELIGIBLE`, `OFFER_NOT_FOUND`, and `ASIN_NOT_ELIGIBLE`. Additional values might be added in the future. * @type {string} * @memberof FeaturedOfferExpectedPriceResult */ @@ -486,7 +486,7 @@ export interface FeaturedOfferExpectedPriceResult { */ export interface FeaturedOfferSegment { /** - * The customer membership type that make up this segment + * The customer membership type that makes up this segment * @type {string} * @memberof FeaturedOfferSegment */ @@ -525,7 +525,7 @@ export enum FulfillmentType { */ export interface GetFeaturedOfferExpectedPriceBatchRequest { /** - * A batched list of featured offer expected price requests. + * A batched list of FOEP requests. * @type {Array} * @memberof GetFeaturedOfferExpectedPriceBatchRequest */ @@ -538,7 +538,7 @@ export interface GetFeaturedOfferExpectedPriceBatchRequest { */ export interface GetFeaturedOfferExpectedPriceBatchResponse { /** - * A batched list of featured offer expected price responses. + * A batched list of FOEP responses. * @type {Array} * @memberof GetFeaturedOfferExpectedPriceBatchResponse */ @@ -558,26 +558,26 @@ export enum HttpMethod { } /** - * The HTTP status line associated with the response to an individual request within a batch. For more information, consult [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html). + * The HTTP status line associated with the response for an individual request within a batch. For more information, refer to [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html). * @export * @interface HttpStatusLine */ export interface HttpStatusLine { /** - * The HTTP response Status-Code. + * The HTTP response status code. * @type {number} * @memberof HttpStatusLine */ statusCode?: number; /** - * The HTTP response Reason-Phase. + * The HTTP response reason phrase. * @type {string} * @memberof HttpStatusLine */ reasonPhrase?: string; } /** - * The lowest priced offer for the requested item condition and offer type. + * Describes the lowest priced offers for the specified item condition and offer type. * @export * @interface LowestPricedOffer */ @@ -589,14 +589,14 @@ export interface LowestPricedOffer { */ lowestPricedOffersInput: LowestPricedOffersInput; /** - * A list of up to 20 lowest priced offers that match the criteria specified in the `lowestPricedOffersInput` parameter. + * A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`. * @type {Array} * @memberof LowestPricedOffer */ offers: Array; } /** - * The input required for building the `LowestPricedOffers` data in the response. + * The input required for building `LowestPricedOffers` data in the response. * @export * @interface LowestPricedOffersInput */ @@ -608,7 +608,7 @@ export interface LowestPricedOffersInput { */ itemCondition: Condition | 'New' | 'Used' | 'Collectible' | 'Refurbished' | 'Club'; /** - * The type of offers requested for the `LowestPricedOffers`. The `offerType` options are `Consumer` or `Business`. The default `offerType` is `Consumer`. + * The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`. * @type {string} * @memberof LowestPricedOffersInput */ @@ -649,7 +649,7 @@ export interface ModelError { details?: string; } /** - * Currency type and monetary value. Schema for demonstrating pricing info. + * Currency type and monetary value schema to demonstrate pricing information. * @export * @interface MoneyType */ @@ -686,7 +686,7 @@ export interface Offer { */ condition: Condition | 'New' | 'Used' | 'Collectible' | 'Refurbished' | 'Club'; /** - * The item subcondition for the offer. + * The item subcondition of the offer. * @type {string} * @memberof Offer */ @@ -744,7 +744,7 @@ export enum OfferSubConditionEnum { } /** - * Identifies an offer from a particular seller on an ASIN. + * Identifies an offer from a particular seller for a specified ASIN. * @export * @interface OfferIdentifier */ @@ -762,13 +762,13 @@ export interface OfferIdentifier { */ sellerId?: string; /** - * The seller stock keeping unit (SKU) of the item. This will only be present for the target offer, which belongs to the requesting seller. + * The seller SKU of the item. This will only be present for the target offer, which belongs to the requesting seller. * @type {string} * @memberof OfferIdentifier */ sku?: string; /** - * The Amazon Standard Identification Number (ASIN) of the item. + * The ASIN of the item. * @type {string} * @memberof OfferIdentifier */ @@ -781,13 +781,13 @@ export interface OfferIdentifier { fulfillmentType?: FulfillmentType | 'AFN' | 'MFN'; } /** - * The number of Amazon Points offered with the purchase of an item, and their monetary value. + * The number of Amazon Points that are offered with the purchase of an item and the monetary value of these points. * @export * @interface Points */ export interface Points { /** - * The number of points. + * The number of Amazon Points. * @type {number} * @memberof Points */ @@ -800,7 +800,7 @@ export interface Points { pointsMonetaryValue?: MoneyType; } /** - * Schema for item\'s price information, including listing price, shipping price, and Amazon points. + * The schema for item\'s price information, including listing price, shipping price, and Amazon Points. * @export * @interface Price */ @@ -849,13 +849,13 @@ export enum PrimeDetailsEligibilityEnum { } /** - * The reference price for the given ASIN `marketplaceId` combination. + * The reference price for the specified ASIN `marketplaceId` combination. * @export * @interface ReferencePrice */ export interface ReferencePrice { /** - * The name of the reference price like `CompetitivePriceThreshold`. + * The name of the reference price, such as `CompetitivePriceThreshold` and `WasPrice`. For reference price definitions, refer to the [Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide). * @type {string} * @memberof ReferencePrice */ @@ -874,7 +874,7 @@ export interface ReferencePrice { */ export interface SegmentDetails { /** - * Glance view weight percentage for this segment. The glance views for this segment as a percentage of total glance views across all segments on the ASIN. A higher percentage indicates more Amazon customers see this offer as the Featured Offer. + * The glance view weighted percentage for this segment, which is the glance views for this segment as a percentage of total glance views across all segments for the ASIN. A higher percentage indicates that more Amazon customers receive this offer as the Featured Offer. * @type {number} * @memberof SegmentDetails */ @@ -899,7 +899,7 @@ export interface SegmentedFeaturedOffer { */ condition: Condition | 'New' | 'Used' | 'Collectible' | 'Refurbished' | 'Club'; /** - * The item subcondition for the offer. + * The item subcondition of the offer. * @type {string} * @memberof SegmentedFeaturedOffer */ @@ -982,7 +982,7 @@ export interface SegmentedFeaturedOfferAllOf { */ export interface ShippingOption { /** - * The type of the shipping option. + * The type of shipping option. * @type {string} * @memberof ShippingOption */ @@ -1011,7 +1011,7 @@ export enum ShippingOptionShippingOptionTypeEnum { export const ProductPricingApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1046,7 +1046,7 @@ export const ProductPricingApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1091,7 +1091,7 @@ export const ProductPricingApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ProductPricingApiAxiosParamCreator(configuration) return { /** - * Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1101,7 +1101,7 @@ export const ProductPricingApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1121,7 +1121,7 @@ export const ProductPricingApiFactory = function (configuration?: Configuration, const localVarFp = ProductPricingApiFp(configuration) return { /** - * Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1130,7 +1130,7 @@ export const ProductPricingApiFactory = function (configuration?: Configuration, return localVarFp.getCompetitiveSummary(requests, options).then((request) => request(axios, basePath)); }, /** - * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1177,7 +1177,7 @@ export interface ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest { */ export class ProductPricingApi extends BaseAPI { /** - * Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1188,7 +1188,7 @@ export class ProductPricingApi extends BaseAPI { } /** - * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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). + * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 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 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 than 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. * @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/reports-api-model-v20210630/api.ts b/src/api-models/reports-api-model-v20210630/api.ts index f290fd13..a38abbad 100644 --- a/src/api-models/reports-api-model-v20210630/api.ts +++ b/src/api-models/reports-api-model-v20210630/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Reports + * Report v2021-06-30 * The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses. * * The version of the OpenAPI document: 2021-06-30 @@ -389,6 +389,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati return { /** * Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled reports are returned in subsequent calls to the `getReport` and `getReports` operations. **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, 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). + * @summary cancelReport * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -422,6 +423,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Cancels the report schedule 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, 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). + * @summary cancelReportSchedule * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -455,6 +457,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary createReport * @param {CreateReportSpecification} body Information required to create the report. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -490,6 +493,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **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, 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). + * @summary createReportSchedule * @param {CreateReportScheduleSpecification} body Information required to create the report schedule. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -525,6 +529,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Returns report details (including the `reportDocumentId`, if available) for the report 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, 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). + * @summary getReport * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -558,6 +563,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Returns the information required for retrieving a report document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary getReportDocument * @param {string} reportDocumentId The identifier for the report document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -591,6 +597,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Returns report schedule details for the report schedule 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, 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). + * @summary getReportSchedule * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -624,6 +631,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Returns report schedule details 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, 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). + * @summary getReportSchedules * @param {Array} reportTypes A list of report types used to filter report schedules. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -660,6 +668,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati }, /** * Returns report details for the reports 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, 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). + * @summary getReports * @param {Array} [reportTypes] A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @param {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} [processingStatuses] A list of processing statuses used to filter reports. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. @@ -738,6 +747,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { return { /** * Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled reports are returned in subsequent calls to the `getReport` and `getReports` operations. **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, 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). + * @summary cancelReport * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -748,6 +758,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Cancels the report schedule 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, 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). + * @summary cancelReportSchedule * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -758,6 +769,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary createReport * @param {CreateReportSpecification} body Information required to create the report. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -768,6 +780,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **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, 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). + * @summary createReportSchedule * @param {CreateReportScheduleSpecification} body Information required to create the report schedule. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -778,6 +791,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Returns report details (including the `reportDocumentId`, if available) for the report 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, 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). + * @summary getReport * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -788,6 +802,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Returns the information required for retrieving a report document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary getReportDocument * @param {string} reportDocumentId The identifier for the report document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -798,6 +813,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Returns report schedule details for the report schedule 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, 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). + * @summary getReportSchedule * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -808,6 +824,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Returns report schedule details 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, 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). + * @summary getReportSchedules * @param {Array} reportTypes A list of report types used to filter report schedules. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -818,6 +835,7 @@ export const ReportsApiFp = function(configuration?: Configuration) { }, /** * Returns report details for the reports 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, 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). + * @summary getReports * @param {Array} [reportTypes] A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @param {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} [processingStatuses] A list of processing statuses used to filter reports. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. @@ -844,6 +862,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa return { /** * Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled reports are returned in subsequent calls to the `getReport` and `getReports` operations. **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, 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). + * @summary cancelReport * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -853,6 +872,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Cancels the report schedule 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, 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). + * @summary cancelReportSchedule * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -862,6 +882,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary createReport * @param {CreateReportSpecification} body Information required to create the report. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -871,6 +892,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **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, 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). + * @summary createReportSchedule * @param {CreateReportScheduleSpecification} body Information required to create the report schedule. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -880,6 +902,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Returns report details (including the `reportDocumentId`, if available) for the report 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, 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). + * @summary getReport * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -889,6 +912,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Returns the information required for retrieving a report document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary getReportDocument * @param {string} reportDocumentId The identifier for the report document. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -898,6 +922,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Returns report schedule details for the report schedule 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, 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). + * @summary getReportSchedule * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -907,6 +932,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Returns report schedule details 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, 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). + * @summary getReportSchedules * @param {Array} reportTypes A list of report types used to filter report schedules. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -916,6 +942,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa }, /** * Returns report details for the reports 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, 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). + * @summary getReports * @param {Array} [reportTypes] A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @param {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} [processingStatuses] A list of processing statuses used to filter reports. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. @@ -1109,6 +1136,7 @@ export interface ReportsApiGetReportsRequest { export class ReportsApi extends BaseAPI { /** * Cancels the report that you specify. Only reports with `processingStatus=IN_QUEUE` can be cancelled. Cancelled reports are returned in subsequent calls to the `getReport` and `getReports` operations. **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, 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). + * @summary cancelReport * @param {ReportsApiCancelReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1120,6 +1148,7 @@ export class ReportsApi extends BaseAPI { /** * Cancels the report schedule 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, 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). + * @summary cancelReportSchedule * @param {ReportsApiCancelReportScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1131,6 +1160,7 @@ export class ReportsApi extends BaseAPI { /** * Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary createReport * @param {ReportsApiCreateReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1142,6 +1172,7 @@ export class ReportsApi extends BaseAPI { /** * Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **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, 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). + * @summary createReportSchedule * @param {ReportsApiCreateReportScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1153,6 +1184,7 @@ export class ReportsApi extends BaseAPI { /** * Returns report details (including the `reportDocumentId`, if available) for the report 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, 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). + * @summary getReport * @param {ReportsApiGetReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1164,6 +1196,7 @@ export class ReportsApi extends BaseAPI { /** * Returns the information required for retrieving a report document\'s contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 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, 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). + * @summary getReportDocument * @param {ReportsApiGetReportDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1175,6 +1208,7 @@ export class ReportsApi extends BaseAPI { /** * Returns report schedule details for the report schedule 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, 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). + * @summary getReportSchedule * @param {ReportsApiGetReportScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1186,6 +1220,7 @@ export class ReportsApi extends BaseAPI { /** * Returns report schedule details 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, 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). + * @summary getReportSchedules * @param {ReportsApiGetReportSchedulesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1197,6 +1232,7 @@ export class ReportsApi extends BaseAPI { /** * Returns report details for the reports 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, 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). + * @summary getReports * @param {ReportsApiGetReportsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/reports-api-model-v20210630/base.ts b/src/api-models/reports-api-model-v20210630/base.ts index 09b93b4a..db670397 100644 --- a/src/api-models/reports-api-model-v20210630/base.ts +++ b/src/api-models/reports-api-model-v20210630/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Reports + * Report v2021-06-30 * The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/reports-api-model-v20210630/common.ts b/src/api-models/reports-api-model-v20210630/common.ts index 21f354ea..03bb3e3c 100644 --- a/src/api-models/reports-api-model-v20210630/common.ts +++ b/src/api-models/reports-api-model-v20210630/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Reports + * Report v2021-06-30 * The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/reports-api-model-v20210630/configuration.ts b/src/api-models/reports-api-model-v20210630/configuration.ts index bb5dd6cd..4a3f0e21 100644 --- a/src/api-models/reports-api-model-v20210630/configuration.ts +++ b/src/api-models/reports-api-model-v20210630/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Reports + * Report v2021-06-30 * The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/reports-api-model-v20210630/index.ts b/src/api-models/reports-api-model-v20210630/index.ts index 0df69ee6..83727a35 100644 --- a/src/api-models/reports-api-model-v20210630/index.ts +++ b/src/api-models/reports-api-model-v20210630/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Reports + * Report v2021-06-30 * The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses. * * The version of the OpenAPI document: 2021-06-30 diff --git a/src/api-models/vendor-direct-fulfillment-inventory-api-model/api.ts b/src/api-models/vendor-direct-fulfillment-inventory-api-model/api.ts index 8ab1fb9d..ed40f9d9 100644 --- a/src/api-models/vendor-direct-fulfillment-inventory-api-model/api.ts +++ b/src/api-models/vendor-direct-fulfillment-inventory-api-model/api.ts @@ -34,7 +34,7 @@ export interface InventoryUpdate { */ sellingParty: PartyIdentification; /** - * When `true`, this request contains a full feed. When `false`, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an inventory update. The status of other items will remain unchanged. + * When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged. * @type {boolean} * @memberof InventoryUpdate */ @@ -53,13 +53,13 @@ export interface InventoryUpdate { */ export interface ItemDetails { /** - * The buyer-selected product identification for the item. Either `buyerProductIdentifier` or `vendorProductIdentifier` must be submitted. + * The buyer selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted. * @type {string} * @memberof ItemDetails */ buyerProductIdentifier?: string; /** - * The vendor selected product identification for the item. Either `buyerProductIdentifier` or `vendorProductIdentifier` must be submitted. + * The vendor selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted. * @type {string} * @memberof ItemDetails */ @@ -71,14 +71,14 @@ export interface ItemDetails { */ availableQuantity: ItemQuantity; /** - * When `true`, the item is permanently unavailable. + * When true, the item is permanently unavailable. * @type {boolean} * @memberof ItemDetails */ isObsolete?: boolean; } /** - * Details about item quantity. + * Details of item quantity. * @export * @interface ItemQuantity */ @@ -122,7 +122,7 @@ export interface ModelError { details?: string; } /** - * Name, address and tax details for a group. + * Name, address and tax details of a party. * @export * @interface PartyIdentification */ @@ -135,7 +135,7 @@ export interface PartyIdentification { partyId: string; } /** - * The request body for the `submitInventoryUpdate` operation. + * The request body for the submitInventoryUpdate operation. * @export * @interface SubmitInventoryUpdateRequest */ @@ -148,7 +148,7 @@ export interface SubmitInventoryUpdateRequest { inventory?: InventoryUpdate; } /** - * The response schema for the `submitInventoryUpdate` operation. + * The response schema for the submitInventoryUpdate operation. * @export * @interface SubmitInventoryUpdateResponse */ @@ -167,7 +167,7 @@ export interface SubmitInventoryUpdateResponse { errors?: Array; } /** - * A response that contains the transaction ID. + * Response containing the transaction ID. * @export * @interface TransactionReference */ @@ -187,9 +187,9 @@ export interface TransactionReference { export const UpdateInventoryApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the operation, 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 *SP-API*](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **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, 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} warehouseId Identifier for the warehouse for which to update inventory. - * @param {SubmitInventoryUpdateRequest} body The request body that contains the inventory update data to submit. + * @param {SubmitInventoryUpdateRequest} body The request body containing the inventory update data to submit. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -236,9 +236,9 @@ export const UpdateInventoryApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UpdateInventoryApiAxiosParamCreator(configuration) return { /** - * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the operation, 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 *SP-API*](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **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, 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} warehouseId Identifier for the warehouse for which to update inventory. - * @param {SubmitInventoryUpdateRequest} body The request body that contains the inventory update data to submit. + * @param {SubmitInventoryUpdateRequest} body The request body containing the inventory update data to submit. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -257,9 +257,9 @@ export const UpdateInventoryApiFactory = function (configuration?: Configuration const localVarFp = UpdateInventoryApiFp(configuration) return { /** - * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the operation, 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 *SP-API*](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **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, 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} warehouseId Identifier for the warehouse for which to update inventory. - * @param {SubmitInventoryUpdateRequest} body The request body that contains the inventory update data to submit. + * @param {SubmitInventoryUpdateRequest} body The request body containing the inventory update data to submit. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -283,7 +283,7 @@ export interface UpdateInventoryApiSubmitInventoryUpdateRequest { readonly warehouseId: string /** - * The request body that contains the inventory update data to submit. + * The request body containing the inventory update data to submit. * @type {SubmitInventoryUpdateRequest} * @memberof UpdateInventoryApiSubmitInventoryUpdate */ @@ -298,7 +298,7 @@ export interface UpdateInventoryApiSubmitInventoryUpdateRequest { */ export class UpdateInventoryApi extends BaseAPI { /** - * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the operation, 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 *SP-API*](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. **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, 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 {UpdateInventoryApiSubmitInventoryUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/vendor-direct-fulfillment-orders-api-model/api.ts b/src/api-models/vendor-direct-fulfillment-orders-api-model/api.ts index edcd34e8..8a626b35 100644 --- a/src/api-models/vendor-direct-fulfillment-orders-api-model/api.ts +++ b/src/api-models/vendor-direct-fulfillment-orders-api-model/api.ts @@ -47,7 +47,7 @@ export interface AcknowledgementStatus { */ export interface Address { /** - * The name of the person, business, or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. + * The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ @@ -77,19 +77,19 @@ export interface Address { */ addressLine3?: string; /** - * The city where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. + * The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ city?: string; /** - * The county where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. + * The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ county?: string; /** - * The district where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. + * The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ @@ -113,7 +113,7 @@ export interface Address { */ countryCode: string; /** - * The phone number of the person, business, or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. + * The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ @@ -396,7 +396,7 @@ export enum OrderDetailsOrderStatusEnum { } /** - * The total tax object within the shipment that relates to the order. + * The total Tax object within shipment that relates to the order. * @export * @interface OrderDetailsTaxTotal */ @@ -409,7 +409,7 @@ export interface OrderDetailsTaxTotal { taxLineItem?: Array; } /** - * An order item. + * An item within an order * @export * @interface OrderItem */ @@ -476,7 +476,7 @@ export interface OrderItem { totalPrice?: Money; } /** - * Individual item details within the acknowledged order. + * Details of an individual item within the order being acknowledged. * @export * @interface OrderItemAcknowledgement */ @@ -520,7 +520,7 @@ export interface OrderItemTaxDetails { taxLineItem?: Array; } /** - * A purchase orders list returned as a response. + * A list of purchase orders returned as response. * @export * @interface OrderList */ @@ -532,7 +532,7 @@ export interface OrderList { */ pagination?: Pagination; /** - * Represents a purchase order within the `OrderList`. + * Represents a purchase order within the OrderList. * @type {Array} * @memberof OrderList */ @@ -552,7 +552,7 @@ export interface Pagination { nextToken?: string; } /** - * Name, address, and tax details of a party. + * Name, address and tax details of a party. * @export * @interface PartyIdentification */ @@ -702,7 +702,7 @@ export interface SubmitAcknowledgementResponse { errors?: Array; } /** - * The order\'s tax details. + * The tax details related to the order. * @export * @interface TaxDetails */ @@ -789,7 +789,7 @@ export enum TaxRegistrationDetailsTaxRegistrationTypeEnum { } /** - * Response that contains the transaction ID. + * Response containing the transaction ID. * @export * @interface TransactionId */ @@ -920,7 +920,7 @@ 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, 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 {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement. + * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -992,7 +992,7 @@ export const VendorOrdersApiFp = function(configuration?: 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, 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 {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement. + * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1037,7 +1037,7 @@ export const VendorOrdersApiFactory = function (configuration?: Configuration, b }, /** * 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, 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 {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement. + * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1131,7 +1131,7 @@ export interface VendorOrdersApiGetOrdersRequest { */ export interface VendorOrdersApiSubmitAcknowledgementRequest { /** - * The request body that contains the order acknowledgement. + * The request body containing the acknowledgement to an order. * @type {SubmitAcknowledgementRequest} * @memberof VendorOrdersApiSubmitAcknowledgement */ diff --git a/src/api-models/vendor-direct-fulfillment-payments-api-model/api.ts b/src/api-models/vendor-direct-fulfillment-payments-api-model/api.ts index ed1859e3..6062f45c 100644 --- a/src/api-models/vendor-direct-fulfillment-payments-api-model/api.ts +++ b/src/api-models/vendor-direct-fulfillment-payments-api-model/api.ts @@ -22,7 +22,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** - * A field where the selling party provides additional information. + * A field where the selling party can provide additional information for tax-related or any other purposes. * @export * @interface AdditionalDetails */ @@ -170,7 +170,7 @@ export enum ChargeDetailsTypeEnum { } /** - * Represents the invoice details, including the invoice number, date, parties involved, payment terms, totals, taxes, charges, and line items. + * Represents the details of an invoice, including invoice number, date, parties involved, payment terms, totals, taxes, charges, and line items. * @export * @interface InvoiceDetail */ @@ -255,7 +255,7 @@ export interface InvoiceDetail { items: Array; } /** - * Details of the invoice items. + * Provides the details of the items in this invoice. * @export * @interface InvoiceItem */ @@ -385,7 +385,7 @@ export interface Money { amount: string; } /** - * Name, address, and tax details of a party. + * Name, address and tax details of a party. * @export * @interface PartyIdentification */ @@ -416,7 +416,7 @@ export interface PartyIdentification { */ export interface SubmitInvoiceRequest { /** - * An array of invoice details you want to submit. + * An array of invoice details to be submitted. * @type {Array} * @memberof SubmitInvoiceRequest */ @@ -507,7 +507,7 @@ export interface TaxRegistrationDetail { */ taxRegistrationType?: TaxRegistrationDetailTaxRegistrationTypeEnum | 'VAT' | 'GST'; /** - * Tax registration number for the entity. For example, VAT ID or Consumption Tax ID. + * Tax registration number for the entity. For example, VAT ID, Consumption Tax ID. * @type {string} * @memberof TaxRegistrationDetail */ @@ -536,7 +536,7 @@ export enum TaxRegistrationDetailTaxRegistrationTypeEnum { } /** - * Response that contains the transaction ID. + * Response containing the transaction ID. * @export * @interface TransactionReference */ @@ -556,8 +556,8 @@ export interface TransactionReference { export const VendorInvoiceApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Submits one or more invoices for a vendor\'s direct fulfillment 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 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 {SubmitInvoiceRequest} body The request body that contains one or more invoices for vendor orders. + * Submits one or more invoices for a vendor\'s direct fulfillment 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, 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 {SubmitInvoiceRequest} body The request body containing one or more invoices for vendor orders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -601,8 +601,8 @@ export const VendorInvoiceApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VendorInvoiceApiAxiosParamCreator(configuration) return { /** - * Submits one or more invoices for a vendor\'s direct fulfillment 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 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 {SubmitInvoiceRequest} body The request body that contains one or more invoices for vendor orders. + * Submits one or more invoices for a vendor\'s direct fulfillment 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, 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 {SubmitInvoiceRequest} body The request body containing one or more invoices for vendor orders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -621,8 +621,8 @@ export const VendorInvoiceApiFactory = function (configuration?: Configuration, const localVarFp = VendorInvoiceApiFp(configuration) return { /** - * Submits one or more invoices for a vendor\'s direct fulfillment 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 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 {SubmitInvoiceRequest} body The request body that contains one or more invoices for vendor orders. + * Submits one or more invoices for a vendor\'s direct fulfillment 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, 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 {SubmitInvoiceRequest} body The request body containing one or more invoices for vendor orders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -639,7 +639,7 @@ export const VendorInvoiceApiFactory = function (configuration?: Configuration, */ export interface VendorInvoiceApiSubmitInvoiceRequest { /** - * The request body that contains one or more invoices for vendor orders. + * The request body containing one or more invoices for vendor orders. * @type {SubmitInvoiceRequest} * @memberof VendorInvoiceApiSubmitInvoice */ @@ -654,7 +654,7 @@ export interface VendorInvoiceApiSubmitInvoiceRequest { */ export class VendorInvoiceApi extends BaseAPI { /** - * Submits one or more invoices for a vendor\'s direct fulfillment 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 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 one or more invoices for a vendor\'s direct fulfillment 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, 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 {VendorInvoiceApiSubmitInvoiceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/vendor-direct-fulfillment-sandbox-test-data-api-model/api.ts b/src/api-models/vendor-direct-fulfillment-sandbox-test-data-api-model/api.ts index 7d0d19b5..3f761a61 100644 --- a/src/api-models/vendor-direct-fulfillment-sandbox-test-data-api-model/api.ts +++ b/src/api-models/vendor-direct-fulfillment-sandbox-test-data-api-model/api.ts @@ -28,14 +28,14 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr */ export interface ErrorList { /** - * An array of individual error objects that contain error details. + * An array of individual error objects containing error details. * @type {Array} * @memberof ErrorList */ errors: Array; } /** - * The `generateOrderScenarios` request body. + * The request body for the generateOrderScenarios operation. * @export * @interface GenerateOrderScenarioRequest */ @@ -92,26 +92,26 @@ export interface OrderScenarioRequest { shipFromParty: PartyIdentification; } /** - * 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 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 order items to return. * @export * @interface Pagination */ export interface Pagination { /** - * A generated token that retrieves the next set of results. This token is specified in the next request. + * A generated token to be passed in the next request to retrieve the next set of results. * @type {string} * @memberof Pagination */ nextToken?: string; } /** - * The identification object for the party information. For example, warehouse code or vendor code. + * The identification object for the party information. For example, warehouse code or vendor code. Please refer to specific party for more details. * @export * @interface PartyIdentification */ export interface PartyIdentification { /** - * Assigned identification for the party. For example, warehouse code or vendor code. + * Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details. * @type {string} * @memberof PartyIdentification */ @@ -163,13 +163,13 @@ export interface TestOrder { orderId: string; } /** - * The transaction details that include the status. If the transaction is successful, also includes the requested test order data. + * The transaction details including the status. If the transaction was successful, also includes the requested test order data. * @export * @interface Transaction */ export interface Transaction { /** - * The unique identifier returned in the response for the `generateOrderScenarios` request. + * The unique identifier returned in the response to the generateOrderScenarios request. * @type {string} * @memberof Transaction */ @@ -212,7 +212,7 @@ export interface TransactionReference { transactionId?: string; } /** - * The payload for `getOrderScenarios`. + * The payload for the getOrderScenarios operation. * @export * @interface TransactionStatus */ @@ -233,7 +233,7 @@ export const VendorDFSandboxApiAxiosParamCreator = function (configuration?: Con return { /** * Submits a request to generate test order data for Vendor Direct Fulfillment API entities. - * @param {GenerateOrderScenarioRequest} body The request payload that contain parameters to generate test order data scenarios. + * @param {GenerateOrderScenarioRequest} body The request payload containing parameters for generating test order data scenarios. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -278,7 +278,7 @@ export const VendorDFSandboxApiFp = function(configuration?: Configuration) { return { /** * Submits a request to generate test order data for Vendor Direct Fulfillment API entities. - * @param {GenerateOrderScenarioRequest} body The request payload that contain parameters to generate test order data scenarios. + * @param {GenerateOrderScenarioRequest} body The request payload containing parameters for generating test order data scenarios. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -298,7 +298,7 @@ export const VendorDFSandboxApiFactory = function (configuration?: Configuration return { /** * Submits a request to generate test order data for Vendor Direct Fulfillment API entities. - * @param {GenerateOrderScenarioRequest} body The request payload that contain parameters to generate test order data scenarios. + * @param {GenerateOrderScenarioRequest} body The request payload containing parameters for generating test order data scenarios. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -315,7 +315,7 @@ export const VendorDFSandboxApiFactory = function (configuration?: Configuration */ export interface VendorDFSandboxApiGenerateOrderScenariosRequest { /** - * The request payload that contain parameters to generate test order data scenarios. + * The request payload containing parameters for generating test order data scenarios. * @type {GenerateOrderScenarioRequest} * @memberof VendorDFSandboxApiGenerateOrderScenarios */ @@ -349,8 +349,8 @@ export class VendorDFSandboxApi extends BaseAPI { export const VendorDFSandboxtransactionstatusApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test order data if the transaction is successful. - * @param {string} transactionId The transaction identifier returned in the response for the `generateOrderScenarios` operation. + * Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data. + * @param {string} transactionId The transaction identifier returned in the response to the generateOrderScenarios operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -392,8 +392,8 @@ export const VendorDFSandboxtransactionstatusApiFp = function(configuration?: Co const localVarAxiosParamCreator = VendorDFSandboxtransactionstatusApiAxiosParamCreator(configuration) return { /** - * Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test order data if the transaction is successful. - * @param {string} transactionId The transaction identifier returned in the response for the `generateOrderScenarios` operation. + * Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data. + * @param {string} transactionId The transaction identifier returned in the response to the generateOrderScenarios operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -412,8 +412,8 @@ export const VendorDFSandboxtransactionstatusApiFactory = function (configuratio const localVarFp = VendorDFSandboxtransactionstatusApiFp(configuration) return { /** - * Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test order data if the transaction is successful. - * @param {string} transactionId The transaction identifier returned in the response for the `generateOrderScenarios` operation. + * Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data. + * @param {string} transactionId The transaction identifier returned in the response to the generateOrderScenarios operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -430,7 +430,7 @@ export const VendorDFSandboxtransactionstatusApiFactory = function (configuratio */ export interface VendorDFSandboxtransactionstatusApiGetOrderScenariosRequest { /** - * The transaction identifier returned in the response for the `generateOrderScenarios` operation. + * The transaction identifier returned in the response to the generateOrderScenarios operation. * @type {string} * @memberof VendorDFSandboxtransactionstatusApiGetOrderScenarios */ @@ -445,7 +445,7 @@ export interface VendorDFSandboxtransactionstatusApiGetOrderScenariosRequest { */ export class VendorDFSandboxtransactionstatusApi extends BaseAPI { /** - * Retrieves the transaction status identified by the specified `transactionId`, and returns the requested test order data if the transaction is successful. + * Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data. * @param {VendorDFSandboxtransactionstatusApiGetOrderScenariosRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/vendor-direct-fulfillment-shipping-api-model-v20211228/api.ts b/src/api-models/vendor-direct-fulfillment-shipping-api-model-v20211228/api.ts index 677c280c..70670d78 100644 --- a/src/api-models/vendor-direct-fulfillment-shipping-api-model-v20211228/api.ts +++ b/src/api-models/vendor-direct-fulfillment-shipping-api-model-v20211228/api.ts @@ -95,7 +95,16 @@ export interface Address { phone?: string; } /** - * A container for shipping and packing items. + * Unique carrier code for the carrier for whom container labels are requested. + * @export + * @enum {string} + */ +export enum CarrierId { + Swa = 'SWA' +} + +/** + * A container used for shipping and packing items. * @export * @interface Container */ @@ -183,6 +192,91 @@ export enum ContainerContainerTypeEnum { Pallet = 'Pallet' } +/** + * Details of the container label. + * @export + * @interface ContainerLabel + */ +export interface ContainerLabel { + /** + * Container (pallet) tracking identifier from the shipping carrier. + * @type {string} + * @memberof ContainerLabel + */ + containerTrackingNumber?: string; + /** + * This field will contain the Base64encoded string of the container label content. + * @type {string} + * @memberof ContainerLabel + */ + content: string; + /** + * + * @type {ContainerLabelFormat} + * @memberof ContainerLabel + */ + format: ContainerLabelFormat | 'PNG' | 'ZPL'; +} +/** + * Format of the container label. + * @export + * @enum {string} + */ +export enum ContainerLabelFormat { + Png = 'PNG', + Zpl = 'ZPL' +} + +/** + * The request body schema for the createContainerLabel operation. + * @export + * @interface CreateContainerLabelRequest + */ +export interface CreateContainerLabelRequest { + /** + * + * @type {PartyIdentification} + * @memberof CreateContainerLabelRequest + */ + sellingParty: PartyIdentification; + /** + * + * @type {PartyIdentification} + * @memberof CreateContainerLabelRequest + */ + shipFromParty: PartyIdentification; + /** + * + * @type {CarrierId} + * @memberof CreateContainerLabelRequest + */ + carrierId: CarrierId | 'SWA'; + /** + * unique identifier for the container provided by the vendor. + * @type {string} + * @memberof CreateContainerLabelRequest + */ + vendorContainerId: string; + /** + * Array of package object in order to associate shipments packages with given container. + * @type {Array} + * @memberof CreateContainerLabelRequest + */ + packages: Array; +} +/** + * The response schema for the createContainerLabel operation. + * @export + * @interface CreateContainerLabelResponse + */ +export interface CreateContainerLabelResponse { + /** + * + * @type {ContainerLabel} + * @memberof CreateContainerLabelResponse + */ + containerLabel: ContainerLabel; +} /** * The request body for the createShippingLabels operation. * @export @@ -240,7 +334,7 @@ export interface CustomerInvoiceList { */ pagination?: Pagination; /** - * Represents a customer invoice within the `CustomerInvoiceList`. + * Represents a customer invoice within the CustomerInvoiceList. * @type {Array} * @memberof CustomerInvoiceList */ @@ -294,7 +388,7 @@ export enum DimensionsUnitOfMeasureEnum { */ export interface ErrorList { /** - * An array of error objects that represents individual errors encountered during the request. + * An array of Error objects representing individual errors encountered during the request. * @type {Array} * @memberof ErrorList */ @@ -413,7 +507,20 @@ export interface ModelError { details?: string; } /** - * Represents an item packed into a container for shipping. + * Object describing Package that is going to be associated with given container. + * @export + * @interface Package + */ +export interface Package { + /** + * tracking identifier present on label of shipment package. Tracking number can be fetched from fetched from shippingLabels API response. Alternatively bar code on the shipping label can be scanned by the scanner to get the tracking number. + * @type {string} + * @memberof Package + */ + packageTrackingNumber: string; +} +/** + * Represents an item that has been packed into a container for shipping. * @export * @interface PackedItem */ @@ -516,7 +623,7 @@ export interface Pagination { nextToken?: string; } /** - * Name, address, and tax details for a party. + * Name, address and tax details of a party. * @export * @interface PartyIdentification */ @@ -541,7 +648,7 @@ export interface PartyIdentification { taxRegistrationDetails?: Array; } /** - * Represents the confirmation details of a shipment. Includes the purchase order number and other shipment details. + * Represents the confirmation details of a shipment, including the purchase order number and other shipment details. * @export * @interface ShipmentConfirmation */ @@ -656,7 +763,7 @@ export interface ShipmentSchedule { apptWindowEndDateTime?: string; } /** - * Represents a shipment status update. + * Represents an update to the status of a shipment. * @export * @interface ShipmentStatusUpdate */ @@ -687,7 +794,7 @@ export interface ShipmentStatusUpdate { statusUpdateDetails: StatusUpdateDetails; } /** - * Shipping label information for an order. Includes the purchase order number, selling party, ship from party, label format, and package details. + * Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details. * @export * @interface ShippingLabel */ @@ -734,7 +841,7 @@ export enum ShippingLabelLabelFormatEnum { } /** - * Response payload with the shipping labels list. + * Response payload with the list of shipping labels. * @export * @interface ShippingLabelList */ @@ -746,14 +853,14 @@ export interface ShippingLabelList { */ pagination?: Pagination; /** - * An array that contains the details of the generated shipping labels. + * An array containing the details of the generated shipping labels. * @type {Array} * @memberof ShippingLabelList */ shippingLabels?: Array; } /** - * Represents the request payload to create a shipping label. Contains the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment. + * Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment. * @export * @interface ShippingLabelRequest */ @@ -796,13 +903,13 @@ export interface StatusUpdateDetails { */ trackingNumber: string; /** - * The shipment status code for the package that provides transportation information for Amazon tracking systems and the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). + * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). * @type {string} * @memberof StatusUpdateDetails */ statusCode: string; /** - * Provides a reason code for the package status that provides additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). + * Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). * @type {string} * @memberof StatusUpdateDetails */ @@ -827,39 +934,39 @@ export interface StatusUpdateDetails { shipmentSchedule?: ShipmentSchedule; } /** - * The `submitShipmentConfirmations` request schema. + * The request schema for the submitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsRequest */ export interface SubmitShipmentConfirmationsRequest { /** - * An array of `ShipmentConfirmation` objects, each represents confirmation details for a specific shipment. + * Array of ShipmentConfirmation objects, each representing confirmation details for a specific shipment. * @type {Array} * @memberof SubmitShipmentConfirmationsRequest */ shipmentConfirmations?: Array; } /** - * The `submitShipmentStatusUpdates` request schema. + * The request schema for the submitShipmentStatusUpdates operation. * @export * @interface SubmitShipmentStatusUpdatesRequest */ export interface SubmitShipmentStatusUpdatesRequest { /** - * Contains a list of one or more `ShipmentStatusUpdate` objects, each represents a status update of a specific shipment. + * Contains a list of one or more ShipmentStatusUpdate objects, each representing an update to the status of a specific shipment. * @type {Array} * @memberof SubmitShipmentStatusUpdatesRequest */ shipmentStatusUpdates?: Array; } /** - * The request schema for the `submitShippingLabelRequest` operation. + * The request schema for the submitShippingLabelRequest operation. * @export * @interface SubmitShippingLabelsRequest */ export interface SubmitShippingLabelsRequest { /** - * An array of shipping label requests you want to process. + * An array of shipping label requests to be processed. * @type {Array} * @memberof SubmitShippingLabelsRequest */ @@ -907,7 +1014,7 @@ export enum TaxRegistrationDetailsTaxRegistrationTypeEnum { } /** - * Response that contains the transaction ID. + * Response containing the transaction ID. * @export * @interface TransactionReference */ @@ -1363,7 +1470,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }, /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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 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 {SubmitShipmentStatusUpdatesRequest} body Request body that contains the shipment status update data. + * @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1443,7 +1550,7 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { }, /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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 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 {SubmitShipmentStatusUpdatesRequest} body Request body that contains the shipment status update data. + * @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1495,7 +1602,7 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, }, /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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 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 {SubmitShipmentStatusUpdatesRequest} body Request body that contains the shipment status update data. + * @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1589,7 +1696,7 @@ export interface VendorShippingApiSubmitShipmentConfirmationsRequest { */ export interface VendorShippingApiSubmitShipmentStatusUpdatesRequest { /** - * Request body that contains the shipment status update data. + * Request body containing the shipment status update data. * @type {SubmitShipmentStatusUpdatesRequest} * @memberof VendorShippingApiSubmitShipmentStatusUpdates */ @@ -1658,7 +1765,7 @@ export const VendorShippingLabelsApiAxiosParamCreator = function (configuration? /** * Creates shipping labels for a purchase order and returns the labels. **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 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} purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same purchaseOrderNumber as received in the order. - * @param {CreateShippingLabelsRequest} body The request payload that contains parameters for creating shipping labels. + * @param {CreateShippingLabelsRequest} body The request payload containing parameters for creating shipping labels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1696,7 +1803,7 @@ export const VendorShippingLabelsApiAxiosParamCreator = function (configuration? }, /** * Returns a shipping label for the purchaseOrderNumber 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 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} purchaseOrderNumber The purchase order number for which you want to return the shipping label. Should be the same `purchaseOrderNumber` as received in the order. + * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label and should be the same purchaseOrderNumber as received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1796,7 +1903,7 @@ export const VendorShippingLabelsApiAxiosParamCreator = function (configuration? }, /** * Creates a shipping label for a purchase order and returns a transactionId for reference. **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 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 {SubmitShippingLabelsRequest} body Request body that contains the shipping labels data. + * @param {SubmitShippingLabelsRequest} body Request body containing the shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1842,7 +1949,7 @@ export const VendorShippingLabelsApiFp = function(configuration?: Configuration) /** * Creates shipping labels for a purchase order and returns the labels. **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 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} purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same purchaseOrderNumber as received in the order. - * @param {CreateShippingLabelsRequest} body The request payload that contains parameters for creating shipping labels. + * @param {CreateShippingLabelsRequest} body The request payload containing parameters for creating shipping labels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1852,7 +1959,7 @@ export const VendorShippingLabelsApiFp = function(configuration?: Configuration) }, /** * Returns a shipping label for the purchaseOrderNumber 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 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} purchaseOrderNumber The purchase order number for which you want to return the shipping label. Should be the same `purchaseOrderNumber` as received in the order. + * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label and should be the same purchaseOrderNumber as received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1877,7 +1984,7 @@ export const VendorShippingLabelsApiFp = function(configuration?: Configuration) }, /** * Creates a shipping label for a purchase order and returns a transactionId for reference. **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 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 {SubmitShippingLabelsRequest} body Request body that contains the shipping labels data. + * @param {SubmitShippingLabelsRequest} body Request body containing the shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1898,7 +2005,7 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur /** * Creates shipping labels for a purchase order and returns the labels. **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 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} purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same purchaseOrderNumber as received in the order. - * @param {CreateShippingLabelsRequest} body The request payload that contains parameters for creating shipping labels. + * @param {CreateShippingLabelsRequest} body The request payload containing parameters for creating shipping labels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1907,7 +2014,7 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur }, /** * Returns a shipping label for the purchaseOrderNumber 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 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} purchaseOrderNumber The purchase order number for which you want to return the shipping label. Should be the same `purchaseOrderNumber` as received in the order. + * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label and should be the same purchaseOrderNumber as received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1930,7 +2037,7 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur }, /** * Creates a shipping label for a purchase order and returns a transactionId for reference. **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 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 {SubmitShippingLabelsRequest} body Request body that contains the shipping labels data. + * @param {SubmitShippingLabelsRequest} body Request body containing the shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1954,7 +2061,7 @@ export interface VendorShippingLabelsApiCreateShippingLabelsRequest { readonly purchaseOrderNumber: string /** - * The request payload that contains parameters for creating shipping labels. + * The request payload containing parameters for creating shipping labels. * @type {CreateShippingLabelsRequest} * @memberof VendorShippingLabelsApiCreateShippingLabels */ @@ -1968,7 +2075,7 @@ export interface VendorShippingLabelsApiCreateShippingLabelsRequest { */ export interface VendorShippingLabelsApiGetShippingLabelRequest { /** - * The purchase order number for which you want to return the shipping label. Should be the same `purchaseOrderNumber` as received in the order. + * The purchase order number for which you want to return the shipping label and should be the same purchaseOrderNumber as received in the order. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabel */ @@ -2031,7 +2138,7 @@ export interface VendorShippingLabelsApiGetShippingLabelsRequest { */ export interface VendorShippingLabelsApiSubmitShippingLabelRequestRequest { /** - * Request body that contains the shipping labels data. + * Request body containing the shipping labels data. * @type {SubmitShippingLabelsRequest} * @memberof VendorShippingLabelsApiSubmitShippingLabelRequest */ diff --git a/src/api-models/vendor-direct-fulfillment-shipping-api-model/api.ts b/src/api-models/vendor-direct-fulfillment-shipping-api-model/api.ts index 686dcdce..e4a748cb 100644 --- a/src/api-models/vendor-direct-fulfillment-shipping-api-model/api.ts +++ b/src/api-models/vendor-direct-fulfillment-shipping-api-model/api.ts @@ -196,7 +196,7 @@ export interface CustomerInvoice { */ purchaseOrderNumber: string; /** - * The `Base64encoded` customer invoice. + * The Base64encoded customer invoice. * @type {string} * @memberof CustomerInvoice */ @@ -215,7 +215,7 @@ export interface CustomerInvoiceList { */ pagination?: Pagination; /** - * Represents a customer invoice within the `CustomerInvoiceList`. + * Represents a customer invoice within the CustomerInvoiceList. * @type {Array} * @memberof CustomerInvoiceList */ @@ -263,7 +263,7 @@ export enum DimensionsUnitOfMeasureEnum { } /** - * The response schema for the `getCustomerInvoice` operation. + * The response schema for the getCustomerInvoice operation. * @export * @interface GetCustomerInvoiceResponse */ @@ -282,7 +282,7 @@ export interface GetCustomerInvoiceResponse { errors?: Array; } /** - * The response schema for the `getCustomerInvoices` operation. + * The response schema for the getCustomerInvoices operation. * @export * @interface GetCustomerInvoicesResponse */ @@ -301,7 +301,7 @@ export interface GetCustomerInvoicesResponse { errors?: Array; } /** - * Response payload with the list of packing slips. + * Response payload with the list of Packing Slips. * @export * @interface GetPackingSlipListResponse */ @@ -339,7 +339,7 @@ export interface GetPackingSlipResponse { errors?: Array; } /** - * The response schema for the `getShippingLabels` operation. + * The response schema for the getShippingLabels operation. * @export * @interface GetShippingLabelListResponse */ @@ -358,7 +358,7 @@ export interface GetShippingLabelListResponse { errors?: Array; } /** - * The response schema for the `getShippingLabel` operation. + * The response schema for the getShippingLabel operation. * @export * @interface GetShippingLabelResponse */ @@ -389,7 +389,7 @@ export interface Item { */ itemSequenceNumber: number; /** - * Buyer\'s Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required. + * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required. * @type {string} * @memberof Item */ @@ -445,7 +445,7 @@ export interface LabelData { */ trackingNumber?: string; /** - * Ship method to be used for shipping the order. Amazon defines ship method codes indicating shipping carrier and shipment service level. Ship method codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the ship method codes are vendor specific and will be provided to each vendor during the implementation. + * Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation. * @type {string} * @memberof LabelData */ @@ -501,7 +501,7 @@ export interface PackedItem { */ itemSequenceNumber: number; /** - * Buyer\'s Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required. + * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required. * @type {string} * @memberof PackedItem */ @@ -579,7 +579,7 @@ export interface PackingSlipList { */ 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 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 order items to return. * @type {string} * @memberof Pagination */ @@ -835,25 +835,25 @@ export interface ShippingLabelRequest { */ export interface StatusUpdateDetails { /** - * This is required to be provided for every package and should match with the `trackingNumber` sent for the shipment confirmation. + * This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation. * @type {string} * @memberof StatusUpdateDetails */ trackingNumber: string; /** - * Indicates the shipment status code for the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). + * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). * @type {string} * @memberof StatusUpdateDetails */ statusCode: string; /** - * Provides a reason code for the status for the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). + * Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). * @type {string} * @memberof StatusUpdateDetails */ reasonCode: string; /** - * The date and time when the shipment status was updated. This field is expected to be in ISO 8601 date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`. + * The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof StatusUpdateDetails */ @@ -878,39 +878,39 @@ export interface StatusUpdateDetails { */ export interface StatusUpdateDetailsShipmentSchedule { /** - * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO 8601 date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`. + * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof StatusUpdateDetailsShipmentSchedule */ estimatedDeliveryDateTime?: string; /** - * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO 8601 date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`. + * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof StatusUpdateDetailsShipmentSchedule */ apptWindowStartDateTime?: string; /** - * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO 8601 date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`. + * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof StatusUpdateDetailsShipmentSchedule */ apptWindowEndDateTime?: string; } /** - * The request schema for the `submitShipmentConfirmations` operation. + * The request schema for the submitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsRequest */ export interface SubmitShipmentConfirmationsRequest { /** - * Array of `ShipmentConfirmation` objects, each representing confirmation details for a specific shipment. + * Array of ShipmentConfirmation objects, each representing confirmation details for a specific shipment. * @type {Array} * @memberof SubmitShipmentConfirmationsRequest */ shipmentConfirmations?: Array; } /** - * The response schema for the `submitShipmentConfirmations` operation. + * The response schema for the submitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsResponse */ @@ -929,20 +929,20 @@ export interface SubmitShipmentConfirmationsResponse { errors?: Array; } /** - * Represents the request payload for submitting updates to the status of shipments, containing an array of one or more `ShipmentStatusUpdate` objects. + * Represents the request payload for submitting updates to the status of shipments, containing an array of one or more ShipmentStatusUpdate objects. * @export * @interface SubmitShipmentStatusUpdatesRequest */ export interface SubmitShipmentStatusUpdatesRequest { /** - * Contains a list of one or more `ShipmentStatusUpdate` objects, each representing an update to the status of a specific shipment. + * Contains a list of one or more ShipmentStatusUpdate objects, each representing an update to the status of a specific shipment. * @type {Array} * @memberof SubmitShipmentStatusUpdatesRequest */ shipmentStatusUpdates?: Array; } /** - * The response schema for the `submitShipmentStatusUpdates` operation. + * The response schema for the submitShipmentStatusUpdates operation. * @export * @interface SubmitShipmentStatusUpdatesResponse */ @@ -961,7 +961,7 @@ export interface SubmitShipmentStatusUpdatesResponse { errors?: Array; } /** - * The request schema for the `submitShippingLabelRequest` operation. + * The request schema for the submitShippingLabelRequest operation. * @export * @interface SubmitShippingLabelsRequest */ @@ -974,7 +974,7 @@ export interface SubmitShippingLabelsRequest { shippingLabelRequests?: Array; } /** - * The response schema for the `submitShippingLabelRequest` operation. + * The response schema for the submitShippingLabelRequest operation. * @export * @interface SubmitShippingLabelsResponse */ @@ -1083,7 +1083,7 @@ export enum WeightUnitOfMeasureEnum { export const CustomerInvoicesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a customer invoice based on the `purchaseOrderNumber` 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 customer invoice based on the purchaseOrderNumber 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, 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} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1116,10 +1116,10 @@ export const CustomerInvoicesApiAxiosParamCreator = function (configuration?: Co }; }, /** - * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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 {string} createdAfter Orders that became available after this date and 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 Orders that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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, 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} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. @@ -1193,7 +1193,7 @@ export const CustomerInvoicesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CustomerInvoicesApiAxiosParamCreator(configuration) return { /** - * Returns a customer invoice based on the `purchaseOrderNumber` 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 customer invoice based on the purchaseOrderNumber 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, 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} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1203,10 +1203,10 @@ export const CustomerInvoicesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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 {string} createdAfter Orders that became available after this date and 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 Orders that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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, 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} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. @@ -1228,7 +1228,7 @@ export const CustomerInvoicesApiFactory = function (configuration?: Configuratio const localVarFp = CustomerInvoicesApiFp(configuration) return { /** - * Returns a customer invoice based on the `purchaseOrderNumber` 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 customer invoice based on the purchaseOrderNumber 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, 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} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1237,10 +1237,10 @@ export const CustomerInvoicesApiFactory = function (configuration?: Configuratio return localVarFp.getCustomerInvoice(purchaseOrderNumber, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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 {string} createdAfter Orders that became available after this date and 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 Orders that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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, 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} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. @@ -1274,21 +1274,21 @@ export interface CustomerInvoicesApiGetCustomerInvoiceRequest { */ export interface CustomerInvoicesApiGetCustomerInvoicesRequest { /** - * Orders that became available after this date and 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. + * Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly createdAfter: string /** - * Orders that became available before this date and 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. + * Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly createdBefore: string /** - * The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ @@ -1324,7 +1324,7 @@ export interface CustomerInvoicesApiGetCustomerInvoicesRequest { */ export class CustomerInvoicesApi extends BaseAPI { /** - * Returns a customer invoice based on the `purchaseOrderNumber` 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 customer invoice based on the purchaseOrderNumber 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, 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 {CustomerInvoicesApiGetCustomerInvoiceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1335,7 +1335,7 @@ export class CustomerInvoicesApi extends BaseAPI { } /** - * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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 customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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, 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 {CustomerInvoicesApiGetCustomerInvoicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1354,8 +1354,8 @@ export class CustomerInvoicesApi extends BaseAPI { export const VendorShippingApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a packing slip based on the `purchaseOrderNumber` 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). - * @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip you want. + * Returns a packing slip based on the purchaseOrderNumber 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, 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} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1387,10 +1387,10 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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 {string} createdAfter Packing slips that became available after this date and 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 Packing slips that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses. + * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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, 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} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date. * @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. @@ -1454,7 +1454,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Submits one or more shipment confirmations for vendor 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 one or more shipment confirmations for vendor 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, 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 {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1489,7 +1489,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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). + * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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, 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 {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1534,8 +1534,8 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VendorShippingApiAxiosParamCreator(configuration) return { /** - * Returns a packing slip based on the `purchaseOrderNumber` 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). - * @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip you want. + * Returns a packing slip based on the purchaseOrderNumber 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, 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} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1544,10 +1544,10 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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 {string} createdAfter Packing slips that became available after this date and 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 Packing slips that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses. + * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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, 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} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date. * @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. @@ -1559,7 +1559,7 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Submits one or more shipment confirmations for vendor 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 one or more shipment confirmations for vendor 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, 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 {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1569,7 +1569,7 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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). + * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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, 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 {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1589,8 +1589,8 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, const localVarFp = VendorShippingApiFp(configuration) return { /** - * Returns a packing slip based on the `purchaseOrderNumber` 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). - * @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip you want. + * Returns a packing slip based on the purchaseOrderNumber 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, 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} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1598,10 +1598,10 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, return localVarFp.getPackingSlip(purchaseOrderNumber, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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 {string} createdAfter Packing slips that became available after this date and 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 Packing slips that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses. + * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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, 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} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date. * @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. @@ -1612,7 +1612,7 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, return localVarFp.getPackingSlips(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Submits one or more shipment confirmations for vendor 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 one or more shipment confirmations for vendor 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, 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 {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1621,7 +1621,7 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, return localVarFp.submitShipmentConfirmations(body, options).then((request) => request(axios, basePath)); }, /** - * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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). + * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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, 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 {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1639,7 +1639,7 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, */ export interface VendorShippingApiGetPackingSlipRequest { /** - * The `purchaseOrderNumber` for the packing slip you want. + * The purchaseOrderNumber for the packing slip you want. * @type {string} * @memberof VendorShippingApiGetPackingSlip */ @@ -1653,21 +1653,21 @@ export interface VendorShippingApiGetPackingSlipRequest { */ export interface VendorShippingApiGetPackingSlipsRequest { /** - * Packing slips that became available after this date and 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. + * Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly createdAfter: string /** - * Packing slips that became available before this date and 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. + * Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly createdBefore: string /** - * The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses. + * The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ @@ -1731,7 +1731,7 @@ export interface VendorShippingApiSubmitShipmentStatusUpdatesRequest { */ export class VendorShippingApi extends BaseAPI { /** - * Returns a packing slip based on the `purchaseOrderNumber` 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 packing slip based on the purchaseOrderNumber 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, 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 {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1742,7 +1742,7 @@ export class VendorShippingApi extends BaseAPI { } /** - * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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 packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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, 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 {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1753,7 +1753,7 @@ export class VendorShippingApi extends BaseAPI { } /** - * Submits one or more shipment confirmations for vendor 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 one or more shipment confirmations for vendor 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, 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 {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1764,7 +1764,7 @@ export class VendorShippingApi extends BaseAPI { } /** - * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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). + * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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, 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 {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1783,8 +1783,8 @@ export class VendorShippingApi extends BaseAPI { export const VendorShippingLabelsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a shipping label for the `purchaseOrderNumber` 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). - * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` as received in the order. + * Returns a shipping label for the purchaseOrderNumber 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, 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} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1816,10 +1816,10 @@ export const VendorShippingLabelsApiAxiosParamCreator = function (configuration? }; }, /** - * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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 {string} createdAfter Shipping labels that became available after this date and 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 Shipping labels that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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, 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} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned. * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. @@ -1883,7 +1883,7 @@ export const VendorShippingLabelsApiAxiosParamCreator = function (configuration? }; }, /** - * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **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). + * Creates a shipping label for a purchase order and returns a transactionId for reference. **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, 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 {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1928,8 +1928,8 @@ export const VendorShippingLabelsApiFp = function(configuration?: Configuration) const localVarAxiosParamCreator = VendorShippingLabelsApiAxiosParamCreator(configuration) return { /** - * Returns a shipping label for the `purchaseOrderNumber` 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). - * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` as received in the order. + * Returns a shipping label for the purchaseOrderNumber 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, 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} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1938,10 +1938,10 @@ export const VendorShippingLabelsApiFp = function(configuration?: Configuration) return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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 {string} createdAfter Shipping labels that became available after this date and 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 Shipping labels that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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, 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} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned. * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. @@ -1953,7 +1953,7 @@ export const VendorShippingLabelsApiFp = function(configuration?: Configuration) return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **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). + * Creates a shipping label for a purchase order and returns a transactionId for reference. **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, 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 {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1973,8 +1973,8 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur const localVarFp = VendorShippingLabelsApiFp(configuration) return { /** - * Returns a shipping label for the `purchaseOrderNumber` 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). - * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` as received in the order. + * Returns a shipping label for the purchaseOrderNumber 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, 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} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1982,10 +1982,10 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur return localVarFp.getShippingLabel(purchaseOrderNumber, options).then((request) => request(axios, basePath)); }, /** - * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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 {string} createdAfter Shipping labels that became available after this date and 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 Shipping labels that became available before this date and 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} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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, 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} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned. * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. @@ -1996,7 +1996,7 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur return localVarFp.getShippingLabels(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **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). + * Creates a shipping label for a purchase order and returns a transactionId for reference. **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, 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 {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2014,7 +2014,7 @@ export const VendorShippingLabelsApiFactory = function (configuration?: Configur */ export interface VendorShippingLabelsApiGetShippingLabelRequest { /** - * The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` as received in the order. + * The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabel */ @@ -2028,21 +2028,21 @@ export interface VendorShippingLabelsApiGetShippingLabelRequest { */ export interface VendorShippingLabelsApiGetShippingLabelsRequest { /** - * Shipping labels that became available after this date and 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. + * Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly createdAfter: string /** - * Shipping labels that became available before this date and 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. + * Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly createdBefore: string /** - * The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses. + * The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ @@ -2092,7 +2092,7 @@ export interface VendorShippingLabelsApiSubmitShippingLabelRequestRequest { */ export class VendorShippingLabelsApi extends BaseAPI { /** - * Returns a shipping label for the `purchaseOrderNumber` 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 shipping label for the purchaseOrderNumber 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, 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 {VendorShippingLabelsApiGetShippingLabelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2103,7 +2103,7 @@ export class VendorShippingLabelsApi extends BaseAPI { } /** - * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the `createdAfter` and `createdBefore` parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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 shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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, 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 {VendorShippingLabelsApiGetShippingLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2114,7 +2114,7 @@ export class VendorShippingLabelsApi extends BaseAPI { } /** - * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **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). + * Creates a shipping label for a purchase order and returns a transactionId for reference. **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, 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 {VendorShippingLabelsApiSubmitShippingLabelRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/vendor-direct-fulfillment-transactions-api-model-v20211228/api.ts b/src/api-models/vendor-direct-fulfillment-transactions-api-model-v20211228/api.ts index 02fe103c..20634201 100644 --- a/src/api-models/vendor-direct-fulfillment-transactions-api-model-v20211228/api.ts +++ b/src/api-models/vendor-direct-fulfillment-transactions-api-model-v20211228/api.ts @@ -96,7 +96,7 @@ export enum TransactionStatusEnum { } /** - * The payload for the `getTransactionStatus` operation. + * The payload for the getTransactionStatus operation. * @export * @interface TransactionStatus */ @@ -116,7 +116,7 @@ export interface TransactionStatus { export const VendorTransactionApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **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 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 status of the transaction indicated by the specified transactionId. **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 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} transactionId Previously returned in the response to the POST request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -159,7 +159,7 @@ export const VendorTransactionApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VendorTransactionApiAxiosParamCreator(configuration) return { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **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 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 status of the transaction indicated by the specified transactionId. **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 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} transactionId Previously returned in the response to the POST request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -179,7 +179,7 @@ export const VendorTransactionApiFactory = function (configuration?: Configurati const localVarFp = VendorTransactionApiFp(configuration) return { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **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 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 status of the transaction indicated by the specified transactionId. **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 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} transactionId Previously returned in the response to the POST request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -212,7 +212,7 @@ export interface VendorTransactionApiGetTransactionStatusRequest { */ export class VendorTransactionApi extends BaseAPI { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **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 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 status of the transaction indicated by the specified transactionId. **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 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 {VendorTransactionApiGetTransactionStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/vendor-direct-fulfillment-transactions-api-model/api.ts b/src/api-models/vendor-direct-fulfillment-transactions-api-model/api.ts index 0f2a0b0f..0ace4c1b 100644 --- a/src/api-models/vendor-direct-fulfillment-transactions-api-model/api.ts +++ b/src/api-models/vendor-direct-fulfillment-transactions-api-model/api.ts @@ -22,7 +22,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** - * The response schema for the `getTransactionStatus` operation. + * The response schema for the getTransactionStatus operation. * @export * @interface GetTransactionResponse */ @@ -102,7 +102,7 @@ export enum TransactionStatusEnum { } /** - * The payload for the `getTransactionStatus` operation. + * The payload for the getTransactionStatus operation. * @export * @interface TransactionStatus */ @@ -122,7 +122,7 @@ export interface TransactionStatus { export const VendorTransactionApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the 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 status of the transaction indicated by the specified transactionId. **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, 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} transactionId Previously returned in the response to the POST request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -165,7 +165,7 @@ export const VendorTransactionApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VendorTransactionApiAxiosParamCreator(configuration) return { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the 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 status of the transaction indicated by the specified transactionId. **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, 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} transactionId Previously returned in the response to the POST request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -185,7 +185,7 @@ export const VendorTransactionApiFactory = function (configuration?: Configurati const localVarFp = VendorTransactionApiFp(configuration) return { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the 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 status of the transaction indicated by the specified transactionId. **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, 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} transactionId Previously returned in the response to the POST request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -218,7 +218,7 @@ export interface VendorTransactionApiGetTransactionStatusRequest { */ export class VendorTransactionApi extends BaseAPI { /** - * Returns the status of the transaction indicated by the specified `transactionId`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the 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 status of the transaction indicated by the specified transactionId. **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, 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 {VendorTransactionApiGetTransactionStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/vendor-invoices-api-model/api.ts b/src/api-models/vendor-invoices-api-model/api.ts index ce01af88..67f8c427 100644 --- a/src/api-models/vendor-invoices-api-model/api.ts +++ b/src/api-models/vendor-invoices-api-model/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Payments + * Vendor Invoices v1 * The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data. * * The version of the OpenAPI document: v1 @@ -88,31 +88,31 @@ export interface Address { */ addressLine3?: string; /** - * The city where the person, business, or institution is located. + * The city where the person, business or institution is located. * @type {string} * @memberof Address */ city?: string; /** - * The county where person, business, or institution is located. + * The county where person, business or institution is located. * @type {string} * @memberof Address */ county?: string; /** - * The district where person, business, or institution is located. + * The district where person, business or institution is located. * @type {string} * @memberof Address */ district?: string; /** - * The state or region where person, business, or institution is located. + * The state or region where person, business or institution is located. * @type {string} * @memberof Address */ stateOrRegion?: string; /** - * The postal or zip code of that address. It contains a series of letters, digits, or both, sometimes including spaces or punctuation. + * The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. * @type {string} * @memberof Address */ @@ -226,31 +226,31 @@ export enum ChargeDetailsTypeEnum { } /** - * References required in order to process a credit note. This information is required only if `InvoiceType` is `CreditNote`. + * References required in order to process a credit note. This information is required only if InvoiceType is CreditNote. * @export * @interface CreditNoteDetails */ export interface CreditNoteDetails { /** - * Original invoice number when sending a credit note relating to an existing invoice. One invoice only to be processed per credit note. This is mandatory for AP credit notes. + * Original Invoice Number when sending a credit note relating to an existing invoice. One Invoice only to be processed per Credit Note. This is mandatory for AP Credit Notes. * @type {string} * @memberof CreditNoteDetails */ referenceInvoiceNumber?: string; /** - * Debit note number as generated by Amazon. Recommended for returns and COOP credit notes. + * Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes. * @type {string} * @memberof CreditNoteDetails */ debitNoteNumber?: string; /** - * Identifies the returns notice number. Mandatory for all returns credit notes. + * Identifies the Returns Notice Number. Mandatory for all Returns Credit Notes. * @type {string} * @memberof CreditNoteDetails */ returnsReferenceNumber?: string; /** - * Defines a date and time according to ISO 8601. + * Defines a date and time according to ISO8601. * @type {string} * @memberof CreditNoteDetails */ @@ -262,7 +262,7 @@ export interface CreditNoteDetails { */ rmaId?: string; /** - * Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the debit note number may lead to a rejection of the credit note. + * Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the Debit Note number may lead to a rejection of the Credit Note. * @type {string} * @memberof CreditNoteDetails */ @@ -299,7 +299,7 @@ export interface Invoice { */ referenceNumber?: string; /** - * Defines a date and time according to ISO 8601. + * Defines a date and time according to ISO8601. * @type {string} * @memberof Invoice */ @@ -418,13 +418,19 @@ export interface InvoiceItem { */ netCost: Money; /** - * The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when `invoiceType` is `Invoice`, and is not required when `invoiceType` is `CreditNote`. + * + * @type {NetCostUnitOfMeasure} + * @memberof InvoiceItem + */ + netCostUnitOfMeasure?: NetCostUnitOfMeasure | 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS'; + /** + * The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice, and is not required when invoiceType is CreditNote. * @type {string} * @memberof InvoiceItem */ purchaseOrderNumber?: string; /** - * The HSN Tax code. The HSN number cannot contain alphabets. + * HSN Tax code. The HSN number cannot contain alphabets. * @type {string} * @memberof InvoiceItem */ @@ -473,11 +479,17 @@ export interface ItemQuantity { */ unitOfMeasure: ItemQuantityUnitOfMeasureEnum | 'Cases' | 'Eaches'; /** - * The case size, if the unit of measure value is `Cases`. + * The case size, if the unit of measure value is Cases. * @type {number} * @memberof ItemQuantity */ unitSize?: number; + /** + * + * @type {TotalWeight} + * @memberof ItemQuantity + */ + totalWeight?: TotalWeight; } /** @@ -534,7 +546,19 @@ export interface Money { amount?: string; } /** - * Name, address, and tax details of a party. + * This field represents weight unit of measure of items that are ordered by cases and supporting priced by weight. + * @export + * @enum {string} + */ +export enum NetCostUnitOfMeasure { + Pounds = 'POUNDS', + Ounces = 'OUNCES', + Grams = 'GRAMS', + Kilograms = 'KILOGRAMS' +} + +/** + * Name, address and tax details of a party. * @export * @interface PartyIdentification */ @@ -577,7 +601,7 @@ export interface PaymentTerms { */ discountPercent?: string; /** - * The number of calendar days from the base date (Invoice date) until the discount is no longer valid. + * The number of calendar days from the Base date (Invoice date) until the discount is no longer valid. * @type {number} * @memberof PaymentTerms */ @@ -604,7 +628,7 @@ export enum PaymentTermsTypeEnum { } /** - * The request schema for the `submitInvoices` operation. + * The request schema for the submitInvoices operation. * @export * @interface SubmitInvoicesRequest */ @@ -617,7 +641,7 @@ export interface SubmitInvoicesRequest { invoices?: Array; } /** - * The response schema for the `submitInvoices` operation. + * The response schema for the submitInvoices operation. * @export * @interface SubmitInvoicesResponse */ @@ -717,6 +741,37 @@ export enum TaxRegistrationDetailsTaxRegistrationTypeEnum { Gst = 'GST' } +/** + * The aggregate weight of this item being invoiced. This information will be available for items sold by weight. + * @export + * @interface TotalWeight + */ +export interface TotalWeight { + /** + * The unit of measure for items sold by weight. + * @type {string} + * @memberof TotalWeight + */ + unitOfMeasure: TotalWeightUnitOfMeasureEnum | 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS'; + /** + * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. + * @type {string} + * @memberof TotalWeight + */ + amount: string; +} + +/** + * @export + * @enum {string} + */ +export enum TotalWeightUnitOfMeasureEnum { + Pounds = 'POUNDS', + Ounces = 'OUNCES', + Grams = 'GRAMS', + Kilograms = 'KILOGRAMS' +} + /** * Response containing the transaction ID. * @export @@ -732,13 +787,14 @@ export interface TransactionId { } /** - * VendorPaymentsApi - axios parameter creator + * VendorInvoicesApi - axios parameter creator * @export */ -export const VendorPaymentsApiAxiosParamCreator = function (configuration?: Configuration) { +export const VendorInvoicesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Submit new invoices to Amazon. **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). + * Submit new invoices to Amazon. **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, 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). + * @summary submitInvoices * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -776,14 +832,15 @@ export const VendorPaymentsApiAxiosParamCreator = function (configuration?: Conf }; /** - * VendorPaymentsApi - functional programming interface + * VendorInvoicesApi - functional programming interface * @export */ -export const VendorPaymentsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = VendorPaymentsApiAxiosParamCreator(configuration) +export const VendorInvoicesApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = VendorInvoicesApiAxiosParamCreator(configuration) return { /** - * Submit new invoices to Amazon. **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). + * Submit new invoices to Amazon. **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, 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). + * @summary submitInvoices * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -796,14 +853,15 @@ export const VendorPaymentsApiFp = function(configuration?: Configuration) { }; /** - * VendorPaymentsApi - factory interface + * VendorInvoicesApi - factory interface * @export */ -export const VendorPaymentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = VendorPaymentsApiFp(configuration) +export const VendorInvoicesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = VendorInvoicesApiFp(configuration) return { /** - * Submit new invoices to Amazon. **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). + * Submit new invoices to Amazon. **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, 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). + * @summary submitInvoices * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -815,35 +873,36 @@ export const VendorPaymentsApiFactory = function (configuration?: Configuration, }; /** - * Request parameters for submitInvoices operation in VendorPaymentsApi. + * Request parameters for submitInvoices operation in VendorInvoicesApi. * @export - * @interface VendorPaymentsApiSubmitInvoicesRequest + * @interface VendorInvoicesApiSubmitInvoicesRequest */ -export interface VendorPaymentsApiSubmitInvoicesRequest { +export interface VendorInvoicesApiSubmitInvoicesRequest { /** * The request body containing the invoice data to submit. * @type {SubmitInvoicesRequest} - * @memberof VendorPaymentsApiSubmitInvoices + * @memberof VendorInvoicesApiSubmitInvoices */ readonly body: SubmitInvoicesRequest } /** - * VendorPaymentsApi - object-oriented interface + * VendorInvoicesApi - object-oriented interface * @export - * @class VendorPaymentsApi + * @class VendorInvoicesApi * @extends {BaseAPI} */ -export class VendorPaymentsApi extends BaseAPI { +export class VendorInvoicesApi extends BaseAPI { /** - * Submit new invoices to Amazon. **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 {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters. + * Submit new invoices to Amazon. **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, 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). + * @summary submitInvoices + * @param {VendorInvoicesApiSubmitInvoicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof VendorPaymentsApi + * @memberof VendorInvoicesApi */ - public submitInvoices(requestParameters: VendorPaymentsApiSubmitInvoicesRequest, options?: any) { - return VendorPaymentsApiFp(this.configuration).submitInvoices(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public submitInvoices(requestParameters: VendorInvoicesApiSubmitInvoicesRequest, options?: any) { + return VendorInvoicesApiFp(this.configuration).submitInvoices(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/api-models/vendor-invoices-api-model/base.ts b/src/api-models/vendor-invoices-api-model/base.ts index c8f4c9ad..5ca1c0f7 100644 --- a/src/api-models/vendor-invoices-api-model/base.ts +++ b/src/api-models/vendor-invoices-api-model/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Payments + * Vendor Invoices v1 * The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-invoices-api-model/common.ts b/src/api-models/vendor-invoices-api-model/common.ts index 576d17f1..d06ded44 100644 --- a/src/api-models/vendor-invoices-api-model/common.ts +++ b/src/api-models/vendor-invoices-api-model/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Payments + * Vendor Invoices v1 * The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-invoices-api-model/configuration.ts b/src/api-models/vendor-invoices-api-model/configuration.ts index 56b8ac6e..eb7eb1bb 100644 --- a/src/api-models/vendor-invoices-api-model/configuration.ts +++ b/src/api-models/vendor-invoices-api-model/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Payments + * Vendor Invoices v1 * The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-invoices-api-model/index.ts b/src/api-models/vendor-invoices-api-model/index.ts index eec847dd..0118216f 100644 --- a/src/api-models/vendor-invoices-api-model/index.ts +++ b/src/api-models/vendor-invoices-api-model/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Payments + * Vendor Invoices v1 * The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data. * * 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 68386f62..16471258 100644 --- a/src/api-models/vendor-orders-api-model/api.ts +++ b/src/api-models/vendor-orders-api-model/api.ts @@ -342,7 +342,7 @@ export enum MoneyUnitOfMeasureEnum { } /** - * + * Represents an order placed by Amazon, including the purchase order number, current state, and order details. * @export * @interface Order */ @@ -378,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 */ @@ -577,7 +577,7 @@ export enum OrderDetailsPaymentMethodEnum { } /** - * + * Represents an individual item in an order, including item details, quantities, pricing, and backorder information. * @export * @interface OrderItem */ @@ -626,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 */ @@ -683,7 +683,7 @@ export enum OrderItemAcknowledgementRejectionReasonEnum { } /** - * + * Represents the current status of an order item, including acknowledgement and receiving details. * @export * @interface OrderItemStatus */ @@ -836,7 +836,7 @@ export enum OrderItemStatusReceivingStatusReceiveStatusEnum { } /** - * + * A list of orders returned as response. * @export * @interface OrderList */ @@ -848,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 */ @@ -867,7 +867,7 @@ export interface OrderListStatus { */ pagination?: Pagination; /** - * + * Represents an order status within the OrderListStatus. * @type {Array} * @memberof OrderListStatus */ @@ -933,7 +933,7 @@ export enum OrderStatusPurchaseOrderStatusEnum { } /** - * Details of item quantity ordered + * Details of item quantity ordered. * @export * @interface OrderedQuantityDetails */ @@ -958,7 +958,7 @@ export interface OrderedQuantityDetails { cancelledQuantity?: ItemQuantity; } /** - * + * The pagination elements required to retrieve the remaining data. * @export * @interface Pagination */ @@ -971,7 +971,7 @@ export interface Pagination { nextToken?: string; } /** - * + * Name, address and tax details of a party. * @export * @interface PartyIdentification */ @@ -1002,7 +1002,7 @@ export interface PartyIdentification { */ export interface SubmitAcknowledgementRequest { /** - * + * An array of order acknowledgements to be submitted. * @type {Array} * @memberof SubmitAcknowledgementRequest */ @@ -1057,7 +1057,7 @@ export enum TaxRegistrationDetailsTaxRegistrationTypeEnum { } /** - * + * Response containing the transaction ID. * @export * @interface TransactionId */ @@ -1310,7 +1310,7 @@ 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 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 {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1408,7 +1408,7 @@ export const VendorOrdersApiFp = function(configuration?: 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 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 {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1478,7 +1478,7 @@ export const VendorOrdersApiFactory = function (configuration?: Configuration, b }, /** * 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 {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1698,7 +1698,7 @@ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest { */ export interface VendorOrdersApiSubmitAcknowledgementRequest { /** - * + * Submits acknowledgements for one or more purchase orders from a vendor. * @type {SubmitAcknowledgementRequest} * @memberof VendorOrdersApiSubmitAcknowledgement */ diff --git a/src/api-models/vendor-shipments-api-model/api.ts b/src/api-models/vendor-shipments-api-model/api.ts index 80822d69..e69ae709 100644 --- a/src/api-models/vendor-shipments-api-model/api.ts +++ b/src/api-models/vendor-shipments-api-model/api.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Shipments + * Vendor Shipments v1 * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * The version of the OpenAPI document: v1 @@ -481,6 +481,25 @@ export interface GetShipmentDetailsResponse { */ errors?: Array; } +/** + * The response schema for the GetShipmentLabels operation. + * @export + * @interface GetShipmentLabels + */ +export interface GetShipmentLabels { + /** + * + * @type {TransportationLabels} + * @memberof GetShipmentLabels + */ + payload?: TransportationLabels; + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof GetShipmentLabels + */ + errors?: Array; +} /** * Provide these fields only if this shipment is a direct import. * @export @@ -683,6 +702,12 @@ export interface ItemQuantity { * @memberof ItemQuantity */ unitSize?: number; + /** + * + * @type {TotalWeight} + * @memberof ItemQuantity + */ + totalWeight?: TotalWeight; } /** @@ -694,6 +719,52 @@ export enum ItemQuantityUnitOfMeasureEnum { Eaches = 'Eaches' } +/** + * Label details as part of the transport label response + * @export + * @interface LabelData + */ +export interface LabelData { + /** + * Label list sequence number + * @type {number} + * @memberof LabelData + */ + labelSequenceNumber?: number; + /** + * Type of the label format like PDF + * @type {string} + * @memberof LabelData + */ + labelFormat?: LabelDataLabelFormatEnum | 'PDF'; + /** + * Unique identification for the carrier like UPS,DHL,USPS..etc + * @type {string} + * @memberof LabelData + */ + carrierCode?: string; + /** + * Tracking Id for the transportation. + * @type {string} + * @memberof LabelData + */ + trackingId?: string; + /** + * Label created as part of the transportation and it is base64 encoded + * @type {string} + * @memberof LabelData + */ + label?: string; +} + +/** + * @export + * @enum {string} + */ +export enum LabelDataLabelFormatEnum { + Pdf = 'PDF' +} + /** * Location identifier. * @export @@ -825,6 +896,41 @@ export interface PackedItems { */ itemDetails?: PackageItemDetails; } +/** + * Details of item quantity. + * @export + * @interface PackedQuantity + */ +export interface PackedQuantity { + /** + * Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level. + * @type {number} + * @memberof PackedQuantity + */ + amount: number; + /** + * Unit of measure for the shipped quantity. + * @type {string} + * @memberof PackedQuantity + */ + unitOfMeasure: PackedQuantityUnitOfMeasureEnum | 'Cases' | 'Eaches'; + /** + * The case size, in the event that we ordered using cases. Otherwise, 1. + * @type {number} + * @memberof PackedQuantity + */ + unitSize?: number; +} + +/** + * @export + * @enum {string} + */ +export enum PackedQuantityUnitOfMeasureEnum { + Cases = 'Cases', + Eaches = 'Eaches' +} + /** * The pagination elements required to retrieve the remaining data. * @export @@ -912,6 +1018,19 @@ export interface PartyIdentification { */ taxRegistrationDetails?: Array; } +/** + * Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. + * @export + * @interface PurchaseOrderItemDetails + */ +export interface PurchaseOrderItemDetails { + /** + * + * @type {Money} + * @memberof PurchaseOrderItemDetails + */ + maximumRetailPrice?: Money; +} /** * Details of the item being shipped. * @export @@ -1308,6 +1427,71 @@ export interface ShipmentDetails { */ shipments?: Array; } +/** + * Shipment Information details for Label request. + * @export + * @interface ShipmentInformation + */ +export interface ShipmentInformation { + /** + * + * @type {VendorDetails} + * @memberof ShipmentInformation + */ + vendorDetails?: VendorDetails; + /** + * Buyer Reference number which is a unique number. + * @type {string} + * @memberof ShipmentInformation + */ + buyerReferenceNumber?: string; + /** + * + * @type {PartyIdentification} + * @memberof ShipmentInformation + */ + shipToParty?: PartyIdentification; + /** + * + * @type {PartyIdentification} + * @memberof ShipmentInformation + */ + shipFromParty?: PartyIdentification; + /** + * Vendor Warehouse ID from where the shipment is scheduled to be picked up by buyer / Carrier. + * @type {string} + * @memberof ShipmentInformation + */ + warehouseId?: string; + /** + * Unique Id with which the shipment can be tracked for Small Parcels. + * @type {string} + * @memberof ShipmentInformation + */ + masterTrackingId?: string; + /** + * Number of Labels that are created as part of this shipment. + * @type {number} + * @memberof ShipmentInformation + */ + totalLabelCount?: number; + /** + * Type of shipment whether it is Small Parcel + * @type {string} + * @memberof ShipmentInformation + */ + shipMode?: ShipmentInformationShipModeEnum | 'SmallParcel' | 'LTL'; +} + +/** + * @export + * @enum {string} + */ +export enum ShipmentInformationShipModeEnum { + SmallParcel = 'SmallParcel', + Ltl = 'LTL' +} + /** * Shipment measurement details. * @export @@ -1486,6 +1670,37 @@ export enum TaxRegistrationDetailsTaxRegistrationTypeEnum { Gst = 'GST' } +/** + * Amount of units shipped for items sold by weight at a shipment level. + * @export + * @interface TotalWeight + */ +export interface TotalWeight { + /** + * This field represents weight unit of measure of items that are ordered by cases and supporting priced by weight. + * @type {string} + * @memberof TotalWeight + */ + unitOfMeasure: TotalWeightUnitOfMeasureEnum | 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS'; + /** + * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. + * @type {string} + * @memberof TotalWeight + */ + amount: string; +} + +/** + * @export + * @enum {string} + */ +export enum TotalWeightUnitOfMeasureEnum { + Pounds = 'POUNDS', + Ounces = 'OUNCES', + Grams = 'GRAMS', + Kilograms = 'KILOGRAMS' +} + /** * The response payload for the SubmitShipmentConfirmations operation. * @export @@ -1499,6 +1714,31 @@ export interface TransactionReference { */ transactionId?: string; } +/** + * A list of one or more ShipmentLabels. + * @export + * @interface TransportLabel + */ +export interface TransportLabel { + /** + * Date on which label is created. + * @type {string} + * @memberof TransportLabel + */ + labelCreateDateTime?: string; + /** + * + * @type {ShipmentInformation} + * @memberof TransportLabel + */ + shipmentInformation?: ShipmentInformation; + /** + * Indicates the label data,format and type associated . + * @type {Array} + * @memberof TransportLabel + */ + labelData?: Array; +} /** * Shipment measurement details. * @export @@ -1647,6 +1887,44 @@ export enum TransportationDetailsForShipmentConfirmationTransportationModeEnum { Ocean = 'Ocean' } +/** + * The request schema for the GetShipmentLabels operation. + * @export + * @interface TransportationLabels + */ +export interface TransportationLabels { + /** + * + * @type {Pagination} + * @memberof TransportationLabels + */ + pagination?: Pagination; + /** + * A list of one or more ShipmentLabels. + * @type {Array} + * @memberof TransportationLabels + */ + transportLabels?: Array; +} +/** + * Vendor Details as part of Label response. + * @export + * @interface VendorDetails + */ +export interface VendorDetails { + /** + * + * @type {PartyIdentification} + * @memberof VendorDetails + */ + sellingParty?: PartyIdentification; + /** + * Unique vendor shipment id which is not used in last 365 days + * @type {string} + * @memberof VendorDetails + */ + vendorShipmentId?: string; +} /** * The volume of the shipment. * @export @@ -1711,13 +1989,14 @@ export enum WeightUnitOfMeasureEnum { /** - * VendorShippingApi - axios parameter creator + * VendorShipmentsApi - axios parameter creator * @export */ -export const VendorShippingApiAxiosParamCreator = function (configuration?: Configuration) { +export const VendorShipmentsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters 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, 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). + * @summary GetShipmentDetails * @param {number} [limit] The limit to the number of records returned. Default value is 50 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 shipments than the specified result size limit. @@ -1888,6 +2167,80 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf + 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 transport Labels based on the filters 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, 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). + * @summary GetShipmentLabels + * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. + * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by transport label creation date. + * @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit. + * @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label. + * @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label. + * @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getShipmentLabels: async (limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, labelCreatedAfter?: string, labelcreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options: any = {}): Promise => { + const localVarPath = `/vendor/shipping/v1/transportLabels`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sortOrder !== undefined) { + localVarQueryParameter['sortOrder'] = sortOrder; + } + + if (nextToken !== undefined) { + localVarQueryParameter['nextToken'] = nextToken; + } + + if (labelCreatedAfter !== undefined) { + localVarQueryParameter['labelCreatedAfter'] = (labelCreatedAfter as any instanceof Date) ? + (labelCreatedAfter as any).toISOString() : + labelCreatedAfter; + } + + if (labelcreatedBefore !== undefined) { + localVarQueryParameter['labelcreatedBefore'] = (labelcreatedBefore as any instanceof Date) ? + (labelcreatedBefore as any).toISOString() : + labelcreatedBefore; + } + + if (buyerReferenceNumber !== undefined) { + localVarQueryParameter['buyerReferenceNumber'] = buyerReferenceNumber; + } + + if (vendorShipmentIdentifier !== undefined) { + localVarQueryParameter['vendorShipmentIdentifier'] = vendorShipmentIdentifier; + } + + if (sellerWarehouseCode !== undefined) { + localVarQueryParameter['sellerWarehouseCode'] = sellerWarehouseCode; + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -1899,6 +2252,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }, /** * Submits one or more shipment confirmations for vendor 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, 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). + * @summary SubmitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1934,6 +2288,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }, /** * Submits one or more shipment request for vendor 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, 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). + * @summary SubmitShipments * @param {SubmitShipments} body A request to submit shipment request. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1971,14 +2326,15 @@ export const VendorShippingApiAxiosParamCreator = function (configuration?: Conf }; /** - * VendorShippingApi - functional programming interface + * VendorShipmentsApi - functional programming interface * @export */ -export const VendorShippingApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = VendorShippingApiAxiosParamCreator(configuration) +export const VendorShipmentsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = VendorShipmentsApiAxiosParamCreator(configuration) return { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters 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, 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). + * @summary GetShipmentDetails * @param {number} [limit] The limit to the number of records returned. Default value is 50 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 shipments than the specified result size limit. @@ -2010,8 +2366,27 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentDetails(limit, sortOrder, nextToken, createdAfter, createdBefore, shipmentConfirmedBefore, shipmentConfirmedAfter, packageLabelCreatedBefore, packageLabelCreatedAfter, shippedBefore, shippedAfter, estimatedDeliveryBefore, estimatedDeliveryAfter, shipmentDeliveryBefore, shipmentDeliveryAfter, requestedPickUpBefore, requestedPickUpAfter, scheduledPickUpBefore, scheduledPickUpAfter, currentShipmentStatus, vendorShipmentIdentifier, buyerReferenceNumber, buyerWarehouseCode, sellerWarehouseCode, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Returns transport Labels based on the filters 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, 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). + * @summary GetShipmentLabels + * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. + * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by transport label creation date. + * @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit. + * @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label. + * @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label. + * @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getShipmentLabels(limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, labelCreatedAfter?: string, labelcreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentLabels(limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Submits one or more shipment confirmations for vendor 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, 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). + * @summary SubmitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2022,6 +2397,7 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { }, /** * Submits one or more shipment request for vendor 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, 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). + * @summary SubmitShipments * @param {SubmitShipments} body A request to submit shipment request. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2034,14 +2410,15 @@ export const VendorShippingApiFp = function(configuration?: Configuration) { }; /** - * VendorShippingApi - factory interface + * VendorShipmentsApi - factory interface * @export */ -export const VendorShippingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = VendorShippingApiFp(configuration) +export const VendorShipmentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = VendorShipmentsApiFp(configuration) return { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters 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, 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). + * @summary GetShipmentDetails * @param {number} [limit] The limit to the number of records returned. Default value is 50 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 shipments than the specified result size limit. @@ -2072,8 +2449,26 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, getShipmentDetails(limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: any): AxiosPromise { return localVarFp.getShipmentDetails(limit, sortOrder, nextToken, createdAfter, createdBefore, shipmentConfirmedBefore, shipmentConfirmedAfter, packageLabelCreatedBefore, packageLabelCreatedAfter, shippedBefore, shippedAfter, estimatedDeliveryBefore, estimatedDeliveryAfter, shipmentDeliveryBefore, shipmentDeliveryAfter, requestedPickUpBefore, requestedPickUpAfter, scheduledPickUpBefore, scheduledPickUpAfter, currentShipmentStatus, vendorShipmentIdentifier, buyerReferenceNumber, buyerWarehouseCode, sellerWarehouseCode, options).then((request) => request(axios, basePath)); }, + /** + * Returns transport Labels based on the filters 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, 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). + * @summary GetShipmentLabels + * @param {number} [limit] The limit to the number of records returned. Default value is 50 records. + * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by transport label creation date. + * @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit. + * @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label. + * @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label. + * @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getShipmentLabels(limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, labelCreatedAfter?: string, labelcreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: any): AxiosPromise { + return localVarFp.getShipmentLabels(limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options).then((request) => request(axios, basePath)); + }, /** * Submits one or more shipment confirmations for vendor 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, 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). + * @summary SubmitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2083,6 +2478,7 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, }, /** * Submits one or more shipment request for vendor 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, 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). + * @summary SubmitShipments * @param {SubmitShipments} body A request to submit shipment request. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2094,246 +2490,324 @@ export const VendorShippingApiFactory = function (configuration?: Configuration, }; /** - * Request parameters for getShipmentDetails operation in VendorShippingApi. + * Request parameters for getShipmentDetails operation in VendorShipmentsApi. * @export - * @interface VendorShippingApiGetShipmentDetailsRequest + * @interface VendorShipmentsApiGetShipmentDetailsRequest */ -export interface VendorShippingApiGetShipmentDetailsRequest { +export interface VendorShipmentsApiGetShipmentDetailsRequest { /** * The limit to the number of records returned. Default value is 50 records. * @type {number} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly limit?: number /** * Sort in ascending or descending order by purchase order creation date. * @type {'ASC' | 'DESC'} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly sortOrder?: 'ASC' | 'DESC' /** * Used for pagination when there are more shipments than the specified result size limit. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly nextToken?: string /** * Get Shipment Details 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> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly createdAfter?: string /** * Get Shipment Details 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> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly createdBefore?: string /** * Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly shipmentConfirmedBefore?: string /** * Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly shipmentConfirmedAfter?: string /** * Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly packageLabelCreatedBefore?: string /** * Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly packageLabelCreatedAfter?: string /** * Get Shipment Details by passing Shipped Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly shippedBefore?: string /** * Get Shipment Details by passing Shipped Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly shippedAfter?: string /** * Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly estimatedDeliveryBefore?: string /** * Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly estimatedDeliveryAfter?: string /** * Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly shipmentDeliveryBefore?: string /** * Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly shipmentDeliveryAfter?: string /** * Get Shipment Details by passing Before Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly requestedPickUpBefore?: string /** * Get Shipment Details by passing After Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly requestedPickUpAfter?: string /** * Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly scheduledPickUpBefore?: string /** * Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly scheduledPickUpAfter?: string /** * Get Shipment Details by passing Current shipment status. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly currentShipmentStatus?: string /** * Get Shipment Details by passing Vendor Shipment ID * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly vendorShipmentIdentifier?: string /** * Get Shipment Details by passing buyer Reference ID * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly buyerReferenceNumber?: string /** * Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails */ readonly buyerWarehouseCode?: string /** * Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment. * @type {string} - * @memberof VendorShippingApiGetShipmentDetails + * @memberof VendorShipmentsApiGetShipmentDetails + */ + readonly sellerWarehouseCode?: string +} + +/** + * Request parameters for getShipmentLabels operation in VendorShipmentsApi. + * @export + * @interface VendorShipmentsApiGetShipmentLabelsRequest + */ +export interface VendorShipmentsApiGetShipmentLabelsRequest { + /** + * The limit to the number of records returned. Default value is 50 records. + * @type {number} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly limit?: number + + /** + * Sort in ascending or descending order by transport label creation date. + * @type {'ASC' | 'DESC'} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly sortOrder?: 'ASC' | 'DESC' + + /** + * Used for pagination when there are more transport label than the specified result size limit. + * @type {string} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly nextToken?: string + + /** + * transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @type {string} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly labelCreatedAfter?: string + + /** + * transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @type {string} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly labelcreatedBefore?: string + + /** + * Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label. + * @type {string} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly buyerReferenceNumber?: string + + /** + * Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label. + * @type {string} + * @memberof VendorShipmentsApiGetShipmentLabels + */ + readonly vendorShipmentIdentifier?: string + + /** + * Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment. + * @type {string} + * @memberof VendorShipmentsApiGetShipmentLabels */ readonly sellerWarehouseCode?: string } /** - * Request parameters for submitShipmentConfirmations operation in VendorShippingApi. + * Request parameters for submitShipmentConfirmations operation in VendorShipmentsApi. * @export - * @interface VendorShippingApiSubmitShipmentConfirmationsRequest + * @interface VendorShipmentsApiSubmitShipmentConfirmationsRequest */ -export interface VendorShippingApiSubmitShipmentConfirmationsRequest { +export interface VendorShipmentsApiSubmitShipmentConfirmationsRequest { /** * A request to submit shipment confirmation. * @type {SubmitShipmentConfirmationsRequest} - * @memberof VendorShippingApiSubmitShipmentConfirmations + * @memberof VendorShipmentsApiSubmitShipmentConfirmations */ readonly body: SubmitShipmentConfirmationsRequest } /** - * Request parameters for submitShipments operation in VendorShippingApi. + * Request parameters for submitShipments operation in VendorShipmentsApi. * @export - * @interface VendorShippingApiSubmitShipmentsRequest + * @interface VendorShipmentsApiSubmitShipmentsRequest */ -export interface VendorShippingApiSubmitShipmentsRequest { +export interface VendorShipmentsApiSubmitShipmentsRequest { /** * A request to submit shipment request. * @type {SubmitShipments} - * @memberof VendorShippingApiSubmitShipments + * @memberof VendorShipmentsApiSubmitShipments */ readonly body: SubmitShipments } /** - * VendorShippingApi - object-oriented interface + * VendorShipmentsApi - object-oriented interface * @export - * @class VendorShippingApi + * @class VendorShipmentsApi * @extends {BaseAPI} */ -export class VendorShippingApi extends BaseAPI { +export class VendorShipmentsApi extends BaseAPI { /** * Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters 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, 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 {VendorShippingApiGetShipmentDetailsRequest} requestParameters Request parameters. + * @summary GetShipmentDetails + * @param {VendorShipmentsApiGetShipmentDetailsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VendorShipmentsApi + */ + public getShipmentDetails(requestParameters: VendorShipmentsApiGetShipmentDetailsRequest = {}, options?: any) { + return VendorShipmentsApiFp(this.configuration).getShipmentDetails(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentConfirmedBefore, requestParameters.shipmentConfirmedAfter, requestParameters.packageLabelCreatedBefore, requestParameters.packageLabelCreatedAfter, requestParameters.shippedBefore, requestParameters.shippedAfter, requestParameters.estimatedDeliveryBefore, requestParameters.estimatedDeliveryAfter, requestParameters.shipmentDeliveryBefore, requestParameters.shipmentDeliveryAfter, requestParameters.requestedPickUpBefore, requestParameters.requestedPickUpAfter, requestParameters.scheduledPickUpBefore, requestParameters.scheduledPickUpAfter, requestParameters.currentShipmentStatus, requestParameters.vendorShipmentIdentifier, requestParameters.buyerReferenceNumber, requestParameters.buyerWarehouseCode, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns transport Labels based on the filters 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, 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). + * @summary GetShipmentLabels + * @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof VendorShippingApi + * @memberof VendorShipmentsApi */ - public getShipmentDetails(requestParameters: VendorShippingApiGetShipmentDetailsRequest = {}, options?: any) { - return VendorShippingApiFp(this.configuration).getShipmentDetails(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentConfirmedBefore, requestParameters.shipmentConfirmedAfter, requestParameters.packageLabelCreatedBefore, requestParameters.packageLabelCreatedAfter, requestParameters.shippedBefore, requestParameters.shippedAfter, requestParameters.estimatedDeliveryBefore, requestParameters.estimatedDeliveryAfter, requestParameters.shipmentDeliveryBefore, requestParameters.shipmentDeliveryAfter, requestParameters.requestedPickUpBefore, requestParameters.requestedPickUpAfter, requestParameters.scheduledPickUpBefore, requestParameters.scheduledPickUpAfter, requestParameters.currentShipmentStatus, requestParameters.vendorShipmentIdentifier, requestParameters.buyerReferenceNumber, requestParameters.buyerWarehouseCode, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath)); + public getShipmentLabels(requestParameters: VendorShipmentsApiGetShipmentLabelsRequest = {}, options?: any) { + return VendorShipmentsApiFp(this.configuration).getShipmentLabels(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.labelCreatedAfter, requestParameters.labelcreatedBefore, requestParameters.buyerReferenceNumber, requestParameters.vendorShipmentIdentifier, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath)); } /** * Submits one or more shipment confirmations for vendor 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, 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 {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters. + * @summary SubmitShipmentConfirmations + * @param {VendorShipmentsApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof VendorShippingApi + * @memberof VendorShipmentsApi */ - public submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any) { - return VendorShippingApiFp(this.configuration).submitShipmentConfirmations(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public submitShipmentConfirmations(requestParameters: VendorShipmentsApiSubmitShipmentConfirmationsRequest, options?: any) { + return VendorShipmentsApiFp(this.configuration).submitShipmentConfirmations(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** * Submits one or more shipment request for vendor 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, 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 {VendorShippingApiSubmitShipmentsRequest} requestParameters Request parameters. + * @summary SubmitShipments + * @param {VendorShipmentsApiSubmitShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof VendorShippingApi + * @memberof VendorShipmentsApi */ - public submitShipments(requestParameters: VendorShippingApiSubmitShipmentsRequest, options?: any) { - return VendorShippingApiFp(this.configuration).submitShipments(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public submitShipments(requestParameters: VendorShipmentsApiSubmitShipmentsRequest, options?: any) { + return VendorShipmentsApiFp(this.configuration).submitShipments(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/api-models/vendor-shipments-api-model/base.ts b/src/api-models/vendor-shipments-api-model/base.ts index d641a8f8..1effdd82 100644 --- a/src/api-models/vendor-shipments-api-model/base.ts +++ b/src/api-models/vendor-shipments-api-model/base.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Shipments + * Vendor Shipments v1 * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-shipments-api-model/common.ts b/src/api-models/vendor-shipments-api-model/common.ts index 95908ea5..f45e34be 100644 --- a/src/api-models/vendor-shipments-api-model/common.ts +++ b/src/api-models/vendor-shipments-api-model/common.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Shipments + * Vendor Shipments v1 * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-shipments-api-model/configuration.ts b/src/api-models/vendor-shipments-api-model/configuration.ts index a75e64ee..3015d158 100644 --- a/src/api-models/vendor-shipments-api-model/configuration.ts +++ b/src/api-models/vendor-shipments-api-model/configuration.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Shipments + * Vendor Shipments v1 * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-shipments-api-model/index.ts b/src/api-models/vendor-shipments-api-model/index.ts index a9122ffe..7502c30b 100644 --- a/src/api-models/vendor-shipments-api-model/index.ts +++ b/src/api-models/vendor-shipments-api-model/index.ts @@ -1,7 +1,7 @@ /* tslint:disable */ /* eslint-disable */ /** - * Selling Partner API for Retail Procurement Shipments + * Vendor Shipments v1 * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * The version of the OpenAPI document: v1 diff --git a/src/api-models/vendor-transaction-status-api-model/api.ts b/src/api-models/vendor-transaction-status-api-model/api.ts index c778049f..d50fc2de 100644 --- a/src/api-models/vendor-transaction-status-api-model/api.ts +++ b/src/api-models/vendor-transaction-status-api-model/api.ts @@ -22,7 +22,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** - * The response schema for the `getTransaction` operation. + * The response schema for the getTransaction operation. * @export * @interface GetTransactionResponse */ @@ -122,7 +122,7 @@ export interface TransactionStatus { export const VendorTransactionApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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 status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -165,7 +165,7 @@ export const VendorTransactionApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = VendorTransactionApiAxiosParamCreator(configuration) return { /** - * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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 status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -185,7 +185,7 @@ export const VendorTransactionApiFactory = function (configuration?: Configurati const localVarFp = VendorTransactionApiFp(configuration) return { /** - * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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 status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -218,7 +218,7 @@ export interface VendorTransactionApiGetTransactionRequest { */ export class VendorTransactionApi extends BaseAPI { /** - * Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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 status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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 {VendorTransactionApiGetTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError}