From a01f8607c45b53996fa9f47d30bcac181f54abe2 Mon Sep 17 00:00:00 2001 From: nguyentoanit <19872073+nguyentoanit@users.noreply.github.com> Date: Mon, 24 Jun 2024 01:31:11 +0000 Subject: [PATCH] chore: update api models --- ...zon-warehousing-and-distribution-client.ts | 14 + src/api-clients/index.ts | 1 + .../api.ts | 1111 ++++++ .../base.ts | 71 + .../common.ts | 131 + .../configuration.ts | 101 + .../index.ts | 18 + .../catalog-items-api-model-v20220401/api.ts | 81 +- src/api-models/fba-inventory-api-model/api.ts | 377 +- src/api-models/feeds-api-model/api.ts | 2 +- src/api-models/feeds-api-model/base.ts | 2 +- src/api-models/feeds-api-model/common.ts | 2 +- .../feeds-api-model/configuration.ts | 2 +- src/api-models/feeds-api-model/index.ts | 2 +- .../api.ts | 3397 +++++++++++++---- .../fulfillment-outbound-api-model/api.ts | 617 ++- src/api-models/index.ts | 123 +- .../api.ts | 204 +- src/api-models/replenishment-api-model/api.ts | 109 +- src/api-models/reports-api-model/api.ts | 2 +- src/api-models/reports-api-model/base.ts | 2 +- src/api-models/reports-api-model/common.ts | 2 +- .../reports-api-model/configuration.ts | 2 +- src/api-models/reports-api-model/index.ts | 2 +- 24 files changed, 5508 insertions(+), 867 deletions(-) create mode 100644 src/api-clients/amazon-warehousing-and-distribution-client.ts create mode 100644 src/api-models/amazon-warehousing-and-distribution-model/api.ts create mode 100644 src/api-models/amazon-warehousing-and-distribution-model/base.ts create mode 100644 src/api-models/amazon-warehousing-and-distribution-model/common.ts create mode 100644 src/api-models/amazon-warehousing-and-distribution-model/configuration.ts create mode 100644 src/api-models/amazon-warehousing-and-distribution-model/index.ts diff --git a/src/api-clients/amazon-warehousing-and-distribution-client.ts b/src/api-clients/amazon-warehousing-and-distribution-client.ts new file mode 100644 index 000000000..d77ab62d3 --- /dev/null +++ b/src/api-clients/amazon-warehousing-and-distribution-client.ts @@ -0,0 +1,14 @@ +import { AwdApi, Configuration } from '../api-models/amazon-warehousing-and-distribution-model' +import { ApiClientHelpers } from '../helpers' +import { DEFAULT_API_BASE_PATH } from '../types' +import { APIConfigurationParameters } from '../types/api-clients/api-configuration-parameters' + +export class AmazonWarehousingAndDistributionClient extends AwdApi { + constructor(parameters: APIConfigurationParameters) { + const axios = ApiClientHelpers.getAxiosInstance(parameters) + + const configuration = new Configuration(parameters) + + super(configuration, DEFAULT_API_BASE_PATH, axios) + } +} diff --git a/src/api-clients/index.ts b/src/api-clients/index.ts index 7286b1fc2..ad64d4a85 100644 --- a/src/api-clients/index.ts +++ b/src/api-clients/index.ts @@ -1,3 +1,4 @@ +export * from './amazon-warehousing-and-distribution-client' export * from './aplus-content-api-client' export * from './application-management-api-client' export * from './catalog-items-api-client' diff --git a/src/api-models/amazon-warehousing-and-distribution-model/api.ts b/src/api-models/amazon-warehousing-and-distribution-model/api.ts new file mode 100644 index 000000000..e537d4575 --- /dev/null +++ b/src/api-models/amazon-warehousing-and-distribution-model/api.ts @@ -0,0 +1,1111 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * The Selling Partner API for AWD + * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * + * The version of the OpenAPI document: 2024-05-09 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import { Configuration } from './configuration'; +import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; + +/** + * Shipping address that represents the origin or destination location. + * @export + * @interface Address + */ +export interface Address { + /** + * First line of the address text. + * @type {string} + * @memberof Address + */ + addressLine1: string; + /** + * Optional second line of the address text. + * @type {string} + * @memberof Address + */ + addressLine2?: string; + /** + * Optional third line of the address text. + * @type {string} + * @memberof Address + */ + addressLine3?: string; + /** + * Optional city where this address is located. + * @type {string} + * @memberof Address + */ + city?: string; + /** + * Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located. + * @type {string} + * @memberof Address + */ + countryCode: string; + /** + * Optional county where this address is located. + * @type {string} + * @memberof Address + */ + county?: string; + /** + * Optional district where this address is located. + * @type {string} + * @memberof Address + */ + district?: string; + /** + * Name of the person, business, or institution at this address. + * @type {string} + * @memberof Address + */ + name: string; + /** + * Optional E.164-formatted phone number for an available contact at this address. + * @type {string} + * @memberof Address + */ + phoneNumber?: string; + /** + * Optional postal code where this address is located. + * @type {string} + * @memberof Address + */ + postalCode?: string; + /** + * State or region where this address is located. Note that this is contextual to the specified country code. + * @type {string} + * @memberof Address + */ + stateOrRegion: string; +} +/** + * Identifies the carrier that will deliver the shipment. + * @export + * @interface CarrierCode + */ +export interface CarrierCode { + /** + * + * @type {CarrierCodeType} + * @memberof CarrierCode + */ + carrierCodeType?: CarrierCodeType | 'SCAC'; + /** + * Value of the carrier code. + * @type {string} + * @memberof CarrierCode + */ + carrierCodeValue?: string; +} +/** + * Denotes the type for the carrier. + * @export + * @enum {string} + */ +export enum CarrierCodeType { + Scac = 'SCAC' +} + +/** + * Unit of measurement for package dimensions. + * @export + * @enum {string} + */ +export enum DimensionUnitOfMeasurement { + Inches = 'INCHES', + Centimeters = 'CENTIMETERS' +} + +/** + * Represents an AWD distribution package. + * @export + * @interface DistributionPackage + */ +export interface DistributionPackage { + /** + * + * @type {DistributionPackageContents} + * @memberof DistributionPackage + */ + contents: DistributionPackageContents; + /** + * + * @type {MeasurementData} + * @memberof DistributionPackage + */ + measurements: MeasurementData; + /** + * + * @type {DistributionPackageType} + * @memberof DistributionPackage + */ + type: DistributionPackageType | 'CASE' | 'PALLET'; +} +/** + * Represents the contents inside a package, which can be products or a nested package. + * @export + * @interface DistributionPackageContents + */ +export interface DistributionPackageContents { + /** + * This is required only when `DistributionPackageType=PALLET`. + * @type {Array} + * @memberof DistributionPackageContents + */ + packages?: Array; + /** + * This is required only when `DistributionPackageType=CASE`. + * @type {Array} + * @memberof DistributionPackageContents + */ + products?: Array; +} +/** + * Represents a distribution package with its respective quantity. + * @export + * @interface DistributionPackageQuantity + */ +export interface DistributionPackageQuantity { + /** + * Number of cases or pallets with the same package configuration. + * @type {number} + * @memberof DistributionPackageQuantity + */ + count: number; + /** + * + * @type {DistributionPackage} + * @memberof DistributionPackageQuantity + */ + distributionPackage: DistributionPackage; +} +/** + * Type of distribution packages. + * @export + * @enum {string} + */ +export enum DistributionPackageType { + Case = 'CASE', + Pallet = 'PALLET' +} + +/** + * This exception is thrown when client inputs are invalid. + * @export + * @interface ErrorList + */ +export interface ErrorList { + /** + * A list of errors describing the failures. + * @type {Array} + * @memberof ErrorList + */ + errors: Array; +} +/** + * Represents an AWD inbound shipment. + * @export + * @interface InboundShipment + */ +export interface InboundShipment { + /** + * + * @type {CarrierCode} + * @memberof InboundShipment + */ + carrierCode?: CarrierCode; + /** + * Timestamp when the shipment was created. The date is returned in ISO 8601 format. + * @type {string} + * @memberof InboundShipment + */ + createdAt?: string; + /** + * + * @type {Address} + * @memberof InboundShipment + */ + destinationAddress: Address; + /** + * Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record. + * @type {string} + * @memberof InboundShipment + */ + externalReferenceId?: string; + /** + * The AWD inbound order ID that this inbound shipment belongs to. + * @type {string} + * @memberof InboundShipment + */ + orderId: string; + /** + * + * @type {Address} + * @memberof InboundShipment + */ + originAddress: Address; + /** + * Quantity received (at the receiving end) as part of this shipment. + * @type {Array} + * @memberof InboundShipment + */ + receivedQuantity?: Array; + /** + * Timestamp when the shipment will be shipped. + * @type {string} + * @memberof InboundShipment + */ + shipBy?: string; + /** + * Packages that are part of this shipment. + * @type {Array} + * @memberof InboundShipment + */ + shipmentContainerQuantities: Array; + /** + * Unique shipment ID. + * @type {string} + * @memberof InboundShipment + */ + shipmentId: string; + /** + * + * @type {InboundShipmentStatus} + * @memberof InboundShipment + */ + shipmentStatus: InboundShipmentStatus | 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'; + /** + * Carrier-unique tracking ID for this shipment. + * @type {string} + * @memberof InboundShipment + */ + trackingId?: string; + /** + * Timestamp when the shipment was updated. The date is returned in ISO 8601 format. + * @type {string} + * @memberof InboundShipment + */ + updatedAt?: string; + /** + * An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking. + * @type {string} + * @memberof InboundShipment + */ + warehouseReferenceId?: string; +} +/** + * Possible shipment statuses used by shipments. + * @export + * @enum {string} + */ +export enum InboundShipmentStatus { + Created = 'CREATED', + Shipped = 'SHIPPED', + InTransit = 'IN_TRANSIT', + Receiving = 'RECEIVING', + Delivered = 'DELIVERED', + Closed = 'CLOSED', + Cancelled = 'CANCELLED' +} + +/** + * Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment. + * @export + * @interface InboundShipmentSummary + */ +export interface InboundShipmentSummary { + /** + * Timestamp when the shipment was created. + * @type {string} + * @memberof InboundShipmentSummary + */ + createdAt?: string; + /** + * Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record. + * @type {string} + * @memberof InboundShipmentSummary + */ + externalReferenceId?: string; + /** + * The AWD inbound order ID that this inbound shipment belongs to. + * @type {string} + * @memberof InboundShipmentSummary + */ + orderId: string; + /** + * A unique shipment ID. + * @type {string} + * @memberof InboundShipmentSummary + */ + shipmentId: string; + /** + * + * @type {InboundShipmentStatus} + * @memberof InboundShipmentSummary + */ + shipmentStatus: InboundShipmentStatus | 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'; + /** + * Timestamp when the shipment was updated. + * @type {string} + * @memberof InboundShipmentSummary + */ + updatedAt?: string; +} +/** + * Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`. + * @export + * @interface InventoryDetails + */ +export interface InventoryDetails { + /** + * Quantity that is available for downstream channel replenishment. + * @type {number} + * @memberof InventoryDetails + */ + availableDistributableQuantity?: number; + /** + * Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment. + * @type {number} + * @memberof InventoryDetails + */ + reservedDistributableQuantity?: number; +} +/** + * Enum to specify if returned summaries should include additional summarized inventory details and quantities. + * @export + * @enum {string} + */ +export enum InventoryDetailsVisibility { + Show = 'SHOW', + Hide = 'HIDE' +} + +/** + * AWD inventory payload. + * @export + * @interface InventoryListing + */ +export interface InventoryListing { + /** + * List of inventory summaries. + * @type {Array} + * @memberof InventoryListing + */ + inventory: Array; + /** + * Token to retrieve the next set of paginated results. + * @type {string} + * @memberof InventoryListing + */ + nextToken?: string; +} +/** + * Quantity of inventory with an associated measurement unit context. + * @export + * @interface InventoryQuantity + */ +export interface InventoryQuantity { + /** + * Quantity of the respective inventory. + * @type {number} + * @memberof InventoryQuantity + */ + quantity: number; + /** + * + * @type {InventoryUnitOfMeasurement} + * @memberof InventoryQuantity + */ + unitOfMeasurement: InventoryUnitOfMeasurement | 'PRODUCT_UNITS' | 'CASES' | 'PALLETS'; +} +/** + * Summary of inventory per SKU. + * @export + * @interface InventorySummary + */ +export interface InventorySummary { + /** + * + * @type {InventoryDetails} + * @memberof InventorySummary + */ + inventoryDetails?: InventoryDetails; + /** + * The seller or merchant SKU. + * @type {string} + * @memberof InventorySummary + */ + sku: string; + /** + * Total quantity that is present in AWD distribution centers. + * @type {number} + * @memberof InventorySummary + */ + totalOnhandQuantity?: number; +} +/** + * Unit of measurement for the inventory. + * @export + * @enum {string} + */ +export enum InventoryUnitOfMeasurement { + ProductUnits = 'PRODUCT_UNITS', + Cases = 'CASES', + Pallets = 'PALLETS' +} + +/** + * Package weight and dimension. + * @export + * @interface MeasurementData + */ +export interface MeasurementData { + /** + * + * @type {PackageDimensions} + * @memberof MeasurementData + */ + dimensions?: PackageDimensions; + /** + * + * @type {PackageVolume} + * @memberof MeasurementData + */ + volume?: PackageVolume; + /** + * + * @type {PackageWeight} + * @memberof MeasurementData + */ + weight: PackageWeight; +} +/** + * Error response returned when the request is unsuccessful. + * @export + * @interface ModelError + */ +export interface ModelError { + /** + * An error code that identifies the type of error that occurred. + * @type {string} + * @memberof ModelError + */ + code: string; + /** + * Additional details that can help the caller understand or fix the issue. + * @type {string} + * @memberof ModelError + */ + details?: string; + /** + * A message that describes the error condition. + * @type {string} + * @memberof ModelError + */ + message: string; +} +/** + * Dimensions of the package. + * @export + * @interface PackageDimensions + */ +export interface PackageDimensions { + /** + * Height of the package. + * @type {number} + * @memberof PackageDimensions + */ + height: number; + /** + * Length of the package. + * @type {number} + * @memberof PackageDimensions + */ + length: number; + /** + * + * @type {DimensionUnitOfMeasurement} + * @memberof PackageDimensions + */ + unitOfMeasurement: DimensionUnitOfMeasurement | 'INCHES' | 'CENTIMETERS'; + /** + * Width of the package. + * @type {number} + * @memberof PackageDimensions + */ + width: number; +} +/** + * Represents the volume of the package with a unit of measurement. + * @export + * @interface PackageVolume + */ +export interface PackageVolume { + /** + * + * @type {VolumeUnitOfMeasurement} + * @memberof PackageVolume + */ + unitOfMeasurement: VolumeUnitOfMeasurement | 'CU_IN' | 'CBM' | 'CC'; + /** + * The package volume value. + * @type {number} + * @memberof PackageVolume + */ + volume: number; +} +/** + * Represents the weight of the package with a unit of measurement. + * @export + * @interface PackageWeight + */ +export interface PackageWeight { + /** + * + * @type {WeightUnitOfMeasurement} + * @memberof PackageWeight + */ + unitOfMeasurement: WeightUnitOfMeasurement | 'POUNDS' | 'KILOGRAMS'; + /** + * The package weight value. + * @type {number} + * @memberof PackageWeight + */ + weight: number; +} +/** + * Product instance attribute that is not described at the SKU level in the catalog. + * @export + * @interface ProductAttribute + */ +export interface ProductAttribute { + /** + * Product attribute name. + * @type {string} + * @memberof ProductAttribute + */ + name?: string; + /** + * Product attribute value. + * @type {string} + * @memberof ProductAttribute + */ + value?: string; +} +/** + * Represents a product with the SKU details and the corresponding quantity. + * @export + * @interface ProductQuantity + */ +export interface ProductQuantity { + /** + * Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU. + * @type {Array} + * @memberof ProductQuantity + */ + attributes?: Array; + /** + * Product quantity. + * @type {number} + * @memberof ProductQuantity + */ + quantity: number; + /** + * The seller or merchant SKU. + * @type {string} + * @memberof ProductQuantity + */ + sku: string; +} +/** + * A list of inbound shipment summaries filtered by the attributes specified in the request. + * @export + * @interface ShipmentListing + */ +export interface ShipmentListing { + /** + * Token to retrieve the next set of paginated results. + * @type {string} + * @memberof ShipmentListing + */ + nextToken?: string; + /** + * List of inbound shipment summaries. + * @type {Array} + * @memberof ShipmentListing + */ + shipments?: Array; +} +/** + * Denotes the field name on which the shipments are to be sorted. + * @export + * @enum {string} + */ +export enum ShipmentSortableField { + UpdatedAt = 'UPDATED_AT', + CreatedAt = 'CREATED_AT' +} + +/** + * Sort order for a collection of items. For example, order or shipment. + * @export + * @enum {string} + */ +export enum SortOrder { + Ascending = 'ASCENDING', + Descending = 'DESCENDING' +} + +/** + * Unit of measurement for the package volume. + * @export + * @enum {string} + */ +export enum VolumeUnitOfMeasurement { + CuIn = 'CU_IN', + Cbm = 'CBM', + Cc = 'CC' +} + +/** + * Unit of measurement for the package weight. + * @export + * @enum {string} + */ +export enum WeightUnitOfMeasurement { + Pounds = 'POUNDS', + Kilograms = 'KILOGRAMS' +} + + +/** + * AwdApi - axios parameter creator + * @export + */ +export const AwdApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Retrieves an AWD inbound shipment. + * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getInboundShipment: async (shipmentId: string, options: any = {}): Promise => { + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('getInboundShipment', 'shipmentId', shipmentId) + const localVarPath = `/awd/2024-05-09/inboundShipments/{shipmentId}` + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. + * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. Required if `sortOrder` is provided. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. + * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {number} [maxResults] Maximum number of results to return. + * @param {string} [nextToken] Token to retrieve the next set of paginated results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listInboundShipments: async (sortBy?: 'UPDATED_AT' | 'CREATED_AT', sortOrder?: 'ASCENDING' | 'DESCENDING', shipmentStatus?: 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED', updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options: any = {}): Promise => { + const localVarPath = `/awd/2024-05-09/inboundShipments`; + // 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 (sortBy !== undefined) { + localVarQueryParameter['sortBy'] = sortBy; + } + + if (sortOrder !== undefined) { + localVarQueryParameter['sortOrder'] = sortOrder; + } + + if (shipmentStatus !== undefined) { + localVarQueryParameter['shipmentStatus'] = shipmentStatus; + } + + if (updatedAfter !== undefined) { + localVarQueryParameter['updatedAfter'] = (updatedAfter as any instanceof Date) ? + (updatedAfter as any).toISOString() : + updatedAfter; + } + + if (updatedBefore !== undefined) { + localVarQueryParameter['updatedBefore'] = (updatedBefore as any instanceof Date) ? + (updatedBefore as any).toISOString() : + updatedBefore; + } + + if (maxResults !== undefined) { + localVarQueryParameter['maxResults'] = maxResults; + } + + if (nextToken !== undefined) { + localVarQueryParameter['nextToken'] = nextToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * @param {string} [sku] Filter by seller or merchant SKU for the item. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. + * @param {string} [nextToken] Token to retrieve the next set of paginated results. + * @param {number} [maxResults] Maximum number of results to return. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listInventory: async (sku?: string, sortOrder?: 'ASCENDING' | 'DESCENDING', details?: 'SHOW' | 'HIDE', nextToken?: string, maxResults?: number, options: any = {}): Promise => { + const localVarPath = `/awd/2024-05-09/inventory`; + // 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 (sku !== undefined) { + localVarQueryParameter['sku'] = sku; + } + + if (sortOrder !== undefined) { + localVarQueryParameter['sortOrder'] = sortOrder; + } + + if (details !== undefined) { + localVarQueryParameter['details'] = details; + } + + if (nextToken !== undefined) { + localVarQueryParameter['nextToken'] = nextToken; + } + + if (maxResults !== undefined) { + localVarQueryParameter['maxResults'] = maxResults; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * AwdApi - functional programming interface + * @export + */ +export const AwdApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AwdApiAxiosParamCreator(configuration) + return { + /** + * Retrieves an AWD inbound shipment. + * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getInboundShipment(shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundShipment(shipmentId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. + * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. Required if `sortOrder` is provided. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. + * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {number} [maxResults] Maximum number of results to return. + * @param {string} [nextToken] Token to retrieve the next set of paginated results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listInboundShipments(sortBy?: 'UPDATED_AT' | 'CREATED_AT', sortOrder?: 'ASCENDING' | 'DESCENDING', shipmentStatus?: 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED', updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundShipments(sortBy, sortOrder, shipmentStatus, updatedAfter, updatedBefore, maxResults, nextToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * @param {string} [sku] Filter by seller or merchant SKU for the item. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. + * @param {string} [nextToken] Token to retrieve the next set of paginated results. + * @param {number} [maxResults] Maximum number of results to return. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listInventory(sku?: string, sortOrder?: 'ASCENDING' | 'DESCENDING', details?: 'SHOW' | 'HIDE', nextToken?: string, maxResults?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listInventory(sku, sortOrder, details, nextToken, maxResults, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * AwdApi - factory interface + * @export + */ +export const AwdApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AwdApiFp(configuration) + return { + /** + * Retrieves an AWD inbound shipment. + * @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getInboundShipment(shipmentId: string, options?: any): AxiosPromise { + return localVarFp.getInboundShipment(shipmentId, options).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. + * @param {'UPDATED_AT' | 'CREATED_AT'} [sortBy] Field to sort results by. Required if `sortOrder` is provided. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * @param {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} [shipmentStatus] Filter by inbound shipment status. + * @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @param {number} [maxResults] Maximum number of results to return. + * @param {string} [nextToken] Token to retrieve the next set of paginated results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listInboundShipments(sortBy?: 'UPDATED_AT' | 'CREATED_AT', sortOrder?: 'ASCENDING' | 'DESCENDING', shipmentStatus?: 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED', updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: any): AxiosPromise { + return localVarFp.listInboundShipments(sortBy, sortOrder, shipmentStatus, updatedAfter, updatedBefore, maxResults, nextToken, options).then((request) => request(axios, basePath)); + }, + /** + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * @param {string} [sku] Filter by seller or merchant SKU for the item. + * @param {'ASCENDING' | 'DESCENDING'} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order. + * @param {'SHOW' | 'HIDE'} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. + * @param {string} [nextToken] Token to retrieve the next set of paginated results. + * @param {number} [maxResults] Maximum number of results to return. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listInventory(sku?: string, sortOrder?: 'ASCENDING' | 'DESCENDING', details?: 'SHOW' | 'HIDE', nextToken?: string, maxResults?: number, options?: any): AxiosPromise { + return localVarFp.listInventory(sku, sortOrder, details, nextToken, maxResults, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getInboundShipment operation in AwdApi. + * @export + * @interface AwdApiGetInboundShipmentRequest + */ +export interface AwdApiGetInboundShipmentRequest { + /** + * ID for the shipment. A shipment contains the cases being inbounded. + * @type {string} + * @memberof AwdApiGetInboundShipment + */ + readonly shipmentId: string +} + +/** + * Request parameters for listInboundShipments operation in AwdApi. + * @export + * @interface AwdApiListInboundShipmentsRequest + */ +export interface AwdApiListInboundShipmentsRequest { + /** + * Field to sort results by. Required if `sortOrder` is provided. + * @type {'UPDATED_AT' | 'CREATED_AT'} + * @memberof AwdApiListInboundShipments + */ + readonly sortBy?: 'UPDATED_AT' | 'CREATED_AT' + + /** + * Sort the response in `ASCENDING` or `DESCENDING` order. + * @type {'ASCENDING' | 'DESCENDING'} + * @memberof AwdApiListInboundShipments + */ + readonly sortOrder?: 'ASCENDING' | 'DESCENDING' + + /** + * Filter by inbound shipment status. + * @type {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'} + * @memberof AwdApiListInboundShipments + */ + readonly shipmentStatus?: 'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED' + + /** + * List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @type {string} + * @memberof AwdApiListInboundShipments + */ + readonly updatedAfter?: string + + /** + * List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format. + * @type {string} + * @memberof AwdApiListInboundShipments + */ + readonly updatedBefore?: string + + /** + * Maximum number of results to return. + * @type {number} + * @memberof AwdApiListInboundShipments + */ + readonly maxResults?: number + + /** + * Token to retrieve the next set of paginated results. + * @type {string} + * @memberof AwdApiListInboundShipments + */ + readonly nextToken?: string +} + +/** + * Request parameters for listInventory operation in AwdApi. + * @export + * @interface AwdApiListInventoryRequest + */ +export interface AwdApiListInventoryRequest { + /** + * Filter by seller or merchant SKU for the item. + * @type {string} + * @memberof AwdApiListInventory + */ + readonly sku?: string + + /** + * Sort the response in `ASCENDING` or `DESCENDING` order. + * @type {'ASCENDING' | 'DESCENDING'} + * @memberof AwdApiListInventory + */ + readonly sortOrder?: 'ASCENDING' | 'DESCENDING' + + /** + * Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals. + * @type {'SHOW' | 'HIDE'} + * @memberof AwdApiListInventory + */ + readonly details?: 'SHOW' | 'HIDE' + + /** + * Token to retrieve the next set of paginated results. + * @type {string} + * @memberof AwdApiListInventory + */ + readonly nextToken?: string + + /** + * Maximum number of results to return. + * @type {number} + * @memberof AwdApiListInventory + */ + readonly maxResults?: number +} + +/** + * AwdApi - object-oriented interface + * @export + * @class AwdApi + * @extends {BaseAPI} + */ +export class AwdApi extends BaseAPI { + /** + * Retrieves an AWD inbound shipment. + * @param {AwdApiGetInboundShipmentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AwdApi + */ + public getInboundShipment(requestParameters: AwdApiGetInboundShipmentRequest, options?: any) { + return AwdApiFp(this.configuration).getInboundShipment(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. + * @param {AwdApiListInboundShipmentsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AwdApi + */ + public listInboundShipments(requestParameters: AwdApiListInboundShipmentsRequest = {}, options?: any) { + return AwdApiFp(this.configuration).listInboundShipments(requestParameters.sortBy, requestParameters.sortOrder, requestParameters.shipmentStatus, requestParameters.updatedAfter, requestParameters.updatedBefore, requestParameters.maxResults, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Lists AWD inventory associated with a merchant with the ability to apply optional filters. + * @param {AwdApiListInventoryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AwdApi + */ + public listInventory(requestParameters: AwdApiListInventoryRequest = {}, options?: any) { + return AwdApiFp(this.configuration).listInventory(requestParameters.sku, requestParameters.sortOrder, requestParameters.details, requestParameters.nextToken, requestParameters.maxResults, options).then((request) => request(this.axios, this.basePath)); + } +} + + diff --git a/src/api-models/amazon-warehousing-and-distribution-model/base.ts b/src/api-models/amazon-warehousing-and-distribution-model/base.ts new file mode 100644 index 000000000..f4a608b92 --- /dev/null +++ b/src/api-models/amazon-warehousing-and-distribution-model/base.ts @@ -0,0 +1,71 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * The Selling Partner API for AWD + * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * + * The version of the OpenAPI document: 2024-05-09 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import { Configuration } from "./configuration"; +// Some imports not used depending on template conditions +// @ts-ignore +import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; + +export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + options: any; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + name: "RequiredError" = "RequiredError"; + constructor(public field: string, msg?: string) { + super(msg); + } +} diff --git a/src/api-models/amazon-warehousing-and-distribution-model/common.ts b/src/api-models/amazon-warehousing-and-distribution-model/common.ts new file mode 100644 index 000000000..0ee150529 --- /dev/null +++ b/src/api-models/amazon-warehousing-and-distribution-model/common.ts @@ -0,0 +1,131 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * The Selling Partner API for AWD + * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * + * The version of the OpenAPI document: 2024-05-09 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import { Configuration } from "./configuration"; +import { RequiredError,　RequestArgs } from "./base"; +import { AxiosInstance } from 'axios'; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + for (const object of objects) { + for (const key in object) { + searchParams.set(key, object[key]); + } + } + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url}; + return axios.request(axiosRequestArgs); + }; +} diff --git a/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts b/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts new file mode 100644 index 000000000..fbb9ca2c8 --- /dev/null +++ b/src/api-models/amazon-warehousing-and-distribution-model/configuration.ts @@ -0,0 +1,101 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * The Selling Partner API for AWD + * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * + * The version of the OpenAPI document: 2024-05-09 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/src/api-models/amazon-warehousing-and-distribution-model/index.ts b/src/api-models/amazon-warehousing-and-distribution-model/index.ts new file mode 100644 index 000000000..242105a12 --- /dev/null +++ b/src/api-models/amazon-warehousing-and-distribution-model/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * The Selling Partner API for AWD + * The Selling Partner API for Amazon Warehousing and Distribution (AWD). + * + * The version of the OpenAPI document: 2024-05-09 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "./configuration"; + 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 0abbced89..b77e3bfd1 100644 --- a/src/api-models/catalog-items-api-model-v20220401/api.ts +++ b/src/api-models/catalog-items-api-model-v20220401/api.ts @@ -146,6 +146,12 @@ export interface Item { * @memberof Item */ attributes?: object; + /** + * Array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace. + * @type {Array} + * @memberof Item + */ + classifications?: Array; /** * Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace. * @type {Array} @@ -202,7 +208,7 @@ export interface Item { */ export interface ItemBrowseClassification { /** - * Display name for the classification. + * Display name for the classification (browse node). * @type {string} * @memberof ItemBrowseClassification */ @@ -213,6 +219,31 @@ export interface ItemBrowseClassification { * @memberof ItemBrowseClassification */ classificationId: string; + /** + * + * @type {ItemBrowseClassification} + * @memberof ItemBrowseClassification + */ + parent?: ItemBrowseClassification; +} +/** + * Classifications (browse nodes) associated with the item in the Amazon catalog for the indicated Amazon marketplace. + * @export + * @interface ItemBrowseClassificationsByMarketplace + */ +export interface ItemBrowseClassificationsByMarketplace { + /** + * Amazon marketplace identifier. + * @type {string} + * @memberof ItemBrowseClassificationsByMarketplace + */ + marketplaceId: string; + /** + * Classifications (browse nodes) associated with the item in the Amazon catalog for the indicated Amazon marketplace. + * @type {Array} + * @memberof ItemBrowseClassificationsByMarketplace + */ + classifications?: Array; } /** * Sales rank of an Amazon catalog item by classification. @@ -901,15 +932,15 @@ export interface Refinements { export const CatalogApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @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' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. + * @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`. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCatalogItem: async (asin: string, marketplaceIds: Array, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options: any = {}): Promise => { + getCatalogItem: async (asin: string, marketplaceIds: Array, includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options: any = {}): Promise => { // verify required parameter 'asin' is not null or undefined assertParamExists('getCatalogItem', 'asin', asin) // verify required parameter 'marketplaceIds' is not null or undefined @@ -951,11 +982,11 @@ 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). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @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. - * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. + * @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`. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @param {Array} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. @@ -967,7 +998,7 @@ export const CatalogApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchCatalogItems: async (marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options: any = {}): Promise => { + searchCatalogItems: async (marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options: any = {}): Promise => { // verify required parameter 'marketplaceIds' is not null or undefined assertParamExists('searchCatalogItems', 'marketplaceIds', marketplaceIds) const localVarPath = `/catalog/2022-04-01/items`; @@ -1052,24 +1083,24 @@ export const CatalogApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CatalogApiAxiosParamCreator(configuration) return { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @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' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. + * @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`. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCatalogItem(asin: string, marketplaceIds: Array, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCatalogItem(asin: string, marketplaceIds: Array, includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getCatalogItem(asin, marketplaceIds, includedData, locale, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @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. - * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. + * @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`. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @param {Array} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. @@ -1081,7 +1112,7 @@ export const CatalogApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async searchCatalogItems(marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async searchCatalogItems(marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -1096,23 +1127,23 @@ export const CatalogApiFactory = function (configuration?: Configuration, basePa const localVarFp = CatalogApiFp(configuration) return { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @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' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. + * @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`. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCatalogItem(asin: string, marketplaceIds: Array, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: any): AxiosPromise { + getCatalogItem(asin: string, marketplaceIds: Array, includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: any): AxiosPromise { return localVarFp.getCatalogItem(asin, marketplaceIds, includedData, locale, options).then((request) => request(axios, basePath)); }, /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @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. - * @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. + * @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`. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @param {Array} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. @@ -1124,7 +1155,7 @@ export const CatalogApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchCatalogItems(marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): AxiosPromise { + searchCatalogItems(marketplaceIds: Array, identifiers?: Array, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): AxiosPromise { return localVarFp.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options).then((request) => request(axios, basePath)); }, }; @@ -1152,10 +1183,10 @@ export interface CatalogApiGetCatalogItemRequest { /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. - * @type {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} + * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} * @memberof CatalogApiGetCatalogItem */ - readonly includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'> + 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. @@ -1194,10 +1225,10 @@ export interface CatalogApiSearchCatalogItemsRequest { /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. - * @type {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} + * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} * @memberof CatalogApiSearchCatalogItems */ - readonly includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'> + 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. @@ -1264,7 +1295,7 @@ export interface CatalogApiSearchCatalogItemsRequest { */ export class CatalogApi extends BaseAPI { /** - * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1275,7 +1306,7 @@ export class CatalogApi extends BaseAPI { } /** - * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 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). + * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/fba-inventory-api-model/api.ts b/src/api-models/fba-inventory-api-model/api.ts index 61066225d..3f1939b5a 100644 --- a/src/api-models/fba-inventory-api-model/api.ts +++ b/src/api-models/fba-inventory-api-model/api.ts @@ -21,6 +21,83 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; +/** + * The object with the list of Inventory to be added + * @export + * @interface AddInventoryRequest + */ +export interface AddInventoryRequest { + /** + * List of Inventory to be added + * @type {Array} + * @memberof AddInventoryRequest + */ + inventoryItems?: Array; +} +/** + * The response schema for the AddInventory operation. + * @export + * @interface AddInventoryResponse + */ +export interface AddInventoryResponse { + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof AddInventoryResponse + */ + errors?: Array; +} +/** + * An item to be created in the inventory. + * @export + * @interface CreateInventoryItemRequest + */ +export interface CreateInventoryItemRequest { + /** + * The seller SKU of the item. + * @type {string} + * @memberof CreateInventoryItemRequest + */ + sellerSku: string; + /** + * The marketplaceId. + * @type {string} + * @memberof CreateInventoryItemRequest + */ + marketplaceId: string; + /** + * The name of the item. + * @type {string} + * @memberof CreateInventoryItemRequest + */ + productName: string; +} +/** + * The response schema for the CreateInventoryItem operation. + * @export + * @interface CreateInventoryItemResponse + */ +export interface CreateInventoryItemResponse { + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof CreateInventoryItemResponse + */ + errors?: Array; +} +/** + * The response schema for the DeleteInventoryItem operation. + * @export + * @interface DeleteInventoryItemResponse + */ +export interface DeleteInventoryItemResponse { + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof DeleteInventoryItemResponse + */ + errors?: Array; +} /** * The Response schema. * @export @@ -133,6 +210,31 @@ export interface InventoryDetails { */ unfulfillableQuantity?: UnfulfillableQuantity; } +/** + * An item in the list of inventory to be added. + * @export + * @interface InventoryItem + */ +export interface InventoryItem { + /** + * The seller SKU of the item. + * @type {string} + * @memberof InventoryItem + */ + sellerSku: string; + /** + * The marketplaceId. + * @type {string} + * @memberof InventoryItem + */ + marketplaceId: string; + /** + * The quantity of item to add. + * @type {number} + * @memberof InventoryItem + */ + quantity: number; +} /** * Inventory summary for a specific item. * @export @@ -363,7 +465,124 @@ export interface UnfulfillableQuantity { export const FbaInventoryApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **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 | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency. + * @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addInventory: async (xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options: any = {}): Promise => { + // verify required parameter 'xAmznIdempotencyToken' is not null or undefined + assertParamExists('addInventory', 'xAmznIdempotencyToken', xAmznIdempotencyToken) + // verify required parameter 'addInventoryRequestBody' is not null or undefined + assertParamExists('addInventory', 'addInventoryRequestBody', addInventoryRequestBody) + const localVarPath = `/fba/inventory/v1/items/inventory`; + // 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; + + if (xAmznIdempotencyToken !== undefined && xAmznIdempotencyToken !== null) { + localVarHeaderParameter['x-amzn-idempotency-token'] = String(xAmznIdempotencyToken); + } + + + + 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(addInventoryRequestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createInventoryItem: async (createInventoryItemRequestBody: CreateInventoryItemRequest, options: any = {}): Promise => { + // verify required parameter 'createInventoryItemRequestBody' is not null or undefined + assertParamExists('createInventoryItem', 'createInventoryItemRequestBody', createInventoryItemRequestBody) + const localVarPath = `/fba/inventory/v1/items`; + // 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(createInventoryItemRequestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries. + * @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteInventoryItem: async (sellerSku: string, marketplaceId: string, options: any = {}): Promise => { + // verify required parameter 'sellerSku' is not null or undefined + assertParamExists('deleteInventoryItem', 'sellerSku', sellerSku) + // verify required parameter 'marketplaceId' is not null or undefined + assertParamExists('deleteInventoryItem', 'marketplaceId', marketplaceId) + const localVarPath = `/fba/inventory/v1/items/{sellerSku}` + .replace(`{${"sellerSku"}}`, encodeURIComponent(String(sellerSku))); + // 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: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (marketplaceId !== undefined) { + localVarQueryParameter['marketplaceId'] = marketplaceId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. 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. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API. * @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level. * @param {string} granularityId The granularity ID for the inventory aggregation level. * @param {Array} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries. @@ -450,7 +669,39 @@ export const FbaInventoryApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FbaInventoryApiAxiosParamCreator(configuration) return { /** - * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **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 | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency. + * @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async addInventory(xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addInventory(xAmznIdempotencyToken, addInventoryRequestBody, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createInventoryItem(createInventoryItemRequestBody: CreateInventoryItemRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createInventoryItem(createInventoryItemRequestBody, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries. + * @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteInventoryItem(sellerSku: string, marketplaceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteInventoryItem(sellerSku, marketplaceId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. 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. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API. * @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level. * @param {string} granularityId The granularity ID for the inventory aggregation level. * @param {Array} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries. @@ -477,7 +728,36 @@ export const FbaInventoryApiFactory = function (configuration?: Configuration, b const localVarFp = FbaInventoryApiFp(configuration) return { /** - * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **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 | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency. + * @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addInventory(xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options?: any): AxiosPromise { + return localVarFp.addInventory(xAmznIdempotencyToken, addInventoryRequestBody, options).then((request) => request(axios, basePath)); + }, + /** + * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createInventoryItem(createInventoryItemRequestBody: CreateInventoryItemRequest, options?: any): AxiosPromise { + return localVarFp.createInventoryItem(createInventoryItemRequestBody, options).then((request) => request(axios, basePath)); + }, + /** + * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries. + * @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteInventoryItem(sellerSku: string, marketplaceId: string, options?: any): AxiosPromise { + return localVarFp.deleteInventoryItem(sellerSku, marketplaceId, options).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. 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. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API. * @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level. * @param {string} granularityId The granularity ID for the inventory aggregation level. * @param {Array} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries. @@ -495,6 +775,62 @@ export const FbaInventoryApiFactory = function (configuration?: Configuration, b }; }; +/** + * Request parameters for addInventory operation in FbaInventoryApi. + * @export + * @interface FbaInventoryApiAddInventoryRequest + */ +export interface FbaInventoryApiAddInventoryRequest { + /** + * A unique token/requestId provided with each call to ensure idempotency. + * @type {string} + * @memberof FbaInventoryApiAddInventory + */ + readonly xAmznIdempotencyToken: string + + /** + * List of items to add to Sandbox inventory. + * @type {AddInventoryRequest} + * @memberof FbaInventoryApiAddInventory + */ + readonly addInventoryRequestBody: AddInventoryRequest +} + +/** + * Request parameters for createInventoryItem operation in FbaInventoryApi. + * @export + * @interface FbaInventoryApiCreateInventoryItemRequest + */ +export interface FbaInventoryApiCreateInventoryItemRequest { + /** + * CreateInventoryItem Request Body Parameter. + * @type {CreateInventoryItemRequest} + * @memberof FbaInventoryApiCreateInventoryItem + */ + readonly createInventoryItemRequestBody: CreateInventoryItemRequest +} + +/** + * Request parameters for deleteInventoryItem operation in FbaInventoryApi. + * @export + * @interface FbaInventoryApiDeleteInventoryItemRequest + */ +export interface FbaInventoryApiDeleteInventoryItemRequest { + /** + * A single seller SKU used for querying the specified seller SKU inventory summaries. + * @type {string} + * @memberof FbaInventoryApiDeleteInventoryItem + */ + readonly sellerSku: string + + /** + * The marketplace ID for the marketplace for which the sellerSku is to be deleted. + * @type {string} + * @memberof FbaInventoryApiDeleteInventoryItem + */ + readonly marketplaceId: string +} + /** * Request parameters for getInventorySummaries operation in FbaInventoryApi. * @export @@ -566,7 +902,40 @@ export interface FbaInventoryApiGetInventorySummariesRequest { */ export class FbaInventoryApi extends BaseAPI { /** - * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **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 | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). + * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInventoryApi + */ + public addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: any) { + return FbaInventoryApiFp(this.configuration).addInventory(requestParameters.xAmznIdempotencyToken, requestParameters.addInventoryRequestBody, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInventoryApi + */ + public createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: any) { + return FbaInventoryApiFp(this.configuration).createInventoryItem(requestParameters.createInventoryItemRequestBody, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. + * @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInventoryApi + */ + public deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: any) { + return FbaInventoryApiFp(this.configuration).deleteInventoryItem(requestParameters.sellerSku, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. 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. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API. * @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/feeds-api-model/api.ts b/src/api-models/feeds-api-model/api.ts index 6efd97a1c..12a9576d7 100644 --- a/src/api-models/feeds-api-model/api.ts +++ b/src/api-models/feeds-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Feeds - * Effective **June 27, 2023**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/feeds-api-model/base.ts b/src/api-models/feeds-api-model/base.ts index 5a81cda8d..66c094f8d 100644 --- a/src/api-models/feeds-api-model/base.ts +++ b/src/api-models/feeds-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Feeds - * Effective **June 27, 2023**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/feeds-api-model/common.ts b/src/api-models/feeds-api-model/common.ts index 2ee1f76a7..d5ad01145 100644 --- a/src/api-models/feeds-api-model/common.ts +++ b/src/api-models/feeds-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Feeds - * Effective **June 27, 2023**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/feeds-api-model/configuration.ts b/src/api-models/feeds-api-model/configuration.ts index 357867a71..9e51846ff 100644 --- a/src/api-models/feeds-api-model/configuration.ts +++ b/src/api-models/feeds-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Feeds - * Effective **June 27, 2023**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/feeds-api-model/index.ts b/src/api-models/feeds-api-model/index.ts index 71bfac80a..3f4132bae 100644 --- a/src/api-models/feeds-api-model/index.ts +++ b/src/api-models/feeds-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Feeds - * Effective **June 27, 2023**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Feeds v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Feeds API must migrate to [Feeds v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * 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 8381ba2a2..1f8f62df8 100644 --- a/src/api-models/fulfillment-inbound-api-model-v20240320/api.ts +++ b/src/api-models/fulfillment-inbound-api-model-v20240320/api.ts @@ -58,11 +58,23 @@ export interface Address { */ countryCode: string; /** - * The name of the individual or business. + * The email address. + * @type {string} + * @memberof Address + */ + email?: string; + /** + * The name of the individual who is the primary contact. * @type {string} * @memberof Address */ name: string; + /** + * The phone number. + * @type {string} + * @memberof Address + */ + phoneNumber?: string; /** * The postal code. * @type {string} @@ -76,6 +88,73 @@ export interface Address { */ stateOrProvinceCode?: string; } +/** + * Specific details to identify a place. + * @export + * @interface AddressInput + */ +export interface AddressInput { + /** + * Street address information. + * @type {string} + * @memberof AddressInput + */ + addressLine1: string; + /** + * Additional street address information. + * @type {string} + * @memberof AddressInput + */ + addressLine2?: string; + /** + * The city. + * @type {string} + * @memberof AddressInput + */ + city: string; + /** + * The name of the business. + * @type {string} + * @memberof AddressInput + */ + companyName?: string; + /** + * The country code in two-character ISO 3166-1 alpha-2 format. + * @type {string} + * @memberof AddressInput + */ + countryCode: string; + /** + * The email address. + * @type {string} + * @memberof AddressInput + */ + email?: string; + /** + * The name of the individual who is the primary contact. + * @type {string} + * @memberof AddressInput + */ + name: string; + /** + * The phone number. + * @type {string} + * @memberof AddressInput + */ + phoneNumber: string; + /** + * The postal code. + * @type {string} + * @memberof AddressInput + */ + postalCode: string; + /** + * The state or province code. + * @type {string} + * @memberof AddressInput + */ + stateOrProvinceCode?: string; +} /** * The fulfillment center appointment slot for the transportation option. * @export @@ -96,7 +175,7 @@ export interface AppointmentSlot { slotTime: AppointmentSlotTime; } /** - * An appointment slot time with a start and end. + * An appointment slot time with start and end. * @export * @interface AppointmentSlotTime */ @@ -115,17 +194,23 @@ export interface AppointmentSlotTime { startTime: string; } /** - * Contains information about a box that is used in the inbound plan. The box may contain an item and metadata about the box itself. + * Contains information about a box that is used in the inbound plan. The box is a container that holds multiple items. * @export * @interface Box */ export interface Box { /** - * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. + * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. * @type {string} * @memberof Box */ boxId?: string; + /** + * + * @type {BoxContentInformationSource} + * @memberof Box + */ + contentInformationSource?: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; /** * * @type {Region} @@ -169,49 +254,6 @@ export interface Box { */ weight?: Weight; } -/** - * Specifies contents in a box. Each `BoxContent` minimally contains a mapping of an MSKU to the prep owner, label owner and its quantity in the box. It also contains the MSKU expiration date and manufacturing lot code if applicable. - * @export - * @interface BoxContent - */ -export interface BoxContent { - /** - * The date in ISO 8601 format for when the MSKU expires. - * @type {string} - * @memberof BoxContent - */ - expiration?: string; - /** - * - * @type {LabelOwner} - * @memberof BoxContent - */ - labelOwner: LabelOwner | 'AMAZON' | 'SELLER'; - /** - * The manufacturing lot code. - * @type {string} - * @memberof BoxContent - */ - manufacturingLotCode?: string; - /** - * The merchant SKU, a merchant-supplied identifier for a specific SKU. - * @type {string} - * @memberof BoxContent - */ - msku: string; - /** - * - * @type {PrepOwner} - * @memberof BoxContent - */ - prepOwner: PrepOwner | 'AMAZON' | 'SELLER'; - /** - * The number of units of the given MSKU in the box. - * @type {number} - * @memberof BoxContent - */ - quantityInBox: number; -} /** * Indication of how box content is meant to be provided. * @export @@ -229,30 +271,24 @@ export enum BoxContentInformationSource { * @interface BoxInput */ export interface BoxInput { - /** - * The ID of the box to update that was provided by Amazon. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. - * @type {string} - * @memberof BoxInput - */ - boxId?: string; /** * * @type {BoxContentInformationSource} * @memberof BoxInput */ contentInformationSource: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; - /** - * The Contents of the box containing a list of MSKUs and their quantity. If `boxAttribute` is `BARCODE_2D` or `MANUAL_PROCESS`, user should provide ALL of the items that could be in the box, without specifying item quantities. - * @type {Array} - * @memberof BoxInput - */ - contents?: Array; /** * * @type {Dimensions} * @memberof BoxInput */ dimensions: Dimensions; + /** + * The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`. + * @type {Array} + * @memberof BoxInput + */ + items?: Array; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} @@ -260,15 +296,52 @@ export interface BoxInput { */ quantity: number; /** - * The seller-provided name for a \'type\' of box (or a group of boxes with the same contents), which will be used to identify all created boxes of that type. When providing bulk box information, this value must be unique from the other box types. When providing individual boxes with existing IDs, this value can be shared between many boxes that have the same contents. - * @type {string} + * + * @type {Weight} * @memberof BoxInput */ - templateName: string; + weight: Weight; +} +/** + * Input information for updating a box + * @export + * @interface BoxUpdateInput + */ +export interface BoxUpdateInput { + /** + * + * @type {BoxContentInformationSource} + * @memberof BoxUpdateInput + */ + contentInformationSource: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; + /** + * + * @type {Dimensions} + * @memberof BoxUpdateInput + */ + dimensions: Dimensions; + /** + * The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`. + * @type {Array} + * @memberof BoxUpdateInput + */ + items?: Array; + /** + * Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed + * @type {string} + * @memberof BoxUpdateInput + */ + packageId?: string; + /** + * The number of containers where all other properties like weight or dimensions are identical. + * @type {number} + * @memberof BoxUpdateInput + */ + quantity: number; /** * * @type {Weight} - * @memberof BoxInput + * @memberof BoxUpdateInput */ weight: Weight; } @@ -299,7 +372,7 @@ export interface CancelSelfShipAppointmentRequest { reasonComment?: ReasonComment | 'APPOINTMENT_REQUESTED_BY_MISTAKE' | 'VEHICLE_DELAY' | 'SLOT_NOT_SUITABLE' | 'OUTSIDE_CARRIER_BUSINESS_HOURS' | 'UNFAVOURABLE_EXTERNAL_CONDITIONS' | 'PROCUREMENT_DELAY' | 'SHIPPING_PLAN_CHANGED' | 'INCREASED_QUANTITY' | 'OTHER'; } /** - * The `cancelSelfShipAppointment` response. + * The `CancelSelfShipAppointment` response. * @export * @interface CancelSelfShipAppointmentResponse */ @@ -330,6 +403,25 @@ export interface Carrier { */ name?: string; } +/** + * Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up. + * @export + * @interface CarrierAppointment + */ +export interface CarrierAppointment { + /** + * The end timestamp of the appointment in UTC. + * @type {string} + * @memberof CarrierAppointment + */ + endTime: string; + /** + * The start timestamp of the appointment in UTC. + * @type {string} + * @memberof CarrierAppointment + */ + startTime: string; +} /** * Contains item identifiers and related tax information. * @export @@ -361,6 +453,19 @@ export interface ComplianceDetail { */ taxDetails?: TaxDetails; } +/** + * The `confirmDeliveryWindowOptions` response. + * @export + * @interface ConfirmDeliveryWindowOptionsResponse + */ +export interface ConfirmDeliveryWindowOptionsResponse { + /** + * UUID for the given operation. + * @type {string} + * @memberof ConfirmDeliveryWindowOptionsResponse + */ + operationId: string; +} /** * The `confirmPackingOption` response. * @export @@ -387,6 +492,19 @@ export interface ConfirmPlacementOptionResponse { */ operationId: string; } +/** + * The `confirmShipmentContentUpdatePreview` response. + * @export + * @interface ConfirmShipmentContentUpdatePreviewResponse + */ +export interface ConfirmShipmentContentUpdatePreviewResponse { + /** + * UUID for the given operation. + * @type {string} + * @memberof ConfirmShipmentContentUpdatePreviewResponse + */ + operationId: string; +} /** * The `confirmTransportationOptions` request. * @export @@ -420,36 +538,61 @@ export interface ConfirmTransportationOptionsResponse { */ export interface ContactInformation { /** - * Email address. + * The email address. * @type {string} * @memberof ContactInformation */ email?: string; /** - * The name belonging to the contact. This field is required when contact information is being provided for Less-Than-Truckload (LTL) carrier shipments. + * The contact\'s name. * @type {string} * @memberof ContactInformation */ - name?: string; + name: string; /** - * The phone number of the seller. + * The phone number. * @type {string} * @memberof ContactInformation */ phoneNumber: string; } /** - * The `createInboundPlan` request. + * Preview of the changes that will be applied to the shipment. * @export - * @interface CreateInboundPlanRequest + * @interface ContentUpdatePreview */ -export interface CreateInboundPlanRequest { +export interface ContentUpdatePreview { + /** + * Identifier of a content update preview. + * @type {string} + * @memberof ContentUpdatePreview + */ + contentUpdatePreviewId: string; + /** + * The date in ISO 8601 format for when the content update expires. + * @type {string} + * @memberof ContentUpdatePreview + */ + expiration: string; /** * - * @type {ContactInformation} - * @memberof CreateInboundPlanRequest + * @type {RequestedUpdates} + * @memberof ContentUpdatePreview + */ + requestedUpdates: RequestedUpdates; + /** + * + * @type {TransportationOption} + * @memberof ContentUpdatePreview */ - contactInformation: ContactInformation; + transportationOption: TransportationOption; +} +/** + * The `createInboundPlan` request. + * @export + * @interface CreateInboundPlanRequest + */ +export interface CreateInboundPlanRequest { /** * Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request. * @type {Array} @@ -470,10 +613,10 @@ export interface CreateInboundPlanRequest { name?: string; /** * - * @type {Address} + * @type {AddressInput} * @memberof CreateInboundPlanRequest */ - sourceAddress: Address; + sourceAddress: AddressInput; } /** * The `createInboundPlan` response. @@ -482,7 +625,7 @@ export interface CreateInboundPlanRequest { */ export interface CreateInboundPlanResponse { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof CreateInboundPlanResponse */ @@ -494,6 +637,68 @@ export interface CreateInboundPlanResponse { */ operationId: string; } +/** + * The `createMarketplaceItemLabels` request. + * @export + * @interface CreateMarketplaceItemLabelsRequest + */ +export interface CreateMarketplaceItemLabelsRequest { + /** + * The height of the item label. + * @type {number} + * @memberof CreateMarketplaceItemLabelsRequest + */ + height?: number; + /** + * + * @type {LabelPrintType} + * @memberof CreateMarketplaceItemLabelsRequest + */ + labelType: LabelPrintType | 'STANDARD_FORMAT' | 'THERMAL_PRINTING'; + /** + * The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character. + * @type {string} + * @memberof CreateMarketplaceItemLabelsRequest + */ + localeCode?: string; + /** + * The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. + * @type {string} + * @memberof CreateMarketplaceItemLabelsRequest + */ + marketplaceId: string; + /** + * Represents the quantity of an msku to print item labels for. + * @type {Array} + * @memberof CreateMarketplaceItemLabelsRequest + */ + mskuQuantities: Array; + /** + * + * @type {ItemLabelPageType} + * @memberof CreateMarketplaceItemLabelsRequest + */ + pageType?: ItemLabelPageType | 'A4_21' | 'A4_24' | 'A4_24_64x33' | 'A4_24_66x35' | 'A4_24_70x36' | 'A4_24_70x37' | 'A4_24i' | 'A4_27' | 'A4_40_52x29' | 'A4_44_48x25' | 'Letter_30'; + /** + * The width of the item label. + * @type {number} + * @memberof CreateMarketplaceItemLabelsRequest + */ + width?: number; +} +/** + * The `createMarketplaceItemLabels` response. + * @export + * @interface CreateMarketplaceItemLabelsResponse + */ +export interface CreateMarketplaceItemLabelsResponse { + /** + * Resources to download the requested document. + * @type {Array} + * @memberof CreateMarketplaceItemLabelsResponse + */ + documentDownloads: Array; +} /** * Currency definition. * @export @@ -533,7 +738,7 @@ export interface CustomPlacementInput { warehouseId: string; } /** - * Specifies the dates that the seller expects their shipment will be shipped and delivered. + * Specifies the date that the seller expects their shipment will be shipped. * @export * @interface Dates */ @@ -543,28 +748,59 @@ export interface Dates { * @type {Window} * @memberof Dates */ - deliveryWindow?: Window; + readyToShipWindow?: Window; +} +/** + * Contains information pertaining to a delivery window option. + * @export + * @interface DeliveryWindowOption + */ +export interface DeliveryWindowOption { /** - * - * @type {Window} - * @memberof Dates + * Identifies type of Delivery Window Availability. Values: `AVAILABLE`, `CONGESTED` + * @type {string} + * @memberof DeliveryWindowOption */ - readyToShipWindow?: Window; + availabilityType: string; + /** + * Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered. + * @type {string} + * @memberof DeliveryWindowOption + */ + deliveryWindowOptionId: string; + /** + * The timestamp at which this delivery window option ends. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * @type {string} + * @memberof DeliveryWindowOption + */ + endDate: string; + /** + * The timestamp at which this delivery window option starts. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * @type {string} + * @memberof DeliveryWindowOption + */ + startDate: string; + /** + * The timestamp at which this window delivery option becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * @type {string} + * @memberof DeliveryWindowOption + */ + validUntil: string; } /** - * Measurement of a package dimensions. + * Measurement of a package\'s dimensions. * @export * @interface Dimensions */ export interface Dimensions { /** - * Height. + * The height of a package. * @type {number} * @memberof Dimensions */ height: number; /** - * Length. + * The length of a package. * @type {number} * @memberof Dimensions */ @@ -576,7 +812,7 @@ export interface Dimensions { */ unitOfMeasurement: UnitOfMeasurement | 'IN' | 'CM'; /** - * Width. + * The width of a package. * @type {number} * @memberof Dimensions */ @@ -589,7 +825,7 @@ export interface Dimensions { */ export interface DocumentDownload { /** - * The type of download. Can be `URL` or `PDF_BASE64`. + * The type of download. Can be `URL`. * @type {string} * @memberof DocumentDownload */ @@ -621,17 +857,49 @@ export interface ErrorList { errors: Array; } /** - * The `generatePackingOptions` response. + * Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided. * @export - * @interface GeneratePackingOptionsResponse + * @interface FreightInformation */ -export interface GeneratePackingOptionsResponse { +export interface FreightInformation { /** - * UUID for the given operation. - * @type {string} - * @memberof GeneratePackingOptionsResponse + * + * @type {Currency} + * @memberof FreightInformation */ - operationId: string; + declaredValue?: Currency; + /** + * Freight class. Can be: `NONE`, `FC_50`, `FC_55`, `FC_60`, `FC_65`, `FC_70`, `FC_77_5`, `FC_85`, `FC_92_5`, `FC_100`, `FC_110`, `FC_125`, `FC_150`, `FC_175`, `FC_200`, `FC_250`, `FC_300`, `FC_400`, `FC_500`. + * @type {string} + * @memberof FreightInformation + */ + freightClass?: string; +} +/** + * The `generateDeliveryWindowOptions` response. + * @export + * @interface GenerateDeliveryWindowOptionsResponse + */ +export interface GenerateDeliveryWindowOptionsResponse { + /** + * UUID for the given operation. + * @type {string} + * @memberof GenerateDeliveryWindowOptionsResponse + */ + operationId: string; +} +/** + * The `generatePackingOptions` response. + * @export + * @interface GeneratePackingOptionsResponse + */ +export interface GeneratePackingOptionsResponse { + /** + * UUID for the given operation. + * @type {string} + * @memberof GeneratePackingOptionsResponse + */ + operationId: string; } /** * The `generatePlacementOptions` request. @@ -640,7 +908,7 @@ export interface GeneratePackingOptionsResponse { */ export interface GeneratePlacementOptionsRequest { /** - * Custom placements options to be added to the plan. + * Custom placement options to be added to the plan. * @type {Array} * @memberof GeneratePlacementOptionsRequest */ @@ -691,6 +959,38 @@ export interface GenerateSelfShipAppointmentSlotsResponse { */ operationId: string; } +/** + * The `GenerateShipmentContentUpdatePreviews` request. + * @export + * @interface GenerateShipmentContentUpdatePreviewsRequest + */ +export interface GenerateShipmentContentUpdatePreviewsRequest { + /** + * A list of boxes that will be present in the shipment after the update. + * @type {Array} + * @memberof GenerateShipmentContentUpdatePreviewsRequest + */ + boxes: Array; + /** + * A list of all items that will be present in the shipment after the update. + * @type {Array} + * @memberof GenerateShipmentContentUpdatePreviewsRequest + */ + items: Array; +} +/** + * The `GenerateShipmentContentUpdatePreviews` response. + * @export + * @interface GenerateShipmentContentUpdatePreviewsResponse + */ +export interface GenerateShipmentContentUpdatePreviewsResponse { + /** + * UUID for the given operation. + * @type {string} + * @memberof GenerateShipmentContentUpdatePreviewsResponse + */ + operationId: string; +} /** * The `generateTransportationOptions` request. * @export @@ -756,19 +1056,19 @@ export interface GetSelfShipAppointmentSlotsResponse { selfShipAppointmentSlotsAvailability: SelfShipAppointmentSlotsAvailability; } /** - * The `getInboundOperationStatus` response. + * GetInboundOperationStatus response. * @export * @interface InboundOperationStatus */ export interface InboundOperationStatus { /** - * The name of the operation that was executed in the asynchronous API call. + * The name of the operation in the asynchronous API call. * @type {string} * @memberof InboundOperationStatus */ operation: string; /** - * The operation Id returned by the asynchronous API call. + * The operation ID returned by the asynchronous API call. * @type {string} * @memberof InboundOperationStatus */ @@ -792,12 +1092,6 @@ export interface InboundOperationStatus { * @interface InboundPlan */ export interface InboundPlan { - /** - * - * @type {ContactInformation} - * @memberof InboundPlan - */ - contactInformation: ContactInformation; /** * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} @@ -805,7 +1099,7 @@ export interface InboundPlan { */ createdAt: string; /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof InboundPlan */ @@ -823,25 +1117,25 @@ export interface InboundPlan { */ marketplaceIds: Array; /** - * The human-readable name of the inbound plan. + * Human-readable name of the inbound plan. * @type {string} * @memberof InboundPlan */ name: string; /** - * Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding endpoint. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details. + * Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details. * @type {Array} * @memberof InboundPlan */ packingOptions?: Array; /** - * Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding endpoint. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details. + * Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details. * @type {Array} * @memberof InboundPlan */ placementOptions?: Array; /** - * Shipment IDs for the inbound plan. This property will be populated when it has been generated via the corresponding endpoint. If there is a chosen placement option, only shipments for that option will be returned. If there are confirmed shipments, only those shipments will be returned. Query the shipment for more details. + * Shipment IDs for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only shipments for that option will be returned. If there are confirmed shipments, only those shipments will be returned. Query the shipment for more details. * @type {Array} * @memberof InboundPlan */ @@ -853,7 +1147,7 @@ export interface InboundPlan { */ sourceAddress: Address; /** - * Current status of the inbound plan. Can be `ACTIVE`, `VOIDED`, or `SHIPPED`. + * Current status of the inbound plan. Can be: `ACTIVE`, `VOIDED`, `SHIPPED`, \'ERRORED\'. * @type {string} * @memberof InboundPlan */ @@ -865,12 +1159,6 @@ export interface InboundPlan { * @interface InboundPlanSummary */ export interface InboundPlanSummary { - /** - * - * @type {ContactInformation} - * @memberof InboundPlanSummary - */ - contactInformation: ContactInformation; /** * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} @@ -878,13 +1166,13 @@ export interface InboundPlanSummary { */ createdAt: string; /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof InboundPlanSummary */ inboundPlanId: string; /** - * ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof InboundPlanSummary */ @@ -908,7 +1196,7 @@ export interface InboundPlanSummary { */ sourceAddress: Address; /** - * Current status of the inbound plan. Can be \'ACTIVE\', \'VOIDED\', or \'SHIPPED\'. + * Current status of the inbound plan. Can be: `ACTIVE`, `VOIDED`, `SHIPPED`, \'ERRORED\'. * @type {string} * @memberof InboundPlanSummary */ @@ -933,7 +1221,7 @@ export interface Incentive { */ target: string; /** - * Type of incentive. Can be `FEE` or `DISCOUNT`. + * Type of incentive. Can be: `FEE`, `DISCOUNT`. * @type {string} * @memberof Incentive */ @@ -970,7 +1258,7 @@ export interface Item { */ fnsku: string; /** - * Specifies who will label the items. Options include `AMAZON` and `SELLER`. + * Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. * @type {string} * @memberof Item */ @@ -1017,7 +1305,7 @@ export interface ItemInput { * @type {LabelOwner} * @memberof ItemInput */ - labelOwner: LabelOwner | 'AMAZON' | 'SELLER'; + labelOwner: LabelOwner | 'AMAZON' | 'SELLER' | 'NONE'; /** * The manufacturing lot code. * @type {string} @@ -1025,7 +1313,7 @@ export interface ItemInput { */ manufacturingLotCode?: string; /** - * The merchant SKU. + * Merchant SKU. * @type {string} * @memberof ItemInput */ @@ -1035,26 +1323,75 @@ export interface ItemInput { * @type {PrepOwner} * @memberof ItemInput */ - prepOwner: PrepOwner | 'AMAZON' | 'SELLER'; + prepOwner: PrepOwner | 'AMAZON' | 'SELLER' | 'NONE'; /** - * The number of units of the specified MSKU that will be shipped. + * The number of units of the specified msku that will be shipped. * @type {number} * @memberof ItemInput */ quantity: number; } /** - * Specifies who will label the items. Options include `AMAZON` and `SELLER`. + * The page type to use to print the labels. Possible values: \'A4_21\', \'A4_24\', \'A4_24_64x33\', \'A4_24_66x35\', \'A4_24_70x36\', \'A4_24_70x37\', \'A4_24i\', \'A4_27\', \'A4_40_52x29\', \'A4_44_48x25\', \'Letter_30\'. + * @export + * @enum {string} + */ +export enum ItemLabelPageType { + A421 = 'A4_21', + A424 = 'A4_24', + A42464x33 = 'A4_24_64x33', + A42466x35 = 'A4_24_66x35', + A42470x36 = 'A4_24_70x36', + A42470x37 = 'A4_24_70x37', + A424i = 'A4_24i', + A427 = 'A4_27', + A44052x29 = 'A4_40_52x29', + A44448x25 = 'A4_44_48x25', + Letter30 = 'Letter_30' +} + +/** + * Specifies who will label the items. Options include `AMAZON`, `SELLER` or `NONE`. * @export * @enum {string} */ export enum LabelOwner { Amazon = 'AMAZON', - Seller = 'SELLER' + Seller = 'SELLER', + None = 'NONE' } /** - * `listInboundPlanBoxes` response. + * Indicates the type of print type for a given label. + * @export + * @enum {string} + */ +export enum LabelPrintType { + StandardFormat = 'STANDARD_FORMAT', + ThermalPrinting = 'THERMAL_PRINTING' +} + +/** + * The `listDeliveryWindowOptions` response. + * @export + * @interface ListDeliveryWindowOptionsResponse + */ +export interface ListDeliveryWindowOptionsResponse { + /** + * Delivery window options generated for the placement option. + * @type {Array} + * @memberof ListDeliveryWindowOptionsResponse + */ + deliveryWindowOptions: Array; + /** + * + * @type {Pagination} + * @memberof ListDeliveryWindowOptionsResponse + */ + pagination?: Pagination; +} +/** + * The `listInboundPlanBoxes` response. * @export * @interface ListInboundPlanBoxesResponse */ @@ -1073,7 +1410,7 @@ export interface ListInboundPlanBoxesResponse { pagination?: Pagination; } /** - * `listInboundPlanItems` response. + * The `listInboundPlanItems` response. * @export * @interface ListInboundPlanItemsResponse */ @@ -1092,7 +1429,7 @@ export interface ListInboundPlanItemsResponse { pagination?: Pagination; } /** - * `listInboundPlanPallets` response. + * The `listInboundPlanPallets` response. * @export * @interface ListInboundPlanPalletsResponse */ @@ -1111,7 +1448,7 @@ export interface ListInboundPlanPalletsResponse { pallets: Array; } /** - * `listInboundPlans` response. + * The `listInboundPlans` response. * @export * @interface ListInboundPlansResponse */ @@ -1130,7 +1467,7 @@ export interface ListInboundPlansResponse { pagination?: Pagination; } /** - * `listItemComplianceDetails` response. + * The `listItemComplianceDetails` response. * @export * @interface ListItemComplianceDetailsResponse */ @@ -1143,13 +1480,32 @@ export interface ListItemComplianceDetailsResponse { complianceDetails?: Array; } /** - * `listPackingGroupItems` response. + * The `listPackingGroupBoxes` response. + * @export + * @interface ListPackingGroupBoxesResponse + */ +export interface ListPackingGroupBoxesResponse { + /** + * Provides the information about the list of boxes in the packing group. + * @type {Array} + * @memberof ListPackingGroupBoxesResponse + */ + boxes: Array; + /** + * + * @type {Pagination} + * @memberof ListPackingGroupBoxesResponse + */ + pagination?: Pagination; +} +/** + * The `listPackingGroupItems` response. * @export * @interface ListPackingGroupItemsResponse */ export interface ListPackingGroupItemsResponse { /** - * Provides the information about the list of items in the inbound plan. + * Provides the information about the list of items in the packing group. * @type {Array} * @memberof ListPackingGroupItemsResponse */ @@ -1162,7 +1518,7 @@ export interface ListPackingGroupItemsResponse { pagination?: Pagination; } /** - * `listPackingOptions` response. + * The `listPlacementOptions` response. * @export * @interface ListPackingOptionsResponse */ @@ -1181,7 +1537,7 @@ export interface ListPackingOptionsResponse { pagination?: Pagination; } /** - * `listPlacementOptions` response. + * The `listPlacementOptions` response. * @export * @interface ListPlacementOptionsResponse */ @@ -1200,7 +1556,83 @@ export interface ListPlacementOptionsResponse { placementOptions: Array; } /** - * `listTransportationOptions` response. + * The `listShipmentBoxes` response. + * @export + * @interface ListShipmentBoxesResponse + */ +export interface ListShipmentBoxesResponse { + /** + * A list of boxes in a shipment. + * @type {Array} + * @memberof ListShipmentBoxesResponse + */ + boxes: Array; + /** + * + * @type {Pagination} + * @memberof ListShipmentBoxesResponse + */ + pagination?: Pagination; +} +/** + * The `ListShipmentContentUpdatePreviews` response. + * @export + * @interface ListShipmentContentUpdatePreviewsResponse + */ +export interface ListShipmentContentUpdatePreviewsResponse { + /** + * A list of content update previews in a shipment. + * @type {Array} + * @memberof ListShipmentContentUpdatePreviewsResponse + */ + contentUpdatePreviews: Array; + /** + * + * @type {Pagination} + * @memberof ListShipmentContentUpdatePreviewsResponse + */ + pagination?: Pagination; +} +/** + * The `listShipmentItems` response. + * @export + * @interface ListShipmentItemsResponse + */ +export interface ListShipmentItemsResponse { + /** + * The items in a shipment. + * @type {Array} + * @memberof ListShipmentItemsResponse + */ + items: Array; + /** + * + * @type {Pagination} + * @memberof ListShipmentItemsResponse + */ + pagination?: Pagination; +} +/** + * The `listShipmentPallets` response. + * @export + * @interface ListShipmentPalletsResponse + */ +export interface ListShipmentPalletsResponse { + /** + * + * @type {Pagination} + * @memberof ListShipmentPalletsResponse + */ + pagination?: Pagination; + /** + * The pallets in a shipment. + * @type {Array} + * @memberof ListShipmentPalletsResponse + */ + pallets: Array; +} +/** + * The `listTransportationOptions` response. * @export * @interface ListTransportationOptionsResponse */ @@ -1281,6 +1713,25 @@ export interface ModelError { */ message: string; } +/** + * Represents an msku and the related quantity. + * @export + * @interface MskuQuantity + */ +export interface MskuQuantity { + /** + * The merchant SKU, a merchant-supplied identifier for a specific SKU. + * @type {string} + * @memberof MskuQuantity + */ + msku: string; + /** + * A positive integer. + * @type {number} + * @memberof MskuQuantity + */ + quantity: number; +} /** * A problem with additional properties persisted to an operation. * @export @@ -1306,7 +1757,7 @@ export interface OperationProblem { */ message: string; /** - * The severity of the problem. Can be \'WARNING\', or \'ERROR\'. + * The severity of the problem. Can be: `WARNING`, `ERROR`. * @type {string} * @memberof OperationProblem */ @@ -1361,7 +1812,7 @@ export interface PackingOption { */ discounts: Array; /** - * The timestamp at which this packing option becomes no longer valid. This is in ISO 8601 datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * The timestamp at which this packing option becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof PackingOption */ @@ -1372,12 +1823,6 @@ export interface PackingOption { * @memberof PackingOption */ fees: Array; - /** - * Identifier to an inbound plan. - * @type {string} - * @memberof PackingOption - */ - inboundPlanId: string; /** * Packing group IDs. * @type {Array} @@ -1385,13 +1830,13 @@ export interface PackingOption { */ packingGroups: Array; /** - * Identifier to a packing option. + * Identifier of a packing option. * @type {string} * @memberof PackingOption */ packingOptionId: string; /** - * The status of the packing option. Can be `OFFERED`, `ACCEPTED`, or `EXPIRED`. + * The status of the packing option. Can be: `OFFERED`, `ACCEPTED`, or `EXPIRED`. * @type {string} * @memberof PackingOption */ @@ -1410,7 +1855,7 @@ export interface PackingOption { */ export interface PackingOptionSummary { /** - * Identifier to a packing option. + * Identifier of a packing option. * @type {string} * @memberof PackingOptionSummary */ @@ -1473,32 +1918,7 @@ export interface Pallet { weight?: Weight; } /** - * Pallet information, including weight, dimensions, quantity, stackability, freight class, and declared value. - * @export - * @interface PalletInformation - */ -export interface PalletInformation { - /** - * - * @type {Currency} - * @memberof PalletInformation - */ - declaredValue?: Currency; - /** - * Freight class. Can be `NONE`, `FC_50`, `FC_55`, `FC_60`, `FC_65`, `FC_70`, `FC_77_5`, `FC_85`, `FC_92_5`, `FC_100`, `FC_110`, `FC_125`, `FC_150`, `FC_175`, `FC_200`, `FC_250`, `FC_300`, `FC_400`, or `FC_500`. - * @type {string} - * @memberof PalletInformation - */ - freightClass?: string; - /** - * Set pallet configuration for Less-Than-Truckload (LTL). - * @type {Array} - * @memberof PalletInformation - */ - pallets: Array; -} -/** - * Set pallet configuration for Less-Than-Truckload (LTL). + * Contains input information about a pallet to be used in the inbound plan. * @export * @interface PalletInput */ @@ -1541,7 +1961,7 @@ export interface PlacementOption { */ discounts: Array; /** - * The expiration date of the placement option. This is in ISO 8601 datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * The expiration date of the placement option. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof PlacementOption */ @@ -1553,7 +1973,7 @@ export interface PlacementOption { */ fees: Array; /** - * Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. + * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} * @memberof PlacementOption */ @@ -1565,7 +1985,7 @@ export interface PlacementOption { */ shipmentIds: Array; /** - * The status of a placement option. Can be `OFFERED`, `ACCEPTED`, or `EXPIRED`. + * The status of a placement option. Can be: `OFFERED`, `ACCEPTED`, or `EXPIRED`. * @type {string} * @memberof PlacementOption */ @@ -1578,13 +1998,13 @@ export interface PlacementOption { */ export interface PlacementOptionSummary { /** - * Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. + * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} * @memberof PlacementOptionSummary */ placementOptionId: string; /** - * The status of a placement option. Can be `OFFERED` or `ACCEPTED`. + * The status of a placement option. Can be: `OFFERED` or `ACCEPTED`. * @type {string} * @memberof PlacementOptionSummary */ @@ -1603,26 +2023,27 @@ export interface PrepInstruction { */ fee?: Currency; /** - * In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON` or `SELLER`. + * In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. * @type {string} * @memberof PrepInstruction */ prepOwner?: string; /** - * Type of preparation that should be done. Can be `ITEM_LABELING`, `ITEM_BUBBLEWRAP`, `ITEM_POLYBAGGING`, `ITEM_TAPING`, `ITEM_BLACK_SHRINKWRAP`, `ITEM_HANG_GARMENT`, `ITEM_BOXING`, `ITEM_SETCREAT`, `ITEM_RMOVHANG`, `ITEM_SUFFOSTK`, `ITEM_CAP_SEALING`, `ITEM_DEBUNDLE`, `ITEM_SETSTK`, `ITEM_SIOC`, `ITEM_NO_PREP`, `ADULT`, `BABY`, `TEXTILE`, `HANGER`, `FRAGILE`, `LIQUID`, `SHARP`, `SMALL`, `PERFORATED`, `GRANULAR`, `SET`, `FC_PROVIDED`, `UNKNOWN`, or `NONE`. + * Type of preparation that should be done. Can be: `ITEM_LABELING`, `ITEM_BUBBLEWRAP`, `ITEM_POLYBAGGING`, `ITEM_TAPING`, `ITEM_BLACK_SHRINKWRAP`, `ITEM_HANG_GARMENT`, `ITEM_BOXING`, `ITEM_SETCREAT`, `ITEM_RMOVHANG`, `ITEM_SUFFOSTK`, `ITEM_CAP_SEALING`, `ITEM_DEBUNDLE`, `ITEM_SETSTK`, `ITEM_SIOC`, `ITEM_NO_PREP`, `ADULT`, `BABY`, `TEXTILE`, `HANGER`, `FRAGILE`, `LIQUID`, `SHARP`, `SMALL`, `PERFORATED`, `GRANULAR`, `SET`, `FC_PROVIDED`, `UNKNOWN`, `NONE`. * @type {string} * @memberof PrepInstruction */ prepType?: string; } /** - * In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON` or `SELLER`. + * In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. * @export * @enum {string} */ export enum PrepOwner { Amazon = 'AMAZON', - Seller = 'SELLER' + Seller = 'SELLER', + None = 'NONE' } /** @@ -1638,7 +2059,7 @@ export interface Quote { */ cost: Currency; /** - * The timestamp at which this transportation option quote becomes no longer valid. This is in ISO 8601 datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * The timestamp at which this transportation option quote becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof Quote */ @@ -1693,7 +2114,26 @@ export interface Region { warehouseId?: string; } /** - * `scheduleSelfShipAppointment` request. + * Objects that were included in the update request. + * @export + * @interface RequestedUpdates + */ +export interface RequestedUpdates { + /** + * A list of boxes that will be present in the shipment after the update. + * @type {Array} + * @memberof RequestedUpdates + */ + boxes?: Array; + /** + * A list of all items that will be present in the shipment after the update. + * @type {Array} + * @memberof RequestedUpdates + */ + items?: Array; +} +/** + * The `scheduleSelfShipAppointment` request. * @export * @interface ScheduleSelfShipAppointmentRequest */ @@ -1706,7 +2146,7 @@ export interface ScheduleSelfShipAppointmentRequest { reasonComment?: ReasonComment | 'APPOINTMENT_REQUESTED_BY_MISTAKE' | 'VEHICLE_DELAY' | 'SLOT_NOT_SUITABLE' | 'OUTSIDE_CARRIER_BUSINESS_HOURS' | 'UNFAVOURABLE_EXTERNAL_CONDITIONS' | 'PROCUREMENT_DELAY' | 'SHIPPING_PLAN_CHANGED' | 'INCREASED_QUANTITY' | 'OTHER'; } /** - * `scheduleSelfShipAppointment` response. + * The `scheduleSelfShipAppointment` response. * @export * @interface ScheduleSelfShipAppointmentResponse */ @@ -1718,6 +2158,43 @@ export interface ScheduleSelfShipAppointmentResponse { */ selfShipAppointmentDetails: SelfShipAppointmentDetails; } +/** + * Selected delivery window attributes. + * @export + * @interface SelectedDeliveryWindow + */ +export interface SelectedDeliveryWindow { + /** + * Identifies type of Delivery Window Availability. Values: `AVAILABLE`, `CONGESTED` + * @type {string} + * @memberof SelectedDeliveryWindow + */ + availabilityType: string; + /** + * Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered. + * @type {string} + * @memberof SelectedDeliveryWindow + */ + deliveryWindowOptionId: string; + /** + * The timestamp at which this Window can no longer be edited. + * @type {string} + * @memberof SelectedDeliveryWindow + */ + editableUntil?: string; + /** + * The end timestamp of the window. + * @type {string} + * @memberof SelectedDeliveryWindow + */ + endDate: string; + /** + * The start timestamp of the window. + * @type {string} + * @memberof SelectedDeliveryWindow + */ + startDate: string; +} /** * Appointment details for carrier pickup or fulfillment center appointments. * @export @@ -1750,7 +2227,7 @@ export interface SelfShipAppointmentDetails { */ export interface SelfShipAppointmentSlotsAvailability { /** - * ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. + * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof SelfShipAppointmentSlotsAvailability */ @@ -1763,7 +2240,7 @@ export interface SelfShipAppointmentSlotsAvailability { slots?: Array; } /** - * `setPackingInformation` request. + * The `setPackingInformation` request. * @export * @interface SetPackingInformationRequest */ @@ -1773,10 +2250,10 @@ export interface SetPackingInformationRequest { * @type {Array} * @memberof SetPackingInformationRequest */ - packageGroupings?: Array; + packageGroupings: Array; } /** - * `setPackingInformation` response. + * The `setPackingInformation` response. * @export * @interface SetPackingInformationResponse */ @@ -1819,11 +2296,11 @@ export interface Shipment { */ destination: ShipmentDestination; /** - * Identifier to an inbound plan. - * @type {string} + * + * @type {FreightInformation} * @memberof Shipment */ - inboundPlanId: string; + freightInformation?: FreightInformation; /** * The name of the shipment. * @type {string} @@ -1831,19 +2308,19 @@ export interface Shipment { */ name?: string; /** - * - * @type {PalletInformation} + * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. + * @type {string} * @memberof Shipment */ - palletInformation?: PalletInformation; + placementOptionId: string; /** - * Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. - * @type {string} + * + * @type {SelectedDeliveryWindow} * @memberof Shipment */ - placementOptionId: string; + selectedDeliveryWindow?: SelectedDeliveryWindow; /** - * Identifier to a transportation option. A transportation option represent one option for how to send a shipment. + * Identifier of a transportation option. A transportation option represent one option for how to send a shipment. * @type {string} * @memberof Shipment */ @@ -1855,13 +2332,13 @@ export interface Shipment { */ selfShipAppointmentDetails?: Array; /** - * The confirmed shipment ID which shows up on labels (for example, FBA1234ABCD). + * The confirmed shipment ID which shows up on labels (for example, `FBA1234ABCD`). * @type {string} * @memberof Shipment */ shipmentConfirmationId?: string; /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof Shipment */ @@ -1898,13 +2375,13 @@ export interface ShipmentDestination { */ address?: Address; /** - * The type of destination for this shipment. Can be `AMAZON_OPTIMIZED`, or `AMAZON_WAREHOUSE`. + * The type of destination for this shipment. Can be: `AMAZON_OPTIMIZED`, `AMAZON_WAREHOUSE`. * @type {string} * @memberof ShipmentDestination */ destinationType: string; /** - * The warehouse that the shipment should be sent to. Empty if the destination type is `AMAZON_OPTIMIZED`. + * The warehouse that the shipment should be sent to. Empty if the destination type is `AMAZON_OPTIMIZED`. * @type {string} * @memberof ShipmentDestination */ @@ -1923,7 +2400,7 @@ export interface ShipmentSource { */ address?: Address; /** - * The type of source for this shipment. Can be `SELLER_FACILITY`. + * The type of source for this shipment. Can be: `SELLER_FACILITY`. * @type {string} * @memberof ShipmentSource */ @@ -1936,13 +2413,13 @@ export interface ShipmentSource { */ export interface ShipmentSummary { /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof ShipmentSummary */ shipmentId: string; /** - * The status of a shipment. The state of the shipment will typically start in `WORKING` and transition to `READY_TO_SHIP` once required actions are complete prior to being picked up or shipped out. Can be `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, or `WORKING`. + * The status of a shipment. The state of the shipment will typically start in `WORKING` and transition to `READY_TO_SHIP` once required actions are complete prior to being picked up or shipped out. Can be: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `WORKING`. * @type {string} * @memberof ShipmentSummary */ @@ -1962,10 +2439,16 @@ export interface ShipmentTransportationConfiguration { contactInformation?: ContactInformation; /** * - * @type {PalletInformation} + * @type {FreightInformation} * @memberof ShipmentTransportationConfiguration */ - palletInformation?: PalletInformation; + freightInformation?: FreightInformation; + /** + * List of pallet configuration inputs. + * @type {Array} + * @memberof ShipmentTransportationConfiguration + */ + pallets?: Array; /** * * @type {WindowInput} @@ -1973,7 +2456,7 @@ export interface ShipmentTransportationConfiguration { */ readyToShipWindow: WindowInput; /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof ShipmentTransportationConfiguration */ @@ -1986,13 +2469,13 @@ export interface ShipmentTransportationConfiguration { */ export interface ShippingConfiguration { /** - * Mode of shipment transportation that this option will provide. Can be `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, or `AIR_SMALL_PARCEL_EXPRESS`. + * Mode of shipment transportation that this option will provide. Can be: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`. * @type {string} * @memberof ShippingConfiguration */ shippingMode?: string; /** - * Shipping program for the option. Can be `AMAZON_PARTNERED_CARRIER` or `USE_YOUR_OWN_CARRIER`. + * Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`. * @type {string} * @memberof ShippingConfiguration */ @@ -2031,7 +2514,7 @@ export interface SpdTrackingDetailInput { */ export interface SpdTrackingItem { /** - * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. + * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. * @type {string} * @memberof SpdTrackingItem */ @@ -2043,7 +2526,7 @@ export interface SpdTrackingItem { */ trackingId?: string; /** - * Whether or not Amazon has validated the tracking number. If more than 24 hours have passed and the status is not yet \'VALIDATED\', please verify the number and update if necessary. Can be `VALIDATED` or `NOT_VALIDATED`. + * Whether or not Amazon has validated the tracking number. If more than 24 hours have passed and the status is not yet \'VALIDATED\', please verify the number and update if necessary. Can be: `VALIDATED`, `NOT_VALIDATED`. * @type {string} * @memberof SpdTrackingItem */ @@ -2056,13 +2539,13 @@ export interface SpdTrackingItem { */ export interface SpdTrackingItemInput { /** - * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. + * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. * @type {string} * @memberof SpdTrackingItemInput */ boxId: string; /** - * The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information. + * The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information. * @type {string} * @memberof SpdTrackingItemInput */ @@ -2122,7 +2605,7 @@ export interface TaxRate { */ gstRate?: number; /** - * Type of tax. Can be `CGST`, `SGST`, `IGST`, or `TOTAL_TAX`. + * Type of tax. Can be: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`. * @type {string} * @memberof TaxRate */ @@ -2172,12 +2655,6 @@ export interface TrackingDetailsInput { * @interface TransportationOption */ export interface TransportationOption { - /** - * - * @type {AppointmentSlot} - * @memberof TransportationOption - */ - appointmentSlot?: AppointmentSlot; /** * * @type {Carrier} @@ -2185,17 +2662,17 @@ export interface TransportationOption { */ carrier: Carrier; /** - * Identifier to an inbound plan. - * @type {string} + * + * @type {CarrierAppointment} * @memberof TransportationOption */ - inboundPlanId: string; + carrierAppointment?: CarrierAppointment; /** - * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. - * @type {string} + * Identifies a list of preconditions for confirming the transportation option. + * @type {Array} * @memberof TransportationOption */ - placementOptionId: string; + preconditions: Array; /** * * @type {Quote} @@ -2203,25 +2680,25 @@ export interface TransportationOption { */ quote?: Quote; /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof TransportationOption */ shipmentId: string; /** - * The shipping mode associated with the transportation option. Available modes are ground small parcel, freight less-than-truckload (LTL), freight full-truckload (FTL) palletized, freight FTL non-palletized, ocean less-than-container-load (LCL), ocean full-container load (FCL), air small parcel, and air small parcel express. + * Mode of shipment transportation that this option will provide. Can be: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`. * @type {string} * @memberof TransportationOption */ shippingMode: string; /** - * The shipping solution associated with the transportation option. Available solutions are Amazon-partnered carrier or \'use your own carrier\'. + * Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`. * @type {string} * @memberof TransportationOption */ shippingSolution: string; /** - * Identifier to a transportation option. A transportation option represent one option for how to send a shipment. + * Identifier of a transportation option. A transportation option represent one option for how to send a shipment. * @type {string} * @memberof TransportationOption */ @@ -2239,12 +2716,6 @@ export interface TransportationSelection { * @memberof TransportationSelection */ contactInformation?: ContactInformation; - /** - * - * @type {WindowInput} - * @memberof TransportationSelection - */ - deliveryWindow?: WindowInput; /** * Shipment ID that the transportation Option is for. * @type {string} @@ -2278,6 +2749,19 @@ export enum UnitOfWeight { Kg = 'KG' } +/** + * The `updateInboundPlanName` request. + * @export + * @interface UpdateInboundPlanNameRequest + */ +export interface UpdateInboundPlanNameRequest { + /** + * A human-readable name to update the inbound plan name to. + * @type {string} + * @memberof UpdateInboundPlanNameRequest + */ + name: string; +} /** * The `updateItemComplianceDetails` request. * @export @@ -2311,28 +2795,41 @@ export interface UpdateItemComplianceDetailsResponse { operationId: string; } /** - * The `updateShipmentDeliveryWindow` request. + * The `updateShipmentName` request. * @export - * @interface UpdateShipmentDeliveryWindowRequest + * @interface UpdateShipmentNameRequest */ -export interface UpdateShipmentDeliveryWindowRequest { +export interface UpdateShipmentNameRequest { /** - * - * @type {WindowInput} - * @memberof UpdateShipmentDeliveryWindowRequest + * A human-readable name to update the shipment name to. + * @type {string} + * @memberof UpdateShipmentNameRequest */ - deliveryWindow: WindowInput; + name: string; } /** - * The `updateShipmentDeliveryWindow` response. + * The `UpdateShipmentSourceAddress` request. * @export - * @interface UpdateShipmentDeliveryWindowResponse + * @interface UpdateShipmentSourceAddressRequest */ -export interface UpdateShipmentDeliveryWindowResponse { +export interface UpdateShipmentSourceAddressRequest { + /** + * + * @type {AddressInput} + * @memberof UpdateShipmentSourceAddressRequest + */ + address: AddressInput; +} +/** + * The `UpdateShipmentSourceAddress` response. + * @export + * @interface UpdateShipmentSourceAddressResponse + */ +export interface UpdateShipmentSourceAddressResponse { /** * UUID for the given operation. * @type {string} - * @memberof UpdateShipmentDeliveryWindowResponse + * @memberof UpdateShipmentSourceAddressResponse */ operationId: string; } @@ -2427,8 +2924,8 @@ export interface WindowInput { export const FbaInboundApiAxiosParamCreator = 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2460,27 +2957,23 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Cancels a self-ship appointment slot against a 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, refer to [Usage Plans and Rate 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} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {string} slotId Identifier to a self-ship appointment slot. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelSelfShipAppointment: async (inboundPlanId: string, shipmentId: string, slotId: string, body: CancelSelfShipAppointmentRequest, options: any = {}): Promise => { + cancelSelfShipAppointment: async (inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options: any = {}): Promise => { // verify required parameter 'inboundPlanId' is not null or undefined assertParamExists('cancelSelfShipAppointment', 'inboundPlanId', inboundPlanId) // verify required parameter 'shipmentId' is not null or undefined assertParamExists('cancelSelfShipAppointment', 'shipmentId', shipmentId) - // verify required parameter 'slotId' is not null or undefined - assertParamExists('cancelSelfShipAppointment', 'slotId', slotId) // verify required parameter 'body' is not null or undefined assertParamExists('cancelSelfShipAppointment', 'body', body) - const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/cancellation` + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation` .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) - .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))) - .replace(`{${"slotId"}}`, encodeURIComponent(String(slotId))); + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -2507,9 +3000,50 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} packingOptionId Identifier to a packing option. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmDeliveryWindowOptions: async (inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('confirmDeliveryWindowOptions', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('confirmDeliveryWindowOptions', 'shipmentId', shipmentId) + // verify required parameter 'deliveryWindowOptionId' is not null or undefined + assertParamExists('confirmDeliveryWindowOptions', 'deliveryWindowOptionId', deliveryWindowOptionId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))) + .replace(`{${"deliveryWindowOptionId"}}`, encodeURIComponent(String(deliveryWindowOptionId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2544,9 +3078,9 @@ 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -2581,8 +3115,49 @@ 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmShipmentContentUpdatePreview: async (inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('confirmShipmentContentUpdatePreview', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('confirmShipmentContentUpdatePreview', 'shipmentId', shipmentId) + // verify required parameter 'contentUpdatePreviewId' is not null or undefined + assertParamExists('confirmShipmentContentUpdatePreview', 'contentUpdatePreviewId', contentUpdatePreviewId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))) + .replace(`{${"contentUpdatePreviewId"}}`, encodeURIComponent(String(contentUpdatePreviewId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2620,7 +3195,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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2655,8 +3230,80 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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 {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createMarketplaceItemLabels: async (body: CreateMarketplaceItemLabelsRequest, options: any = {}): Promise => { + // verify required parameter 'body' is not null or undefined + assertParamExists('createMarketplaceItemLabels', 'body', body) + const localVarPath = `/inbound/fba/2024-03-20/items/labels`; + // 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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {string} shipmentId The shipment to generate delivery window options for. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + generateDeliveryWindowOptions: async (inboundPlanId: string, shipmentId: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('generateDeliveryWindowOptions', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('generateDeliveryWindowOptions', 'shipmentId', shipmentId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2688,8 +3335,8 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2727,10 +3374,10 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2770,8 +3417,51 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + generateShipmentContentUpdatePreviews: async (inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('generateShipmentContentUpdatePreviews', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('generateShipmentContentUpdatePreviews', 'shipmentId', shipmentId) + // verify required parameter 'body' is not null or undefined + assertParamExists('generateShipmentContentUpdatePreviews', 'body', body) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2809,9 +3499,9 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -2846,8 +3536,8 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} operationId Identifier to an asynchronous operation. + * 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 table above indicates the default rate and burst values for 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} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2879,8 +3569,8 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2912,9 +3602,9 @@ 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. @@ -2959,9 +3649,9 @@ 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -2996,8 +3686,96 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getShipmentContentUpdatePreview: async (inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('getShipmentContentUpdatePreview', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('getShipmentContentUpdatePreview', 'shipmentId', shipmentId) + // verify required parameter 'contentUpdatePreviewId' is not null or undefined + assertParamExists('getShipmentContentUpdatePreview', 'contentUpdatePreviewId', contentUpdatePreviewId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))) + .replace(`{${"contentUpdatePreviewId"}}`, encodeURIComponent(String(contentUpdatePreviewId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listDeliveryWindowOptions: async (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('listDeliveryWindowOptions', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('listDeliveryWindowOptions', 'shipmentId', shipmentId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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 (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (paginationToken !== undefined) { + localVarQueryParameter['paginationToken'] = paginationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3039,8 +3817,8 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3082,8 +3860,8 @@ 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3125,7 +3903,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {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. @@ -3179,8 +3957,8 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {Array} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU. + * 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 table above indicates the default rate and burst values for 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 {Array} mskus List of merchant SKUs - a merchant-supplied identifier for a specific SKU. * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3222,25 +4000,21 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} packingOptionId Identifier to a packing option. - * @param {string} packingGroupId Identifier to a packing group. - * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. + * 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - listPackingGroupItems: async (inboundPlanId: string, packingOptionId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + listPackingGroupBoxes: async (inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { // verify required parameter 'inboundPlanId' is not null or undefined - assertParamExists('listPackingGroupItems', 'inboundPlanId', inboundPlanId) - // verify required parameter 'packingOptionId' is not null or undefined - assertParamExists('listPackingGroupItems', 'packingOptionId', packingOptionId) + assertParamExists('listPackingGroupBoxes', 'inboundPlanId', inboundPlanId) // verify required parameter 'packingGroupId' is not null or undefined - assertParamExists('listPackingGroupItems', 'packingGroupId', packingGroupId) - const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/packingGroups/{packingGroupId}/items` + assertParamExists('listPackingGroupBoxes', 'packingGroupId', packingGroupId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes` .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) - .replace(`{${"packingOptionId"}}`, encodeURIComponent(String(packingOptionId))) .replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -3273,18 +4047,22 @@ 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 endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {number} [pageSize] The number of packing options to return in the response matching the given query. + * 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - listPackingOptions: async (inboundPlanId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + listPackingGroupItems: async (inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { // verify required parameter 'inboundPlanId' is not null or undefined - assertParamExists('listPackingOptions', 'inboundPlanId', inboundPlanId) - const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions` - .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))); + assertParamExists('listPackingGroupItems', 'inboundPlanId', inboundPlanId) + // verify required parameter 'packingGroupId' is not null or undefined + assertParamExists('listPackingGroupItems', 'packingGroupId', packingGroupId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -3316,18 +4094,249 @@ 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 endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {number} [pageSize] The number of placement options to return in the response matching the given query. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listPlacementOptions: async (inboundPlanId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + listPackingOptions: async (inboundPlanId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { // verify required parameter 'inboundPlanId' is not null or undefined - assertParamExists('listPlacementOptions', 'inboundPlanId', inboundPlanId) - const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions` - .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))); + assertParamExists('listPackingOptions', 'inboundPlanId', inboundPlanId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))); + // 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 (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (paginationToken !== undefined) { + localVarQueryParameter['paginationToken'] = paginationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listPlacementOptions: async (inboundPlanId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('listPlacementOptions', 'inboundPlanId', inboundPlanId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))); + // 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 (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (paginationToken !== undefined) { + localVarQueryParameter['paginationToken'] = paginationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentBoxes: async (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('listShipmentBoxes', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('listShipmentBoxes', 'shipmentId', shipmentId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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 (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (paginationToken !== undefined) { + localVarQueryParameter['paginationToken'] = paginationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentContentUpdatePreviews: async (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('listShipmentContentUpdatePreviews', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('listShipmentContentUpdatePreviews', 'shipmentId', shipmentId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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 (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (paginationToken !== undefined) { + localVarQueryParameter['paginationToken'] = paginationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentItems: async (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('listShipmentItems', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('listShipmentItems', 'shipmentId', shipmentId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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 (pageSize !== undefined) { + localVarQueryParameter['pageSize'] = pageSize; + } + + if (paginationToken !== undefined) { + localVarQueryParameter['paginationToken'] = paginationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentPallets: async (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('listShipmentPallets', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('listShipmentPallets', 'shipmentId', shipmentId) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -3359,12 +4368,12 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. - * @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified. - * @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified. + * @param {string} [placementOptionId] The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. + * @param {string} [shipmentId] The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3412,10 +4421,10 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Confirms or reschedules a self-ship appointment slot against a 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, refer to [Usage Plans and Rate 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} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {string} slotId Identifier to a self-ship appointment slot. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3459,8 +4468,8 @@ 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3498,7 +4507,46 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateInboundPlanName: async (inboundPlanId: string, body: UpdateInboundPlanNameRequest, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('updateInboundPlanName', 'inboundPlanId', inboundPlanId) + // verify required parameter 'body' is not null or undefined + assertParamExists('updateInboundPlanName', 'body', body) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))); + // 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: 'PUT', ...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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. @@ -3540,21 +4588,21 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to `updateShipmentDeliveryWindow`. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateShipmentDeliveryWindow: async (inboundPlanId: string, shipmentId: string, body: UpdateShipmentDeliveryWindowRequest, options: any = {}): Promise => { + updateShipmentName: async (inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options: any = {}): Promise => { // verify required parameter 'inboundPlanId' is not null or undefined - assertParamExists('updateShipmentDeliveryWindow', 'inboundPlanId', inboundPlanId) + assertParamExists('updateShipmentName', 'inboundPlanId', inboundPlanId) // verify required parameter 'shipmentId' is not null or undefined - assertParamExists('updateShipmentDeliveryWindow', 'shipmentId', shipmentId) + assertParamExists('updateShipmentName', 'shipmentId', shipmentId) // verify required parameter 'body' is not null or undefined - assertParamExists('updateShipmentDeliveryWindow', 'body', body) - const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindow` + assertParamExists('updateShipmentName', 'body', body) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name` .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -3564,7 +4612,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -3583,21 +4631,21 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateShipmentTrackingDetails: async (inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options: any = {}): Promise => { + updateShipmentSourceAddress: async (inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options: any = {}): Promise => { // verify required parameter 'inboundPlanId' is not null or undefined - assertParamExists('updateShipmentTrackingDetails', 'inboundPlanId', inboundPlanId) + assertParamExists('updateShipmentSourceAddress', 'inboundPlanId', inboundPlanId) // verify required parameter 'shipmentId' is not null or undefined - assertParamExists('updateShipmentTrackingDetails', 'shipmentId', shipmentId) + assertParamExists('updateShipmentSourceAddress', 'shipmentId', shipmentId) // verify required parameter 'body' is not null or undefined - assertParamExists('updateShipmentTrackingDetails', 'body', body) - const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails` + assertParamExists('updateShipmentSourceAddress', 'body', body) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress` .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -3625,43 +4673,97 @@ export const FbaInboundApiAxiosParamCreator = function (configuration?: Configur options: localVarRequestOptions, }; }, - } -}; - -/** - * FbaInboundApi - functional programming interface - * @export - */ -export const FbaInboundApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = FbaInboundApiAxiosParamCreator(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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async cancelInboundPlan(inboundPlanId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelInboundPlan(inboundPlanId, options); + updateShipmentTrackingDetails: async (inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options: any = {}): Promise => { + // verify required parameter 'inboundPlanId' is not null or undefined + assertParamExists('updateShipmentTrackingDetails', 'inboundPlanId', inboundPlanId) + // verify required parameter 'shipmentId' is not null or undefined + assertParamExists('updateShipmentTrackingDetails', 'shipmentId', shipmentId) + // verify required parameter 'body' is not null or undefined + assertParamExists('updateShipmentTrackingDetails', 'body', body) + const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails` + .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId))) + .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId))); + // 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: 'PUT', ...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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * FbaInboundApi - functional programming interface + * @export + */ +export const FbaInboundApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = FbaInboundApiAxiosParamCreator(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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cancelInboundPlan(inboundPlanId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelInboundPlan(inboundPlanId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Cancels a self-ship appointment slot against a 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, refer to [Usage Plans and Rate 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} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {string} slotId Identifier to a self-ship appointment slot. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: CancelSelfShipAppointmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options); + async cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSelfShipAppointment(inboundPlanId, shipmentId, body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async confirmDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.confirmDeliveryWindowOptions(inboundPlanId, shipmentId, deliveryWindowOptionId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} packingOptionId Identifier to a packing option. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3670,9 +4772,9 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -3681,8 +4783,20 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async confirmShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3692,7 +4806,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3702,8 +4816,29 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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 {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createMarketplaceItemLabels(body: CreateMarketplaceItemLabelsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMarketplaceItemLabels(body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {string} shipmentId The shipment to generate delivery window options for. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async generateDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.generateDeliveryWindowOptions(inboundPlanId, shipmentId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3712,8 +4847,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3723,10 +4858,10 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3735,8 +4870,20 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async generateShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.generateShipmentContentUpdatePreviews(inboundPlanId, shipmentId, body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3746,9 +4893,9 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -3757,8 +4904,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} operationId Identifier to an asynchronous operation. + * 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 table above indicates the default rate and burst values for 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} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3767,8 +4914,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3777,9 +4924,9 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. @@ -3790,9 +4937,9 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -3801,8 +4948,33 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listDeliveryWindowOptions(inboundPlanId, shipmentId, pageSize, paginationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3813,8 +4985,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3825,8 +4997,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3837,7 +5009,7 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {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. @@ -3851,8 +5023,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {Array} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU. + * 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 table above indicates the default rate and burst values for 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 {Array} mskus List of merchant SKUs - a merchant-supplied identifier for a specific SKU. * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3862,22 +5034,34 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} packingOptionId Identifier to a packing option. - * @param {string} packingGroupId Identifier to a packing group. + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listPackingGroupBoxes(inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupBoxes(inboundPlanId, packingGroupId, pageSize, paginationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - async listPackingGroupItems(inboundPlanId: string, packingOptionId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupItems(inboundPlanId, packingOptionId, packingGroupId, pageSize, paginationToken, options); + async listPackingGroupItems(inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupItems(inboundPlanId, packingGroupId, pageSize, paginationToken, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3888,8 +5072,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -3900,12 +5084,64 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listShipmentBoxes(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentBoxes(inboundPlanId, shipmentId, pageSize, paginationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentContentUpdatePreviews(inboundPlanId, shipmentId, pageSize, paginationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listShipmentItems(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentItems(inboundPlanId, shipmentId, pageSize, paginationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listShipmentPallets(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentPallets(inboundPlanId, shipmentId, pageSize, paginationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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. - * @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified. - * @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified. + * @param {string} [placementOptionId] The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. + * @param {string} [shipmentId] The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3914,10 +5150,10 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Confirms or reschedules a self-ship appointment slot against a 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, refer to [Usage Plans and Rate 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} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {string} slotId Identifier to a self-ship appointment slot. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3927,8 +5163,8 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3938,7 +5174,18 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateInboundPlanName(inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateInboundPlanName(inboundPlanId, body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. @@ -3949,21 +5196,33 @@ export const FbaInboundApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to `updateShipmentDeliveryWindow`. + * 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 table above indicates the default rate and burst values for 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} 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`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateShipmentName(inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentName(inboundPlanId, shipmentId, body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateShipmentDeliveryWindow(inboundPlanId: string, shipmentId: string, body: UpdateShipmentDeliveryWindowRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentDeliveryWindow(inboundPlanId, shipmentId, body, options); + async updateShipmentSourceAddress(inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentSourceAddress(inboundPlanId, shipmentId, body, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3983,8 +5242,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas const localVarFp = FbaInboundApiFp(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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3992,21 +5251,31 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.cancelInboundPlan(inboundPlanId, options).then((request) => request(axios, basePath)); }, /** - * Cancels a self-ship appointment slot against a 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, refer to [Usage Plans and Rate 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} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {string} slotId Identifier to a self-ship appointment slot. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: CancelSelfShipAppointmentRequest, options?: any): AxiosPromise { - return localVarFp.cancelSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options).then((request) => request(axios, basePath)); + cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: any): AxiosPromise { + return localVarFp.cancelSelfShipAppointment(inboundPlanId, shipmentId, body, options).then((request) => request(axios, basePath)); }, /** - * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} packingOptionId Identifier to a packing option. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: any): AxiosPromise { + return localVarFp.confirmDeliveryWindowOptions(inboundPlanId, shipmentId, deliveryWindowOptionId, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4014,9 +5283,9 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.confirmPackingOption(inboundPlanId, packingOptionId, options).then((request) => request(axios, 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -4024,8 +5293,19 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.confirmPlacementOption(inboundPlanId, placementOptionId, options).then((request) => request(axios, 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): AxiosPromise { + return localVarFp.confirmShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4034,7 +5314,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.confirmTransportationOptions(inboundPlanId, body, options).then((request) => request(axios, 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4043,8 +5323,27 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.createInboundPlan(body, options).then((request) => request(axios, basePath)); }, /** - * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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 {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createMarketplaceItemLabels(body: CreateMarketplaceItemLabelsRequest, options?: any): AxiosPromise { + return localVarFp.createMarketplaceItemLabels(body, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {string} shipmentId The shipment to generate delivery window options for. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + generateDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, options?: any): AxiosPromise { + return localVarFp.generateDeliveryWindowOptions(inboundPlanId, shipmentId, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4052,8 +5351,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.generatePackingOptions(inboundPlanId, options).then((request) => request(axios, basePath)); }, /** - * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4062,10 +5361,10 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.generatePlacementOptions(inboundPlanId, body, options).then((request) => request(axios, basePath)); }, /** - * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4073,8 +5372,19 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.generateSelfShipAppointmentSlots(inboundPlanId, shipmentId, body, options).then((request) => request(axios, basePath)); }, /** - * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + generateShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: any): AxiosPromise { + return localVarFp.generateShipmentContentUpdatePreviews(inboundPlanId, shipmentId, body, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4083,9 +5393,9 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.generateTransportationOptions(inboundPlanId, body, options).then((request) => request(axios, basePath)); }, /** - * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -4093,8 +5403,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.getDeliveryChallanDocument(inboundPlanId, shipmentId, options).then((request) => request(axios, basePath)); }, /** - * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} operationId Identifier to an asynchronous operation. + * 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 table above indicates the default rate and burst values for 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} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4102,8 +5412,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.getInboundOperationStatus(operationId, options).then((request) => request(axios, basePath)); }, /** - * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4111,9 +5421,9 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.getInboundPlan(inboundPlanId, options).then((request) => request(axios, 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. @@ -4123,9 +5433,9 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.getSelfShipAppointmentSlots(inboundPlanId, shipmentId, pageSize, paginationToken, options).then((request) => request(axios, 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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. * @throws {RequiredError} */ @@ -4133,8 +5443,31 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.getShipment(inboundPlanId, shipmentId, options).then((request) => request(axios, basePath)); }, /** - * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): AxiosPromise { + return localVarFp.getShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listDeliveryWindowOptions(inboundPlanId, shipmentId, pageSize, paginationToken, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -4144,8 +5477,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listInboundPlanBoxes(inboundPlanId, pageSize, paginationToken, options).then((request) => request(axios, basePath)); }, /** - * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -4155,8 +5488,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listInboundPlanItems(inboundPlanId, pageSize, paginationToken, options).then((request) => request(axios, 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -4166,7 +5499,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listInboundPlanPallets(inboundPlanId, pageSize, paginationToken, options).then((request) => request(axios, basePath)); }, /** - * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {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. @@ -4179,8 +5512,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listInboundPlans(pageSize, paginationToken, status, sortBy, sortOrder, options).then((request) => request(axios, basePath)); }, /** - * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {Array} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU. + * 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 table above indicates the default rate and burst values for 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 {Array} mskus List of merchant SKUs - a merchant-supplied identifier for a specific SKU. * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4189,21 +5522,32 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listItemComplianceDetails(mskus, marketplaceId, options).then((request) => request(axios, basePath)); }, /** - * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} packingOptionId Identifier to a packing option. - * @param {string} packingGroupId Identifier to a packing group. + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listPackingGroupBoxes(inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listPackingGroupBoxes(inboundPlanId, packingGroupId, pageSize, paginationToken, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - listPackingGroupItems(inboundPlanId: string, packingOptionId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { - return localVarFp.listPackingGroupItems(inboundPlanId, packingOptionId, packingGroupId, pageSize, paginationToken, options).then((request) => request(axios, basePath)); + listPackingGroupItems(inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listPackingGroupItems(inboundPlanId, packingGroupId, pageSize, paginationToken, options).then((request) => request(axios, basePath)); }, /** - * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -4213,8 +5557,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listPackingOptions(inboundPlanId, pageSize, paginationToken, options).then((request) => request(axios, basePath)); }, /** - * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {*} [options] Override http request option. @@ -4224,12 +5568,60 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listPlacementOptions(inboundPlanId, pageSize, paginationToken, options).then((request) => request(axios, basePath)); }, /** - * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentBoxes(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listShipmentBoxes(inboundPlanId, shipmentId, pageSize, paginationToken, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listShipmentContentUpdatePreviews(inboundPlanId, shipmentId, pageSize, paginationToken, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentItems(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listShipmentItems(inboundPlanId, shipmentId, pageSize, paginationToken, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + listShipmentPallets(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise { + return localVarFp.listShipmentPallets(inboundPlanId, shipmentId, pageSize, paginationToken, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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. - * @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified. - * @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified. + * @param {string} [placementOptionId] The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. + * @param {string} [shipmentId] The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4237,10 +5629,10 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.listTransportationOptions(inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options).then((request) => request(axios, basePath)); }, /** - * Confirms or reschedules a self-ship appointment slot against a 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, refer to [Usage Plans and Rate 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} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {string} slotId Identifier to a self-ship appointment slot. + * 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 table above indicates the default rate and burst values for 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} 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. * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4249,8 +5641,8 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.scheduleSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options).then((request) => request(axios, 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 | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4259,7 +5651,17 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.setPackingInformation(inboundPlanId, body, options).then((request) => request(axios, basePath)); }, /** - * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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} inboundPlanId Identifier of an inbound plan. + * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateInboundPlanName(inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: any): AxiosPromise { + return localVarFp.updateInboundPlanName(inboundPlanId, body, options).then((request) => request(axios, basePath)); + }, + /** + * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. @@ -4269,20 +5671,31 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas return localVarFp.updateItemComplianceDetails(marketplaceId, body, options).then((request) => request(axios, basePath)); }, /** - * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. - * @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to `updateShipmentDeliveryWindow`. + * 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 table above indicates the default rate and burst values for 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} 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`. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateShipmentName(inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: any): AxiosPromise { + return localVarFp.updateShipmentName(inboundPlanId, shipmentId, body, options).then((request) => request(axios, 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateShipmentDeliveryWindow(inboundPlanId: string, shipmentId: string, body: UpdateShipmentDeliveryWindowRequest, options?: any): AxiosPromise { - return localVarFp.updateShipmentDeliveryWindow(inboundPlanId, shipmentId, body, options).then((request) => request(axios, basePath)); + updateShipmentSourceAddress(inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: any): AxiosPromise { + return localVarFp.updateShipmentSourceAddress(inboundPlanId, shipmentId, body, options).then((request) => request(axios, basePath)); }, /** - * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {string} inboundPlanId Identifier to an inbound plan. - * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * 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 table above indicates the default rate and burst values for 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} 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`. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4300,7 +5713,7 @@ export const FbaInboundApiFactory = function (configuration?: Configuration, bas */ export interface FbaInboundApiCancelInboundPlanRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiCancelInboundPlan */ @@ -4314,26 +5727,19 @@ export interface FbaInboundApiCancelInboundPlanRequest { */ export interface FbaInboundApiCancelSelfShipAppointmentRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiCancelSelfShipAppointment */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiCancelSelfShipAppointment */ readonly shipmentId: string - /** - * Identifier to a self-ship appointment slot. - * @type {string} - * @memberof FbaInboundApiCancelSelfShipAppointment - */ - readonly slotId: string - /** * The body of the request to `cancelSelfShipAppointment`. * @type {CancelSelfShipAppointmentRequest} @@ -4342,6 +5748,34 @@ export interface FbaInboundApiCancelSelfShipAppointmentRequest { readonly body: CancelSelfShipAppointmentRequest } +/** + * Request parameters for confirmDeliveryWindowOptions operation in FbaInboundApi. + * @export + * @interface FbaInboundApiConfirmDeliveryWindowOptionsRequest + */ +export interface FbaInboundApiConfirmDeliveryWindowOptionsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiConfirmDeliveryWindowOptions + */ + readonly inboundPlanId: string + + /** + * The shipment to confirm the delivery window option for. + * @type {string} + * @memberof FbaInboundApiConfirmDeliveryWindowOptions + */ + readonly shipmentId: string + + /** + * The id of the delivery window option to be confirmed. + * @type {string} + * @memberof FbaInboundApiConfirmDeliveryWindowOptions + */ + readonly deliveryWindowOptionId: string +} + /** * Request parameters for confirmPackingOption operation in FbaInboundApi. * @export @@ -4349,14 +5783,14 @@ export interface FbaInboundApiCancelSelfShipAppointmentRequest { */ export interface FbaInboundApiConfirmPackingOptionRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiConfirmPackingOption */ readonly inboundPlanId: string /** - * Identifier to a packing option. + * Identifier of a packing option. * @type {string} * @memberof FbaInboundApiConfirmPackingOption */ @@ -4370,14 +5804,14 @@ export interface FbaInboundApiConfirmPackingOptionRequest { */ export interface FbaInboundApiConfirmPlacementOptionRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiConfirmPlacementOption */ readonly inboundPlanId: string /** - * Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs. + * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} * @memberof FbaInboundApiConfirmPlacementOption */ @@ -4385,22 +5819,50 @@ export interface FbaInboundApiConfirmPlacementOptionRequest { } /** - * Request parameters for confirmTransportationOptions operation in FbaInboundApi. + * Request parameters for confirmShipmentContentUpdatePreview operation in FbaInboundApi. * @export - * @interface FbaInboundApiConfirmTransportationOptionsRequest + * @interface FbaInboundApiConfirmShipmentContentUpdatePreviewRequest */ -export interface FbaInboundApiConfirmTransportationOptionsRequest { +export interface FbaInboundApiConfirmShipmentContentUpdatePreviewRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiConfirmTransportationOptions + * @memberof FbaInboundApiConfirmShipmentContentUpdatePreview */ readonly inboundPlanId: string /** - * The body of the request to `confirmTransportationOptions`. - * @type {ConfirmTransportationOptionsRequest} - * @memberof FbaInboundApiConfirmTransportationOptions + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiConfirmShipmentContentUpdatePreview + */ + readonly shipmentId: string + + /** + * Identifier of a content update preview. + * @type {string} + * @memberof FbaInboundApiConfirmShipmentContentUpdatePreview + */ + readonly contentUpdatePreviewId: string +} + +/** + * Request parameters for confirmTransportationOptions operation in FbaInboundApi. + * @export + * @interface FbaInboundApiConfirmTransportationOptionsRequest + */ +export interface FbaInboundApiConfirmTransportationOptionsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiConfirmTransportationOptions + */ + readonly inboundPlanId: string + + /** + * The body of the request to `confirmTransportationOptions`. + * @type {ConfirmTransportationOptionsRequest} + * @memberof FbaInboundApiConfirmTransportationOptions */ readonly body: ConfirmTransportationOptionsRequest } @@ -4419,6 +5881,41 @@ export interface FbaInboundApiCreateInboundPlanRequest { readonly body: CreateInboundPlanRequest } +/** + * Request parameters for createMarketplaceItemLabels operation in FbaInboundApi. + * @export + * @interface FbaInboundApiCreateMarketplaceItemLabelsRequest + */ +export interface FbaInboundApiCreateMarketplaceItemLabelsRequest { + /** + * The body of the request to `createMarketplaceItemLabels`. + * @type {CreateMarketplaceItemLabelsRequest} + * @memberof FbaInboundApiCreateMarketplaceItemLabels + */ + readonly body: CreateMarketplaceItemLabelsRequest +} + +/** + * Request parameters for generateDeliveryWindowOptions operation in FbaInboundApi. + * @export + * @interface FbaInboundApiGenerateDeliveryWindowOptionsRequest + */ +export interface FbaInboundApiGenerateDeliveryWindowOptionsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiGenerateDeliveryWindowOptions + */ + readonly inboundPlanId: string + + /** + * The shipment to generate delivery window options for. + * @type {string} + * @memberof FbaInboundApiGenerateDeliveryWindowOptions + */ + readonly shipmentId: string +} + /** * Request parameters for generatePackingOptions operation in FbaInboundApi. * @export @@ -4426,7 +5923,7 @@ export interface FbaInboundApiCreateInboundPlanRequest { */ export interface FbaInboundApiGeneratePackingOptionsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGeneratePackingOptions */ @@ -4440,7 +5937,7 @@ export interface FbaInboundApiGeneratePackingOptionsRequest { */ export interface FbaInboundApiGeneratePlacementOptionsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGeneratePlacementOptions */ @@ -4461,27 +5958,55 @@ export interface FbaInboundApiGeneratePlacementOptionsRequest { */ export interface FbaInboundApiGenerateSelfShipAppointmentSlotsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGenerateSelfShipAppointmentSlots */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiGenerateSelfShipAppointmentSlots */ readonly shipmentId: string /** - * The body of the request `generateSelfShipAppointmentSlots`. + * The body of the request to `generateSelfShipAppointmentSlots`. * @type {GenerateSelfShipAppointmentSlotsRequest} * @memberof FbaInboundApiGenerateSelfShipAppointmentSlots */ readonly body: GenerateSelfShipAppointmentSlotsRequest } +/** + * Request parameters for generateShipmentContentUpdatePreviews operation in FbaInboundApi. + * @export + * @interface FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest + */ +export interface FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiGenerateShipmentContentUpdatePreviews + */ + readonly inboundPlanId: string + + /** + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiGenerateShipmentContentUpdatePreviews + */ + readonly shipmentId: string + + /** + * The body of the request to `generateShipmentContentUpdatePreviews`. + * @type {GenerateShipmentContentUpdatePreviewsRequest} + * @memberof FbaInboundApiGenerateShipmentContentUpdatePreviews + */ + readonly body: GenerateShipmentContentUpdatePreviewsRequest +} + /** * Request parameters for generateTransportationOptions operation in FbaInboundApi. * @export @@ -4489,7 +6014,7 @@ export interface FbaInboundApiGenerateSelfShipAppointmentSlotsRequest { */ export interface FbaInboundApiGenerateTransportationOptionsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGenerateTransportationOptions */ @@ -4510,14 +6035,14 @@ export interface FbaInboundApiGenerateTransportationOptionsRequest { */ export interface FbaInboundApiGetDeliveryChallanDocumentRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGetDeliveryChallanDocument */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiGetDeliveryChallanDocument */ @@ -4531,7 +6056,7 @@ export interface FbaInboundApiGetDeliveryChallanDocumentRequest { */ export interface FbaInboundApiGetInboundOperationStatusRequest { /** - * Identifier to an asynchronous operation. + * Identifier of an asynchronous operation. * @type {string} * @memberof FbaInboundApiGetInboundOperationStatus */ @@ -4545,7 +6070,7 @@ export interface FbaInboundApiGetInboundOperationStatusRequest { */ export interface FbaInboundApiGetInboundPlanRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGetInboundPlan */ @@ -4559,14 +6084,14 @@ export interface FbaInboundApiGetInboundPlanRequest { */ export interface FbaInboundApiGetSelfShipAppointmentSlotsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGetSelfShipAppointmentSlots */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiGetSelfShipAppointmentSlots */ @@ -4594,20 +6119,83 @@ export interface FbaInboundApiGetSelfShipAppointmentSlotsRequest { */ export interface FbaInboundApiGetShipmentRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiGetShipment */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiGetShipment */ readonly shipmentId: string } +/** + * Request parameters for getShipmentContentUpdatePreview operation in FbaInboundApi. + * @export + * @interface FbaInboundApiGetShipmentContentUpdatePreviewRequest + */ +export interface FbaInboundApiGetShipmentContentUpdatePreviewRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiGetShipmentContentUpdatePreview + */ + readonly inboundPlanId: string + + /** + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiGetShipmentContentUpdatePreview + */ + readonly shipmentId: string + + /** + * Identifier of a content update preview. + * @type {string} + * @memberof FbaInboundApiGetShipmentContentUpdatePreview + */ + readonly contentUpdatePreviewId: string +} + +/** + * Request parameters for listDeliveryWindowOptions operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListDeliveryWindowOptionsRequest + */ +export interface FbaInboundApiListDeliveryWindowOptionsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiListDeliveryWindowOptions + */ + readonly inboundPlanId: string + + /** + * The shipment to get delivery window options for. + * @type {string} + * @memberof FbaInboundApiListDeliveryWindowOptions + */ + readonly shipmentId: string + + /** + * The number of delivery window options to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListDeliveryWindowOptions + */ + 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 + */ + readonly paginationToken?: string +} + /** * Request parameters for listInboundPlanBoxes operation in FbaInboundApi. * @export @@ -4615,240 +6203,408 @@ export interface FbaInboundApiGetShipmentRequest { */ export interface FbaInboundApiListInboundPlanBoxesRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiListInboundPlanBoxes */ readonly inboundPlanId: string /** - * The number of boxes to return in the response matching the given query. + * The number of boxes to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListInboundPlanBoxes + */ + 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 + */ + readonly paginationToken?: string +} + +/** + * Request parameters for listInboundPlanItems operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListInboundPlanItemsRequest + */ +export interface FbaInboundApiListInboundPlanItemsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiListInboundPlanItems + */ + readonly inboundPlanId: string + + /** + * The number of items to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListInboundPlanItems + */ + 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 + */ + readonly paginationToken?: string +} + +/** + * Request parameters for listInboundPlanPallets operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListInboundPlanPalletsRequest + */ +export interface FbaInboundApiListInboundPlanPalletsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiListInboundPlanPallets + */ + readonly inboundPlanId: string + + /** + * The number of pallets to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListInboundPlanPallets + */ + 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 + */ + readonly paginationToken?: string +} + +/** + * Request parameters for listInboundPlans operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListInboundPlansRequest + */ +export interface FbaInboundApiListInboundPlansRequest { + /** + * The number of inbound plans to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListInboundPlans + */ + 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 + */ + readonly paginationToken?: string + + /** + * The status of an inbound plan. + * @type {'ACTIVE' | 'VOIDED' | 'SHIPPED'} + * @memberof FbaInboundApiListInboundPlans + */ + readonly status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED' + + /** + * Sort by field. + * @type {'LAST_UPDATED_TIME' | 'CREATION_TIME'} + * @memberof FbaInboundApiListInboundPlans + */ + readonly sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME' + + /** + * The sort order. + * @type {'ASC' | 'DESC'} + * @memberof FbaInboundApiListInboundPlans + */ + readonly sortOrder?: 'ASC' | 'DESC' +} + +/** + * Request parameters for listItemComplianceDetails operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListItemComplianceDetailsRequest + */ +export interface FbaInboundApiListItemComplianceDetailsRequest { + /** + * List of merchant SKUs - a merchant-supplied identifier for a specific SKU. + * @type {Array} + * @memberof FbaInboundApiListItemComplianceDetails + */ + readonly mskus: Array + + /** + * The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. + * @type {string} + * @memberof FbaInboundApiListItemComplianceDetails + */ + readonly marketplaceId: string +} + +/** + * Request parameters for listPackingGroupBoxes operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListPackingGroupBoxesRequest + */ +export interface FbaInboundApiListPackingGroupBoxesRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiListPackingGroupBoxes + */ + readonly inboundPlanId: string + + /** + * Identifier of a packing group. + * @type {string} + * @memberof FbaInboundApiListPackingGroupBoxes + */ + readonly packingGroupId: string + + /** + * The number of packing group boxes to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListPackingGroupBoxes + */ + 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 + */ + readonly paginationToken?: string +} + +/** + * Request parameters for listPackingGroupItems operation in FbaInboundApi. + * @export + * @interface FbaInboundApiListPackingGroupItemsRequest + */ +export interface FbaInboundApiListPackingGroupItemsRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiListPackingGroupItems + */ + readonly inboundPlanId: string + + /** + * Identifier of a packing group. + * @type {string} + * @memberof FbaInboundApiListPackingGroupItems + */ + readonly packingGroupId: string + + /** + * The number of packing group items to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlanBoxes + * @memberof FbaInboundApiListPackingGroupItems */ 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 FbaInboundApiListPackingGroupItems */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlanItems operation in FbaInboundApi. + * Request parameters for listPackingOptions operation in FbaInboundApi. * @export - * @interface FbaInboundApiListInboundPlanItemsRequest + * @interface FbaInboundApiListPackingOptionsRequest */ -export interface FbaInboundApiListInboundPlanItemsRequest { +export interface FbaInboundApiListPackingOptionsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListInboundPlanItems + * @memberof FbaInboundApiListPackingOptions */ readonly inboundPlanId: string /** - * The number of items to return in the response matching the given query. + * The number of packing options to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlanItems + * @memberof FbaInboundApiListPackingOptions */ 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 FbaInboundApiListPackingOptions */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlanPallets operation in FbaInboundApi. + * Request parameters for listPlacementOptions operation in FbaInboundApi. * @export - * @interface FbaInboundApiListInboundPlanPalletsRequest + * @interface FbaInboundApiListPlacementOptionsRequest */ -export interface FbaInboundApiListInboundPlanPalletsRequest { +export interface FbaInboundApiListPlacementOptionsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListInboundPlanPallets + * @memberof FbaInboundApiListPlacementOptions */ readonly inboundPlanId: string /** - * The number of pallets to return in the response matching the given query. + * The number of placement options to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListInboundPlanPallets + * @memberof FbaInboundApiListPlacementOptions */ 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 FbaInboundApiListPlacementOptions */ readonly paginationToken?: string } /** - * Request parameters for listInboundPlans operation in FbaInboundApi. + * Request parameters for listShipmentBoxes operation in FbaInboundApi. * @export - * @interface FbaInboundApiListInboundPlansRequest + * @interface FbaInboundApiListShipmentBoxesRequest */ -export interface FbaInboundApiListInboundPlansRequest { - /** - * The number of inbound plans to return in the response matching the given query. - * @type {number} - * @memberof FbaInboundApiListInboundPlans - */ - readonly pageSize?: number - +export interface FbaInboundApiListShipmentBoxesRequest { /** - * 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. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListInboundPlans - */ - readonly paginationToken?: string - - /** - * The status of an inbound plan. - * @type {'ACTIVE' | 'VOIDED' | 'SHIPPED'} - * @memberof FbaInboundApiListInboundPlans - */ - readonly status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED' - - /** - * Sort by field. - * @type {'LAST_UPDATED_TIME' | 'CREATION_TIME'} - * @memberof FbaInboundApiListInboundPlans + * @memberof FbaInboundApiListShipmentBoxes */ - readonly sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME' + readonly inboundPlanId: string /** - * The sort order. - * @type {'ASC' | 'DESC'} - * @memberof FbaInboundApiListInboundPlans + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiListShipmentBoxes */ - readonly sortOrder?: 'ASC' | 'DESC' -} + readonly shipmentId: string -/** - * Request parameters for listItemComplianceDetails operation in FbaInboundApi. - * @export - * @interface FbaInboundApiListItemComplianceDetailsRequest - */ -export interface FbaInboundApiListItemComplianceDetailsRequest { /** - * List of merchant SKUs, a merchant-supplied identifier for a specific SKU. - * @type {Array} - * @memberof FbaInboundApiListItemComplianceDetails + * The number of boxes to return in the response matching the given query. + * @type {number} + * @memberof FbaInboundApiListShipmentBoxes */ - readonly mskus: Array + readonly pageSize?: number /** - * The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. + * 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 FbaInboundApiListItemComplianceDetails + * @memberof FbaInboundApiListShipmentBoxes */ - readonly marketplaceId: string + readonly paginationToken?: string } /** - * Request parameters for listPackingGroupItems operation in FbaInboundApi. + * Request parameters for listShipmentContentUpdatePreviews operation in FbaInboundApi. * @export - * @interface FbaInboundApiListPackingGroupItemsRequest + * @interface FbaInboundApiListShipmentContentUpdatePreviewsRequest */ -export interface FbaInboundApiListPackingGroupItemsRequest { +export interface FbaInboundApiListShipmentContentUpdatePreviewsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FbaInboundApiListShipmentContentUpdatePreviews */ readonly inboundPlanId: string /** - * Identifier to a packing option. - * @type {string} - * @memberof FbaInboundApiListPackingGroupItems - */ - readonly packingOptionId: string - - /** - * Identifier to a packing group. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FbaInboundApiListShipmentContentUpdatePreviews */ - readonly packingGroupId: string + readonly shipmentId: string /** - * The number of packing group items to return in the response matching the given query. + * The number of content update previews to return. * @type {number} - * @memberof FbaInboundApiListPackingGroupItems + * @memberof FbaInboundApiListShipmentContentUpdatePreviews */ 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 FbaInboundApiListShipmentContentUpdatePreviews */ readonly paginationToken?: string } /** - * Request parameters for listPackingOptions operation in FbaInboundApi. + * Request parameters for listShipmentItems operation in FbaInboundApi. * @export - * @interface FbaInboundApiListPackingOptionsRequest + * @interface FbaInboundApiListShipmentItemsRequest */ -export interface FbaInboundApiListPackingOptionsRequest { +export interface FbaInboundApiListShipmentItemsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPackingOptions + * @memberof FbaInboundApiListShipmentItems */ readonly inboundPlanId: string /** - * The number of packing options to return in the response matching the given query. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiListShipmentItems + */ + readonly shipmentId: string + + /** + * The number of items to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListPackingOptions + * @memberof FbaInboundApiListShipmentItems */ 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 FbaInboundApiListShipmentItems */ readonly paginationToken?: string } /** - * Request parameters for listPlacementOptions operation in FbaInboundApi. + * Request parameters for listShipmentPallets operation in FbaInboundApi. * @export - * @interface FbaInboundApiListPlacementOptionsRequest + * @interface FbaInboundApiListShipmentPalletsRequest */ -export interface FbaInboundApiListPlacementOptionsRequest { +export interface FbaInboundApiListShipmentPalletsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiListPlacementOptions + * @memberof FbaInboundApiListShipmentPallets */ readonly inboundPlanId: string /** - * The number of placement options to return in the response matching the given query. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiListShipmentPallets + */ + readonly shipmentId: string + + /** + * The number of pallets to return in the response matching the given query. * @type {number} - * @memberof FbaInboundApiListPlacementOptions + * @memberof FbaInboundApiListShipmentPallets */ 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 FbaInboundApiListShipmentPallets */ readonly paginationToken?: string } @@ -4860,7 +6616,7 @@ export interface FbaInboundApiListPlacementOptionsRequest { */ export interface FbaInboundApiListTransportationOptionsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiListTransportationOptions */ @@ -4881,14 +6637,14 @@ export interface FbaInboundApiListTransportationOptionsRequest { readonly paginationToken?: string /** - * The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified. + * The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @type {string} * @memberof FbaInboundApiListTransportationOptions */ readonly placementOptionId?: string /** - * The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified. + * The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @type {string} * @memberof FbaInboundApiListTransportationOptions */ @@ -4902,21 +6658,21 @@ export interface FbaInboundApiListTransportationOptionsRequest { */ export interface FbaInboundApiScheduleSelfShipAppointmentRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiScheduleSelfShipAppointment */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiScheduleSelfShipAppointment */ readonly shipmentId: string /** - * Identifier to a self-ship appointment slot. + * An identifier to a self-ship appointment slot. * @type {string} * @memberof FbaInboundApiScheduleSelfShipAppointment */ @@ -4937,7 +6693,7 @@ export interface FbaInboundApiScheduleSelfShipAppointmentRequest { */ export interface FbaInboundApiSetPackingInformationRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiSetPackingInformation */ @@ -4951,6 +6707,27 @@ export interface FbaInboundApiSetPackingInformationRequest { readonly body: SetPackingInformationRequest } +/** + * Request parameters for updateInboundPlanName operation in FbaInboundApi. + * @export + * @interface FbaInboundApiUpdateInboundPlanNameRequest + */ +export interface FbaInboundApiUpdateInboundPlanNameRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiUpdateInboundPlanName + */ + readonly inboundPlanId: string + + /** + * The body of the request to `updateInboundPlanName`. + * @type {UpdateInboundPlanNameRequest} + * @memberof FbaInboundApiUpdateInboundPlanName + */ + readonly body: UpdateInboundPlanNameRequest +} + /** * Request parameters for updateItemComplianceDetails operation in FbaInboundApi. * @export @@ -4973,31 +6750,59 @@ export interface FbaInboundApiUpdateItemComplianceDetailsRequest { } /** - * Request parameters for updateShipmentDeliveryWindow operation in FbaInboundApi. + * Request parameters for updateShipmentName operation in FbaInboundApi. + * @export + * @interface FbaInboundApiUpdateShipmentNameRequest + */ +export interface FbaInboundApiUpdateShipmentNameRequest { + /** + * Identifier of an inbound plan. + * @type {string} + * @memberof FbaInboundApiUpdateShipmentName + */ + readonly inboundPlanId: string + + /** + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. + * @type {string} + * @memberof FbaInboundApiUpdateShipmentName + */ + readonly shipmentId: string + + /** + * The body of the request to `updateShipmentName`. + * @type {UpdateShipmentNameRequest} + * @memberof FbaInboundApiUpdateShipmentName + */ + readonly body: UpdateShipmentNameRequest +} + +/** + * Request parameters for updateShipmentSourceAddress operation in FbaInboundApi. * @export - * @interface FbaInboundApiUpdateShipmentDeliveryWindowRequest + * @interface FbaInboundApiUpdateShipmentSourceAddressRequest */ -export interface FbaInboundApiUpdateShipmentDeliveryWindowRequest { +export interface FbaInboundApiUpdateShipmentSourceAddressRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} - * @memberof FbaInboundApiUpdateShipmentDeliveryWindow + * @memberof FbaInboundApiUpdateShipmentSourceAddress */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} - * @memberof FbaInboundApiUpdateShipmentDeliveryWindow + * @memberof FbaInboundApiUpdateShipmentSourceAddress */ readonly shipmentId: string /** - * The body of the request to `updateShipmentDeliveryWindow`. - * @type {UpdateShipmentDeliveryWindowRequest} - * @memberof FbaInboundApiUpdateShipmentDeliveryWindow + * The body of the request to `updateShipmentSourceAddress`. + * @type {UpdateShipmentSourceAddressRequest} + * @memberof FbaInboundApiUpdateShipmentSourceAddress */ - readonly body: UpdateShipmentDeliveryWindowRequest + readonly body: UpdateShipmentSourceAddressRequest } /** @@ -5007,14 +6812,14 @@ export interface FbaInboundApiUpdateShipmentDeliveryWindowRequest { */ export interface FbaInboundApiUpdateShipmentTrackingDetailsRequest { /** - * Identifier to an inbound plan. + * Identifier of an inbound plan. * @type {string} * @memberof FbaInboundApiUpdateShipmentTrackingDetails */ readonly inboundPlanId: string /** - * Identifier to a shipment. A shipment contains the boxes and units being inbounded. + * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FbaInboundApiUpdateShipmentTrackingDetails */ @@ -5036,7 +6841,7 @@ export interface FbaInboundApiUpdateShipmentTrackingDetailsRequest { */ export class FbaInboundApi 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5047,18 +6852,29 @@ export class FbaInboundApi extends BaseAPI { } /** - * Cancels a self-ship appointment slot against a 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * Cancels 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 table above indicates the default rate and burst values for 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 {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FbaInboundApi */ public cancelSelfShipAppointment(requestParameters: FbaInboundApiCancelSelfShipAppointmentRequest, options?: any) { - return FbaInboundApiFp(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + return FbaInboundApiFp(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 table above indicates the default rate and burst values for 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 {FbaInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); } /** - * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5069,7 +6885,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5080,7 +6896,18 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5091,7 +6918,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5102,7 +6929,29 @@ export class FbaInboundApi extends BaseAPI { } /** - * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + public createMarketplaceItemLabels(requestParameters: FbaInboundApiCreateMarketplaceItemLabelsRequest, options?: any) { + return FbaInboundApiFp(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 table above indicates the default rate and burst values for 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 {FbaInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + public generateDeliveryWindowOptions(requestParameters: FbaInboundApiGenerateDeliveryWindowOptionsRequest, options?: any) { + return FbaInboundApiFp(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 table above indicates the default rate and burst values for 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 {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5113,7 +6962,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5124,7 +6973,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5135,7 +6984,18 @@ export class FbaInboundApi extends BaseAPI { } /** - * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5146,7 +7006,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5157,7 +7017,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5168,7 +7028,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5179,7 +7039,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5190,7 +7050,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGetShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5201,7 +7061,29 @@ export class FbaInboundApi extends BaseAPI { } /** - * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5212,7 +7094,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5223,7 +7105,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5234,7 +7116,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5245,7 +7127,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5256,18 +7138,29 @@ export class FbaInboundApi extends BaseAPI { } /** - * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FbaInboundApi */ public listPackingGroupItems(requestParameters: FbaInboundApiListPackingGroupItemsRequest, options?: any) { - return FbaInboundApiFp(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingOptionId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath)); + return FbaInboundApiFp(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 endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5278,7 +7171,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5289,7 +7182,51 @@ export class FbaInboundApi extends BaseAPI { } /** - * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListShipmentBoxesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListShipmentItemsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListShipmentPalletsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5300,7 +7237,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * Confirms or reschedules a self-ship appointment slot against a 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5311,7 +7248,7 @@ export class FbaInboundApi extends BaseAPI { } /** - * 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 | | ---- | ---- | | 0.05 | 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). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5322,7 +7259,18 @@ export class FbaInboundApi extends BaseAPI { } /** - * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + public updateInboundPlanName(requestParameters: FbaInboundApiUpdateInboundPlanNameRequest, options?: any) { + return FbaInboundApiFp(this.configuration).updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5333,18 +7281,29 @@ export class FbaInboundApi extends BaseAPI { } /** - * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {FbaInboundApiUpdateShipmentDeliveryWindowRequest} requestParameters Request parameters. + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiUpdateShipmentNameRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaInboundApi + */ + 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)); + } + + /** + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FbaInboundApi */ - public updateShipmentDeliveryWindow(requestParameters: FbaInboundApiUpdateShipmentDeliveryWindowRequest, options?: any) { - return FbaInboundApiFp(this.configuration).updateShipmentDeliveryWindow(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + 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)); } /** - * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * 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 table above indicates the default rate and burst values for 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 {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/fulfillment-outbound-api-model/api.ts b/src/api-models/fulfillment-outbound-api-model/api.ts index 71d0fa776..96513ed18 100644 --- a/src/api-models/fulfillment-outbound-api-model/api.ts +++ b/src/api-models/fulfillment-outbound-api-model/api.ts @@ -122,6 +122,34 @@ export interface Address { */ phone?: string; } +/** + * A quantity based on unit of measure. + * @export + * @interface Amount + */ +export interface Amount { + /** + * The unit of measure for the amount. + * @type {string} + * @memberof Amount + */ + unitOfMeasure: AmountUnitOfMeasureEnum | 'Eaches'; + /** + * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. + * @type {string} + * @memberof Amount + */ + value: string; +} + +/** + * @export + * @enum {string} + */ +export enum AmountUnitOfMeasureEnum { + Eaches = 'Eaches' +} + /** * The COD (Cash On Delivery) charges that you associate with a COD fulfillment order. * @export @@ -258,7 +286,7 @@ export interface CreateFulfillmentOrderRequest { */ displayableOrderId: string; /** - * + * Date timestamp * @type {string} * @memberof CreateFulfillmentOrderRequest */ @@ -287,6 +315,12 @@ export interface CreateFulfillmentOrderRequest { * @memberof CreateFulfillmentOrderRequest */ destinationAddress: Address; + /** + * + * @type {DeliveryPreferences} + * @memberof CreateFulfillmentOrderRequest + */ + deliveryPreferences?: DeliveryPreferences; /** * * @type {FulfillmentAction} @@ -382,7 +416,7 @@ export interface CreateFulfillmentReturnResponse { errors?: Array; } /** - * + * The result for the createFulfillmentReturn operation. * @export * @interface CreateFulfillmentReturnResult */ @@ -469,6 +503,129 @@ export enum CurrentStatus { ReturnReceivedInFc = 'RETURN_RECEIVED_IN_FC' } +/** + * The time range within which something (for example, a delivery) will occur. + * @export + * @interface DateRange + */ +export interface DateRange { + /** + * Date timestamp + * @type {string} + * @memberof DateRange + */ + earliest: string; + /** + * Date timestamp + * @type {string} + * @memberof DateRange + */ + latest: string; +} +/** + * Localized messaging for a delivery offering. + * @export + * @interface DeliveryMessage + */ +export interface DeliveryMessage { + /** + * The message content for a delivery offering. + * @type {string} + * @memberof DeliveryMessage + */ + text?: string; + /** + * The locale for the message (for example, en_US). + * @type {string} + * @memberof DeliveryMessage + */ + locale?: string; +} +/** + * An available offer for delivery of a product. + * @export + * @interface DeliveryOffer + */ +export interface DeliveryOffer { + /** + * Date timestamp + * @type {string} + * @memberof DeliveryOffer + */ + expiresAt?: string; + /** + * + * @type {DateRange} + * @memberof DeliveryOffer + */ + dateRange?: DateRange; + /** + * + * @type {DeliveryPolicy} + * @memberof DeliveryOffer + */ + policy?: DeliveryPolicy; +} +/** + * The policy for a delivery offering. + * @export + * @interface DeliveryPolicy + */ +export interface DeliveryPolicy { + /** + * + * @type {DeliveryMessage} + * @memberof 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. + * @export + * @interface DeliveryPreferences + */ +export interface DeliveryPreferences { + /** + * Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, \'Beware of dogs\', etc. + * @type {string} + * @memberof DeliveryPreferences + */ + deliveryInstructions?: string; + /** + * + * @type {DropOffLocation} + * @memberof DeliveryPreferences + */ + dropOffLocation?: DropOffLocation; +} +/** + * A quantity based on unit of measure. + * @export + * @interface DeliveryQuantity + */ +export interface DeliveryQuantity { + /** + * The unit of measure for the amount. + * @type {string} + * @memberof DeliveryQuantity + */ + unitOfMeasure: DeliveryQuantityUnitOfMeasureEnum | 'Each'; + /** + * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. + * @type {string} + * @memberof DeliveryQuantity + */ + amount: string; +} + +/** + * @export + * @enum {string} + */ +export enum DeliveryQuantityUnitOfMeasureEnum { + Each = 'Each' +} + /** * The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace. * @export @@ -476,18 +633,72 @@ export enum CurrentStatus { */ export interface DeliveryWindow { /** - * + * Date timestamp * @type {string} * @memberof DeliveryWindow */ startDate: string; /** - * + * Date timestamp * @type {string} * @memberof DeliveryWindow */ endDate: string; } +/** + * The destination for the delivery offer. + * @export + * @interface Destination + */ +export interface Destination { + /** + * + * @type {VariablePrecisionAddress} + * @memberof Destination + */ + deliveryAddress?: VariablePrecisionAddress; + /** + * An IP Address. + * @type {string} + * @memberof Destination + */ + ipAddress?: string; +} +/** + * The preferred location to leave packages at the destination address. + * @export + * @interface DropOffLocation + */ +export interface DropOffLocation { + /** + * Specifies the preferred location to leave the package at the destination address. + * @type {string} + * @memberof DropOffLocation + */ + type: DropOffLocationTypeEnum | 'FRONT_DOOR' | 'DELIVERY_BOX' | 'GAS_METER_BOX' | 'BICYCLE_BASKET' | 'GARAGE' | 'RECEPTIONIST' | 'FALLBACK_NEIGHBOR_DELIVERY' | 'DO_NOT_LEAVE_UNATTENDED'; + /** + * Additional information about the drop-off location that can vary depending on the type of drop-off location specified in the `type` field. If the `type` is set to `FALLBACK_NEIGHBOR_DELIVERY`, the `attributes` object should include the exact keys `neighborName` and `houseNumber` to provide the name and house number of the designated neighbor. + * @type {{ [key: string]: string; }} + * @memberof DropOffLocation + */ + attributes?: { [key: string]: string; }; +} + +/** + * @export + * @enum {string} + */ +export enum DropOffLocationTypeEnum { + FrontDoor = 'FRONT_DOOR', + DeliveryBox = 'DELIVERY_BOX', + GasMeterBox = 'GAS_METER_BOX', + BicycleBasket = 'BICYCLE_BASKET', + Garage = 'GARAGE', + Receptionist = 'RECEPTIONIST', + FallbackNeighborDelivery = 'FALLBACK_NEIGHBOR_DELIVERY', + DoNotLeaveUnattended = 'DO_NOT_LEAVE_UNATTENDED' +} + /** * The event code for the delivery event. * @export @@ -686,7 +897,7 @@ export interface FulfillmentOrder { */ displayableOrderId: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentOrder */ @@ -734,7 +945,7 @@ export interface FulfillmentOrder { */ codSettings?: CODSettings; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentOrder */ @@ -746,7 +957,7 @@ export interface FulfillmentOrder { */ fulfillmentOrderStatus: FulfillmentOrderStatus | 'New' | 'Received' | 'Planning' | 'Processing' | 'Cancelled' | 'Complete' | 'CompletePartialled' | 'Unfulfillable' | 'Invalid'; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentOrder */ @@ -825,13 +1036,13 @@ export interface FulfillmentOrderItem { */ unfulfillableQuantity: number; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentOrderItem */ estimatedShipDate?: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentOrderItem */ @@ -938,7 +1149,7 @@ export interface FulfillmentPreview { */ unfulfillablePreviewItems?: Array; /** - * + * String list * @type {Array} * @memberof FulfillmentPreview */ @@ -1010,25 +1221,25 @@ export enum FulfillmentPreviewItemShippingWeightCalculationMethodEnum { */ export interface FulfillmentPreviewShipment { /** - * + * Date timestamp * @type {string} * @memberof FulfillmentPreviewShipment */ earliestShipDate?: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentPreviewShipment */ latestShipDate?: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentPreviewShipment */ earliestArrivalDate?: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentPreviewShipment */ @@ -1081,13 +1292,13 @@ export interface FulfillmentShipment { */ fulfillmentShipmentStatus: FulfillmentShipmentFulfillmentShipmentStatusEnum | 'PENDING' | 'SHIPPED' | 'CANCELLED_BY_FULFILLER' | 'CANCELLED_BY_SELLER'; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentShipment */ shippingDate?: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentShipment */ @@ -1159,6 +1370,12 @@ export interface FulfillmentShipmentItem { * @memberof FulfillmentShipmentItem */ serialNumber?: string; + /** + * String list + * @type {Array} + * @memberof FulfillmentShipmentItem + */ + manufacturerLotCodes?: Array; } /** * Package information for a shipment in a fulfillment order. @@ -1185,11 +1402,106 @@ export interface FulfillmentShipmentPackage { */ trackingNumber?: string; /** - * + * Date timestamp * @type {string} * @memberof FulfillmentShipmentPackage */ estimatedArrivalDate?: string; + /** + * + * @type {LockerDetails} + * @memberof FulfillmentShipmentPackage + */ + lockerDetails?: LockerDetails; +} +/** + * The product details for the delivery offer. + * @export + * @interface GetDeliveryOffersProduct + */ +export interface GetDeliveryOffersProduct { + /** + * + * @type {ProductIdentifier} + * @memberof GetDeliveryOffersProduct + */ + productIdentifier: ProductIdentifier; + /** + * + * @type {Amount} + * @memberof GetDeliveryOffersProduct + */ + amount?: Amount; +} +/** + * The request body schema for the getDeliveryOffers operation. + * @export + * @interface GetDeliveryOffersRequest + */ +export interface GetDeliveryOffersRequest { + /** + * + * @type {GetDeliveryOffersProduct} + * @memberof GetDeliveryOffersRequest + */ + product: GetDeliveryOffersProduct; + /** + * + * @type {GetDeliveryOffersTerms} + * @memberof GetDeliveryOffersRequest + */ + terms: GetDeliveryOffersTerms; +} +/** + * The response schema for the getDeliveryOffers operation. + * @export + * @interface GetDeliveryOffersResponse + */ +export interface GetDeliveryOffersResponse { + /** + * + * @type {GetDeliveryOffersResult} + * @memberof GetDeliveryOffersResponse + */ + payload?: GetDeliveryOffersResult; + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof GetDeliveryOffersResponse + */ + errors?: Array; +} +/** + * A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy. + * @export + * @interface GetDeliveryOffersResult + */ +export interface GetDeliveryOffersResult { + /** + * An array of delivery offer information. + * @type {Array} + * @memberof GetDeliveryOffersResult + */ + deliveryOffers?: Array; +} +/** + * The delivery terms for the delivery offer. + * @export + * @interface GetDeliveryOffersTerms + */ +export interface GetDeliveryOffersTerms { + /** + * + * @type {Origin} + * @memberof GetDeliveryOffersTerms + */ + origin: Origin; + /** + * + * @type {Destination} + * @memberof GetDeliveryOffersTerms + */ + destination: Destination; } /** * The breakdown of eligibility inventory by feature. @@ -1349,7 +1661,7 @@ export interface GetFulfillmentOrderResponse { errors?: Array; } /** - * + * The request for the getFulfillmentOrder operation. * @export * @interface GetFulfillmentOrderResult */ @@ -1447,7 +1759,7 @@ export interface GetFulfillmentPreviewRequest { */ items: Array; /** - * + * ShippingSpeedCategory List * @type {Array} * @memberof GetFulfillmentPreviewRequest */ @@ -1598,7 +1910,7 @@ export interface ListAllFulfillmentOrdersResponse { errors?: Array; } /** - * + * The request for the listAllFulfillmentOrders operation. * @export * @interface ListAllFulfillmentOrdersResult */ @@ -1636,7 +1948,7 @@ export interface ListReturnReasonCodesResponse { errors?: Array; } /** - * + * The request for the listReturnReasonCodes operation. * @export * @interface ListReturnReasonCodesResult */ @@ -1648,6 +1960,25 @@ export interface ListReturnReasonCodesResult { */ reasonCodeDetails?: Array; } +/** + * The locker details, if provided can be used to access locker delivery box. + * @export + * @interface LockerDetails + */ +export interface LockerDetails { + /** + * Indicates the locker number + * @type {string} + * @memberof LockerDetails + */ + lockerNumber?: string; + /** + * Indicates the locker access code + * @type {string} + * @memberof LockerDetails + */ + lockerAccessCode?: string; +} /** * Error response returned when the request is unsuccessful. * @export @@ -1693,7 +2024,20 @@ export interface Money { value: string; } /** - * + * The origin for the delivery offer. + * @export + * @interface Origin + */ +export interface Origin { + /** + * The two digit country code the items should ship from. In ISO 3166-1 alpha-2 format. + * @type {string} + * @memberof Origin + */ + countryCode: string; +} +/** + * Tracking details of package * @export * @interface PackageTrackingDetails */ @@ -1735,13 +2079,13 @@ export interface PackageTrackingDetails { */ carrierURL?: string; /** - * + * Date timestamp * @type {string} * @memberof PackageTrackingDetails */ shipDate?: string; /** - * + * Date timestamp * @type {string} * @memberof PackageTrackingDetails */ @@ -1802,12 +2146,25 @@ export interface PaymentInformation { */ paymentMode: string; /** - * + * Date timestamp * @type {string} * @memberof PaymentInformation */ paymentDate: string; } +/** + * Product identifier input that locates a product for MCF. + * @export + * @interface ProductIdentifier + */ +export interface ProductIdentifier { + /** + * The merchant SKU for the product. + * @type {string} + * @memberof ProductIdentifier + */ + merchantSku: string; +} /** * A return reason code, a description, and an optional description translation. * @export @@ -1919,7 +2276,7 @@ export interface ReturnItem { */ status: FulfillmentReturnItemStatus | 'New' | 'Processed'; /** - * + * Date timestamp * @type {string} * @memberof ReturnItem */ @@ -2045,7 +2402,7 @@ export interface TrackingAddress { */ export interface TrackingEvent { /** - * + * Date timestamp * @type {string} * @memberof TrackingEvent */ @@ -2094,7 +2451,7 @@ export interface UnfulfillablePreviewItem { */ sellerFulfillmentOrderItemId: string; /** - * + * String list * @type {Array} * @memberof UnfulfillablePreviewItem */ @@ -2186,7 +2543,7 @@ export interface UpdateFulfillmentOrderRequest { */ displayableOrderId?: string; /** - * + * Date timestamp * @type {string} * @memberof UpdateFulfillmentOrderRequest */ @@ -2259,6 +2616,61 @@ export interface UpdateFulfillmentOrderResponse { */ errors?: Array; } +/** + * A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone. + * @export + * @interface VariablePrecisionAddress + */ +export interface VariablePrecisionAddress { + /** + * The first line of the address. + * @type {string} + * @memberof VariablePrecisionAddress + */ + addressLine1?: string; + /** + * Additional address information, if required. + * @type {string} + * @memberof VariablePrecisionAddress + */ + addressLine2?: string; + /** + * Additional address information, if required. + * @type {string} + * @memberof VariablePrecisionAddress + */ + addressLine3?: string; + /** + * The city where the person, business, or institution is located. This property should not be used in Japan. + * @type {string} + * @memberof VariablePrecisionAddress + */ + city?: string; + /** + * The district or county where the person, business, or institution is located. + * @type {string} + * @memberof VariablePrecisionAddress + */ + districtOrCounty?: string; + /** + * The state or region where the person, business or institution is located. + * @type {string} + * @memberof VariablePrecisionAddress + */ + stateOrRegion?: string; + /** + * The postal code of the address. + * @type {string} + * @memberof VariablePrecisionAddress + */ + postalCode: string; + /** + * The two digit country code. In ISO 3166-1 alpha-2 format. + * @type {string} + * @memberof VariablePrecisionAddress + */ + countryCode: string; +} /** * The weight. * @export @@ -2332,7 +2744,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }, /** * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) - * @param {CreateFulfillmentOrderRequest} body + * @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2368,7 +2780,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu /** * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items. - * @param {CreateFulfillmentReturnRequest} body + * @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2392,6 +2804,41 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu + 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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deliveryOffers: async (body: GetDeliveryOffersRequest, options: any = {}): Promise => { + // verify required parameter 'body' is not null or undefined + assertParamExists('deliveryOffers', 'body', body) + const localVarPath = `/fba/outbound/2020-07-01/deliveryOffers`; + // 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); @@ -2409,10 +2856,11 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu * @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param {string} featureName The name of the feature for which to return a list of eligible inventory. * @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. + * @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFeatureInventory: async (marketplaceId: string, featureName: string, nextToken?: string, options: any = {}): Promise => { + getFeatureInventory: async (marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options: any = {}): Promise => { // verify required parameter 'marketplaceId' is not null or undefined assertParamExists('getFeatureInventory', 'marketplaceId', marketplaceId) // verify required parameter 'featureName' is not null or undefined @@ -2438,6 +2886,12 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu localVarQueryParameter['nextToken'] = nextToken; } + if (queryStartDate !== undefined) { + localVarQueryParameter['queryStartDate'] = (queryStartDate as any instanceof Date) ? + (queryStartDate as any).toISOString() : + queryStartDate; + } + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); @@ -2564,7 +3018,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu }, /** * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {GetFulfillmentPreviewRequest} body + * @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2728,7 +3182,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu /** * Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. - * @param {SubmitFulfillmentOrderStatusUpdateRequest} body + * @param {SubmitFulfillmentOrderStatusUpdateRequest} body The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2767,7 +3221,7 @@ export const FbaOutboundApiAxiosParamCreator = function (configuration?: Configu /** * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. - * @param {UpdateFulfillmentOrderRequest} body + * @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2825,7 +3279,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { }, /** * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) - * @param {CreateFulfillmentOrderRequest} body + * @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2836,7 +3290,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { /** * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items. - * @param {CreateFulfillmentReturnRequest} body + * @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2844,16 +3298,27 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.createFulfillmentReturn(sellerFulfillmentOrderId, body, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deliveryOffers(body: GetDeliveryOffersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deliveryOffers(body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param {string} featureName The name of the feature for which to return a list of eligible inventory. * @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. + * @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFeatureInventory(marketplaceId: string, featureName: string, nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFeatureInventory(marketplaceId, featureName, nextToken, options); + async getFeatureInventory(marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFeatureInventory(marketplaceId, featureName, nextToken, queryStartDate, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -2890,7 +3355,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { }, /** * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {GetFulfillmentPreviewRequest} body + * @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2935,7 +3400,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { /** * Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. - * @param {SubmitFulfillmentOrderStatusUpdateRequest} body + * @param {SubmitFulfillmentOrderStatusUpdateRequest} body The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2946,7 +3411,7 @@ export const FbaOutboundApiFp = function(configuration?: Configuration) { /** * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. - * @param {UpdateFulfillmentOrderRequest} body + * @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2975,7 +3440,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba }, /** * Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) - * @param {CreateFulfillmentOrderRequest} body + * @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2985,23 +3450,33 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba /** * Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items. - * @param {CreateFulfillmentReturnRequest} body + * @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFulfillmentReturn(sellerFulfillmentOrderId: string, body: CreateFulfillmentReturnRequest, options?: any): AxiosPromise { return localVarFp.createFulfillmentReturn(sellerFulfillmentOrderId, body, options).then((request) => request(axios, basePath)); }, + /** + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deliveryOffers(body: GetDeliveryOffersRequest, options?: any): AxiosPromise { + return localVarFp.deliveryOffers(body, options).then((request) => request(axios, basePath)); + }, /** * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param {string} featureName The name of the feature for which to return a list of eligible inventory. * @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. + * @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFeatureInventory(marketplaceId: string, featureName: string, nextToken?: string, options?: any): AxiosPromise { - return localVarFp.getFeatureInventory(marketplaceId, featureName, nextToken, options).then((request) => request(axios, basePath)); + getFeatureInventory(marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options?: any): AxiosPromise { + return localVarFp.getFeatureInventory(marketplaceId, featureName, nextToken, queryStartDate, options).then((request) => request(axios, basePath)); }, /** * Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). @@ -3034,7 +3509,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba }, /** * Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). - * @param {GetFulfillmentPreviewRequest} body + * @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3075,7 +3550,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba /** * Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. - * @param {SubmitFulfillmentOrderStatusUpdateRequest} body + * @param {SubmitFulfillmentOrderStatusUpdateRequest} body The identifier assigned to the item by the seller when the fulfillment order was created. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3085,7 +3560,7 @@ export const FbaOutboundApiFactory = function (configuration?: Configuration, ba /** * Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created. - * @param {UpdateFulfillmentOrderRequest} body + * @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3116,7 +3591,7 @@ export interface FbaOutboundApiCancelFulfillmentOrderRequest { */ export interface FbaOutboundApiCreateFulfillmentOrderRequest { /** - * + * CreateFulfillmentOrderRequest parameter * @type {CreateFulfillmentOrderRequest} * @memberof FbaOutboundApiCreateFulfillmentOrder */ @@ -3137,13 +3612,27 @@ export interface FbaOutboundApiCreateFulfillmentReturnRequest { readonly sellerFulfillmentOrderId: string /** - * + * CreateFulfillmentReturnRequest parameter * @type {CreateFulfillmentReturnRequest} * @memberof FbaOutboundApiCreateFulfillmentReturn */ readonly body: CreateFulfillmentReturnRequest } +/** + * Request parameters for deliveryOffers operation in FbaOutboundApi. + * @export + * @interface FbaOutboundApiDeliveryOffersRequest + */ +export interface FbaOutboundApiDeliveryOffersRequest { + /** + * GetDeliveryOffersRequest parameter + * @type {GetDeliveryOffersRequest} + * @memberof FbaOutboundApiDeliveryOffers + */ + readonly body: GetDeliveryOffersRequest +} + /** * Request parameters for getFeatureInventory operation in FbaOutboundApi. * @export @@ -3170,6 +3659,13 @@ export interface FbaOutboundApiGetFeatureInventoryRequest { * @memberof FbaOutboundApiGetFeatureInventory */ readonly nextToken?: string + + /** + * A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ + * @type {string} + * @memberof FbaOutboundApiGetFeatureInventory + */ + readonly queryStartDate?: string } /** @@ -3235,7 +3731,7 @@ export interface FbaOutboundApiGetFulfillmentOrderRequest { */ export interface FbaOutboundApiGetFulfillmentPreviewRequest { /** - * + * GetFulfillmentPreviewRequest parameter * @type {GetFulfillmentPreviewRequest} * @memberof FbaOutboundApiGetFulfillmentPreview */ @@ -3326,7 +3822,7 @@ export interface FbaOutboundApiSubmitFulfillmentOrderStatusUpdateRequest { readonly sellerFulfillmentOrderId: string /** - * + * The identifier assigned to the item by the seller when the fulfillment order was created. * @type {SubmitFulfillmentOrderStatusUpdateRequest} * @memberof FbaOutboundApiSubmitFulfillmentOrderStatusUpdate */ @@ -3347,7 +3843,7 @@ export interface FbaOutboundApiUpdateFulfillmentOrderRequest { readonly sellerFulfillmentOrderId: string /** - * + * UpdateFulfillmentOrderRequest parameter * @type {UpdateFulfillmentOrderRequest} * @memberof FbaOutboundApiUpdateFulfillmentOrder */ @@ -3394,6 +3890,17 @@ export class FbaOutboundApi extends BaseAPI { return FbaOutboundApiFp(this.configuration).createFulfillmentReturn(requestParameters.sellerFulfillmentOrderId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } + /** + * Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). + * @param {FbaOutboundApiDeliveryOffersRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FbaOutboundApi + */ + public deliveryOffers(requestParameters: FbaOutboundApiDeliveryOffersRequest, options?: any) { + return FbaOutboundApiFp(this.configuration).deliveryOffers(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + } + /** * Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).. * @param {FbaOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters. @@ -3402,7 +3909,7 @@ export class FbaOutboundApi extends BaseAPI { * @memberof FbaOutboundApi */ public getFeatureInventory(requestParameters: FbaOutboundApiGetFeatureInventoryRequest, options?: any) { - return FbaOutboundApiFp(this.configuration).getFeatureInventory(requestParameters.marketplaceId, requestParameters.featureName, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath)); + return FbaOutboundApiFp(this.configuration).getFeatureInventory(requestParameters.marketplaceId, requestParameters.featureName, requestParameters.nextToken, requestParameters.queryStartDate, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/api-models/index.ts b/src/api-models/index.ts index 37afab800..b48acb1d2 100644 --- a/src/api-models/index.ts +++ b/src/api-models/index.ts @@ -1,3 +1,38 @@ +export { + CarrierCodeType as AmazonWarehousingAndDistributionModelCarrierCodeType, + DimensionUnitOfMeasurement as AmazonWarehousingAndDistributionModelDimensionUnitOfMeasurement, + DistributionPackageType as AmazonWarehousingAndDistributionModelDistributionPackageType, + InboundShipmentStatus as AmazonWarehousingAndDistributionModelInboundShipmentStatus, + InventoryDetailsVisibility as AmazonWarehousingAndDistributionModelInventoryDetailsVisibility, + InventoryUnitOfMeasurement as AmazonWarehousingAndDistributionModelInventoryUnitOfMeasurement, + ShipmentSortableField as AmazonWarehousingAndDistributionModelShipmentSortableField, + SortOrder as AmazonWarehousingAndDistributionModelSortOrder, + VolumeUnitOfMeasurement as AmazonWarehousingAndDistributionModelVolumeUnitOfMeasurement, + WeightUnitOfMeasurement as AmazonWarehousingAndDistributionModelWeightUnitOfMeasurement, + Address as AmazonWarehousingAndDistributionModelAddress, + CarrierCode as AmazonWarehousingAndDistributionModelCarrierCode, + DistributionPackage as AmazonWarehousingAndDistributionModelDistributionPackage, + DistributionPackageContents as AmazonWarehousingAndDistributionModelDistributionPackageContents, + DistributionPackageQuantity as AmazonWarehousingAndDistributionModelDistributionPackageQuantity, + ErrorList as AmazonWarehousingAndDistributionModelErrorList, + InboundShipment as AmazonWarehousingAndDistributionModelInboundShipment, + InboundShipmentSummary as AmazonWarehousingAndDistributionModelInboundShipmentSummary, + InventoryDetails as AmazonWarehousingAndDistributionModelInventoryDetails, + InventoryListing as AmazonWarehousingAndDistributionModelInventoryListing, + InventoryQuantity as AmazonWarehousingAndDistributionModelInventoryQuantity, + InventorySummary as AmazonWarehousingAndDistributionModelInventorySummary, + MeasurementData as AmazonWarehousingAndDistributionModelMeasurementData, + ModelError as AmazonWarehousingAndDistributionModelModelError, + PackageDimensions as AmazonWarehousingAndDistributionModelPackageDimensions, + PackageVolume as AmazonWarehousingAndDistributionModelPackageVolume, + PackageWeight as AmazonWarehousingAndDistributionModelPackageWeight, + ProductAttribute as AmazonWarehousingAndDistributionModelProductAttribute, + ProductQuantity as AmazonWarehousingAndDistributionModelProductQuantity, + ShipmentListing as AmazonWarehousingAndDistributionModelShipmentListing, + AwdApiGetInboundShipmentRequest as AmazonWarehousingAndDistributionModelAwdApiGetInboundShipmentRequest, + AwdApiListInboundShipmentsRequest as AmazonWarehousingAndDistributionModelAwdApiListInboundShipmentsRequest, + AwdApiListInventoryRequest as AmazonWarehousingAndDistributionModelAwdApiListInventoryRequest, +} from './amazon-warehousing-and-distribution-model' export { AsinBadge as AplusContentApiModelAsinBadge, ColorType as AplusContentApiModelColorType, @@ -144,6 +179,7 @@ export { ErrorList as CatalogItemsApiModelV20220401ErrorList, Item as CatalogItemsApiModelV20220401Item, ItemBrowseClassification as CatalogItemsApiModelV20220401ItemBrowseClassification, + ItemBrowseClassificationsByMarketplace as CatalogItemsApiModelV20220401ItemBrowseClassificationsByMarketplace, ItemClassificationSalesRank as CatalogItemsApiModelV20220401ItemClassificationSalesRank, ItemContributor as CatalogItemsApiModelV20220401ItemContributor, ItemContributorRole as CatalogItemsApiModelV20220401ItemContributorRole, @@ -229,10 +265,16 @@ export { } from './fba-inbound-eligibility-api-model' export { ResearchingQuantityEntryNameEnum as FbaInventoryApiModelResearchingQuantityEntryNameEnum, + AddInventoryRequest as FbaInventoryApiModelAddInventoryRequest, + AddInventoryResponse as FbaInventoryApiModelAddInventoryResponse, + CreateInventoryItemRequest as FbaInventoryApiModelCreateInventoryItemRequest, + CreateInventoryItemResponse as FbaInventoryApiModelCreateInventoryItemResponse, + DeleteInventoryItemResponse as FbaInventoryApiModelDeleteInventoryItemResponse, GetInventorySummariesResponse as FbaInventoryApiModelGetInventorySummariesResponse, GetInventorySummariesResult as FbaInventoryApiModelGetInventorySummariesResult, Granularity as FbaInventoryApiModelGranularity, InventoryDetails as FbaInventoryApiModelInventoryDetails, + InventoryItem as FbaInventoryApiModelInventoryItem, InventorySummary as FbaInventoryApiModelInventorySummary, ModelError as FbaInventoryApiModelModelError, Pagination as FbaInventoryApiModelPagination, @@ -240,6 +282,9 @@ export { ResearchingQuantityEntry as FbaInventoryApiModelResearchingQuantityEntry, ReservedQuantity as FbaInventoryApiModelReservedQuantity, UnfulfillableQuantity as FbaInventoryApiModelUnfulfillableQuantity, + FbaInventoryApiAddInventoryRequest as FbaInventoryApiModelFbaInventoryApiAddInventoryRequest, + FbaInventoryApiCreateInventoryItemRequest as FbaInventoryApiModelFbaInventoryApiCreateInventoryItemRequest, + FbaInventoryApiDeleteInventoryItemRequest as FbaInventoryApiModelFbaInventoryApiDeleteInventoryItemRequest, FbaInventoryApiGetInventorySummariesRequest as FbaInventoryApiModelFbaInventoryApiGetInventorySummariesRequest, } from './fba-inventory-api-model' export { @@ -451,7 +496,9 @@ export { } from './fulfillment-inbound-api-model' export { BoxContentInformationSource as FulfillmentInboundApiModelV20240320BoxContentInformationSource, + ItemLabelPageType as FulfillmentInboundApiModelV20240320ItemLabelPageType, LabelOwner as FulfillmentInboundApiModelV20240320LabelOwner, + LabelPrintType as FulfillmentInboundApiModelV20240320LabelPrintType, OperationStatus as FulfillmentInboundApiModelV20240320OperationStatus, PrepOwner as FulfillmentInboundApiModelV20240320PrepOwner, ReasonComment as FulfillmentInboundApiModelV20240320ReasonComment, @@ -459,34 +506,46 @@ export { UnitOfMeasurement as FulfillmentInboundApiModelV20240320UnitOfMeasurement, UnitOfWeight as FulfillmentInboundApiModelV20240320UnitOfWeight, Address as FulfillmentInboundApiModelV20240320Address, + AddressInput as FulfillmentInboundApiModelV20240320AddressInput, AppointmentSlot as FulfillmentInboundApiModelV20240320AppointmentSlot, AppointmentSlotTime as FulfillmentInboundApiModelV20240320AppointmentSlotTime, Box as FulfillmentInboundApiModelV20240320Box, - BoxContent as FulfillmentInboundApiModelV20240320BoxContent, BoxInput as FulfillmentInboundApiModelV20240320BoxInput, + BoxUpdateInput as FulfillmentInboundApiModelV20240320BoxUpdateInput, CancelInboundPlanResponse as FulfillmentInboundApiModelV20240320CancelInboundPlanResponse, CancelSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320CancelSelfShipAppointmentRequest, CancelSelfShipAppointmentResponse as FulfillmentInboundApiModelV20240320CancelSelfShipAppointmentResponse, Carrier as FulfillmentInboundApiModelV20240320Carrier, + CarrierAppointment as FulfillmentInboundApiModelV20240320CarrierAppointment, ComplianceDetail as FulfillmentInboundApiModelV20240320ComplianceDetail, + ConfirmDeliveryWindowOptionsResponse as FulfillmentInboundApiModelV20240320ConfirmDeliveryWindowOptionsResponse, ConfirmPackingOptionResponse as FulfillmentInboundApiModelV20240320ConfirmPackingOptionResponse, ConfirmPlacementOptionResponse as FulfillmentInboundApiModelV20240320ConfirmPlacementOptionResponse, + ConfirmShipmentContentUpdatePreviewResponse as FulfillmentInboundApiModelV20240320ConfirmShipmentContentUpdatePreviewResponse, ConfirmTransportationOptionsRequest as FulfillmentInboundApiModelV20240320ConfirmTransportationOptionsRequest, ConfirmTransportationOptionsResponse as FulfillmentInboundApiModelV20240320ConfirmTransportationOptionsResponse, ContactInformation as FulfillmentInboundApiModelV20240320ContactInformation, + ContentUpdatePreview as FulfillmentInboundApiModelV20240320ContentUpdatePreview, CreateInboundPlanRequest as FulfillmentInboundApiModelV20240320CreateInboundPlanRequest, CreateInboundPlanResponse as FulfillmentInboundApiModelV20240320CreateInboundPlanResponse, + CreateMarketplaceItemLabelsRequest as FulfillmentInboundApiModelV20240320CreateMarketplaceItemLabelsRequest, + CreateMarketplaceItemLabelsResponse as FulfillmentInboundApiModelV20240320CreateMarketplaceItemLabelsResponse, Currency as FulfillmentInboundApiModelV20240320Currency, CustomPlacementInput as FulfillmentInboundApiModelV20240320CustomPlacementInput, Dates as FulfillmentInboundApiModelV20240320Dates, + DeliveryWindowOption as FulfillmentInboundApiModelV20240320DeliveryWindowOption, Dimensions as FulfillmentInboundApiModelV20240320Dimensions, DocumentDownload as FulfillmentInboundApiModelV20240320DocumentDownload, ErrorList as FulfillmentInboundApiModelV20240320ErrorList, + FreightInformation as FulfillmentInboundApiModelV20240320FreightInformation, + GenerateDeliveryWindowOptionsResponse as FulfillmentInboundApiModelV20240320GenerateDeliveryWindowOptionsResponse, GeneratePackingOptionsResponse as FulfillmentInboundApiModelV20240320GeneratePackingOptionsResponse, GeneratePlacementOptionsRequest as FulfillmentInboundApiModelV20240320GeneratePlacementOptionsRequest, GeneratePlacementOptionsResponse as FulfillmentInboundApiModelV20240320GeneratePlacementOptionsResponse, GenerateSelfShipAppointmentSlotsRequest as FulfillmentInboundApiModelV20240320GenerateSelfShipAppointmentSlotsRequest, GenerateSelfShipAppointmentSlotsResponse as FulfillmentInboundApiModelV20240320GenerateSelfShipAppointmentSlotsResponse, + GenerateShipmentContentUpdatePreviewsRequest as FulfillmentInboundApiModelV20240320GenerateShipmentContentUpdatePreviewsRequest, + GenerateShipmentContentUpdatePreviewsResponse as FulfillmentInboundApiModelV20240320GenerateShipmentContentUpdatePreviewsResponse, GenerateTransportationOptionsRequest as FulfillmentInboundApiModelV20240320GenerateTransportationOptionsRequest, GenerateTransportationOptionsResponse as FulfillmentInboundApiModelV20240320GenerateTransportationOptionsResponse, GetDeliveryChallanDocumentResponse as FulfillmentInboundApiModelV20240320GetDeliveryChallanDocumentResponse, @@ -497,33 +556,41 @@ export { Incentive as FulfillmentInboundApiModelV20240320Incentive, Item as FulfillmentInboundApiModelV20240320Item, ItemInput as FulfillmentInboundApiModelV20240320ItemInput, + ListDeliveryWindowOptionsResponse as FulfillmentInboundApiModelV20240320ListDeliveryWindowOptionsResponse, ListInboundPlanBoxesResponse as FulfillmentInboundApiModelV20240320ListInboundPlanBoxesResponse, ListInboundPlanItemsResponse as FulfillmentInboundApiModelV20240320ListInboundPlanItemsResponse, ListInboundPlanPalletsResponse as FulfillmentInboundApiModelV20240320ListInboundPlanPalletsResponse, ListInboundPlansResponse as FulfillmentInboundApiModelV20240320ListInboundPlansResponse, ListItemComplianceDetailsResponse as FulfillmentInboundApiModelV20240320ListItemComplianceDetailsResponse, + ListPackingGroupBoxesResponse as FulfillmentInboundApiModelV20240320ListPackingGroupBoxesResponse, ListPackingGroupItemsResponse as FulfillmentInboundApiModelV20240320ListPackingGroupItemsResponse, ListPackingOptionsResponse as FulfillmentInboundApiModelV20240320ListPackingOptionsResponse, ListPlacementOptionsResponse as FulfillmentInboundApiModelV20240320ListPlacementOptionsResponse, + ListShipmentBoxesResponse as FulfillmentInboundApiModelV20240320ListShipmentBoxesResponse, + ListShipmentContentUpdatePreviewsResponse as FulfillmentInboundApiModelV20240320ListShipmentContentUpdatePreviewsResponse, + ListShipmentItemsResponse as FulfillmentInboundApiModelV20240320ListShipmentItemsResponse, + ListShipmentPalletsResponse as FulfillmentInboundApiModelV20240320ListShipmentPalletsResponse, ListTransportationOptionsResponse as FulfillmentInboundApiModelV20240320ListTransportationOptionsResponse, LtlTrackingDetail as FulfillmentInboundApiModelV20240320LtlTrackingDetail, LtlTrackingDetailInput as FulfillmentInboundApiModelV20240320LtlTrackingDetailInput, ModelError as FulfillmentInboundApiModelV20240320ModelError, + MskuQuantity as FulfillmentInboundApiModelV20240320MskuQuantity, OperationProblem as FulfillmentInboundApiModelV20240320OperationProblem, PackageGroupingInput as FulfillmentInboundApiModelV20240320PackageGroupingInput, PackingOption as FulfillmentInboundApiModelV20240320PackingOption, PackingOptionSummary as FulfillmentInboundApiModelV20240320PackingOptionSummary, Pagination as FulfillmentInboundApiModelV20240320Pagination, Pallet as FulfillmentInboundApiModelV20240320Pallet, - PalletInformation as FulfillmentInboundApiModelV20240320PalletInformation, PalletInput as FulfillmentInboundApiModelV20240320PalletInput, PlacementOption as FulfillmentInboundApiModelV20240320PlacementOption, PlacementOptionSummary as FulfillmentInboundApiModelV20240320PlacementOptionSummary, PrepInstruction as FulfillmentInboundApiModelV20240320PrepInstruction, Quote as FulfillmentInboundApiModelV20240320Quote, Region as FulfillmentInboundApiModelV20240320Region, + RequestedUpdates as FulfillmentInboundApiModelV20240320RequestedUpdates, ScheduleSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320ScheduleSelfShipAppointmentRequest, ScheduleSelfShipAppointmentResponse as FulfillmentInboundApiModelV20240320ScheduleSelfShipAppointmentResponse, + SelectedDeliveryWindow as FulfillmentInboundApiModelV20240320SelectedDeliveryWindow, SelfShipAppointmentDetails as FulfillmentInboundApiModelV20240320SelfShipAppointmentDetails, SelfShipAppointmentSlotsAvailability as FulfillmentInboundApiModelV20240320SelfShipAppointmentSlotsAvailability, SetPackingInformationRequest as FulfillmentInboundApiModelV20240320SetPackingInformationRequest, @@ -544,10 +611,12 @@ export { TrackingDetailsInput as FulfillmentInboundApiModelV20240320TrackingDetailsInput, TransportationOption as FulfillmentInboundApiModelV20240320TransportationOption, TransportationSelection as FulfillmentInboundApiModelV20240320TransportationSelection, + UpdateInboundPlanNameRequest as FulfillmentInboundApiModelV20240320UpdateInboundPlanNameRequest, UpdateItemComplianceDetailsRequest as FulfillmentInboundApiModelV20240320UpdateItemComplianceDetailsRequest, UpdateItemComplianceDetailsResponse as FulfillmentInboundApiModelV20240320UpdateItemComplianceDetailsResponse, - UpdateShipmentDeliveryWindowRequest as FulfillmentInboundApiModelV20240320UpdateShipmentDeliveryWindowRequest, - UpdateShipmentDeliveryWindowResponse as FulfillmentInboundApiModelV20240320UpdateShipmentDeliveryWindowResponse, + UpdateShipmentNameRequest as FulfillmentInboundApiModelV20240320UpdateShipmentNameRequest, + UpdateShipmentSourceAddressRequest as FulfillmentInboundApiModelV20240320UpdateShipmentSourceAddressRequest, + UpdateShipmentSourceAddressResponse as FulfillmentInboundApiModelV20240320UpdateShipmentSourceAddressResponse, UpdateShipmentTrackingDetailsRequest as FulfillmentInboundApiModelV20240320UpdateShipmentTrackingDetailsRequest, UpdateShipmentTrackingDetailsResponse as FulfillmentInboundApiModelV20240320UpdateShipmentTrackingDetailsResponse, Weight as FulfillmentInboundApiModelV20240320Weight, @@ -555,37 +624,54 @@ export { 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, + FbaInboundApiListShipmentBoxesRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentBoxesRequest, + FbaInboundApiListShipmentContentUpdatePreviewsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentContentUpdatePreviewsRequest, + FbaInboundApiListShipmentItemsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentItemsRequest, + FbaInboundApiListShipmentPalletsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListShipmentPalletsRequest, FbaInboundApiListTransportationOptionsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiListTransportationOptionsRequest, FbaInboundApiScheduleSelfShipAppointmentRequest as FulfillmentInboundApiModelV20240320FbaInboundApiScheduleSelfShipAppointmentRequest, FbaInboundApiSetPackingInformationRequest as FulfillmentInboundApiModelV20240320FbaInboundApiSetPackingInformationRequest, + FbaInboundApiUpdateInboundPlanNameRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateInboundPlanNameRequest, FbaInboundApiUpdateItemComplianceDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateItemComplianceDetailsRequest, - FbaInboundApiUpdateShipmentDeliveryWindowRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentDeliveryWindowRequest, + FbaInboundApiUpdateShipmentNameRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentNameRequest, + FbaInboundApiUpdateShipmentSourceAddressRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentSourceAddressRequest, FbaInboundApiUpdateShipmentTrackingDetailsRequest as FulfillmentInboundApiModelV20240320FbaInboundApiUpdateShipmentTrackingDetailsRequest, } from './fulfillment-inbound-api-model-v20240320' export { AdditionalLocationInfo as FulfillmentOutboundApiModelAdditionalLocationInfo, + AmountUnitOfMeasureEnum as FulfillmentOutboundApiModelAmountUnitOfMeasureEnum, CurrentStatus as FulfillmentOutboundApiModelCurrentStatus, + DeliveryQuantityUnitOfMeasureEnum as FulfillmentOutboundApiModelDeliveryQuantityUnitOfMeasureEnum, + DropOffLocationTypeEnum as FulfillmentOutboundApiModelDropOffLocationTypeEnum, EventCode as FulfillmentOutboundApiModelEventCode, FeatureSettingsFeatureFulfillmentPolicyEnum as FulfillmentOutboundApiModelFeatureSettingsFeatureFulfillmentPolicyEnum, FeeNameEnum as FulfillmentOutboundApiModelFeeNameEnum, @@ -600,6 +686,7 @@ export { ShippingSpeedCategory as FulfillmentOutboundApiModelShippingSpeedCategory, WeightUnitEnum as FulfillmentOutboundApiModelWeightUnitEnum, Address as FulfillmentOutboundApiModelAddress, + Amount as FulfillmentOutboundApiModelAmount, CODSettings as FulfillmentOutboundApiModelCODSettings, CancelFulfillmentOrderResponse as FulfillmentOutboundApiModelCancelFulfillmentOrderResponse, CreateFulfillmentOrderItem as FulfillmentOutboundApiModelCreateFulfillmentOrderItem, @@ -609,7 +696,15 @@ export { CreateFulfillmentReturnResponse as FulfillmentOutboundApiModelCreateFulfillmentReturnResponse, CreateFulfillmentReturnResult as FulfillmentOutboundApiModelCreateFulfillmentReturnResult, CreateReturnItem as FulfillmentOutboundApiModelCreateReturnItem, + DateRange as FulfillmentOutboundApiModelDateRange, + DeliveryMessage as FulfillmentOutboundApiModelDeliveryMessage, + DeliveryOffer as FulfillmentOutboundApiModelDeliveryOffer, + DeliveryPolicy as FulfillmentOutboundApiModelDeliveryPolicy, + DeliveryPreferences as FulfillmentOutboundApiModelDeliveryPreferences, + DeliveryQuantity as FulfillmentOutboundApiModelDeliveryQuantity, DeliveryWindow as FulfillmentOutboundApiModelDeliveryWindow, + Destination as FulfillmentOutboundApiModelDestination, + DropOffLocation as FulfillmentOutboundApiModelDropOffLocation, Feature as FulfillmentOutboundApiModelFeature, FeatureSettings as FulfillmentOutboundApiModelFeatureSettings, FeatureSku as FulfillmentOutboundApiModelFeatureSku, @@ -622,6 +717,11 @@ export { FulfillmentShipment as FulfillmentOutboundApiModelFulfillmentShipment, FulfillmentShipmentItem as FulfillmentOutboundApiModelFulfillmentShipmentItem, FulfillmentShipmentPackage as FulfillmentOutboundApiModelFulfillmentShipmentPackage, + GetDeliveryOffersProduct as FulfillmentOutboundApiModelGetDeliveryOffersProduct, + GetDeliveryOffersRequest as FulfillmentOutboundApiModelGetDeliveryOffersRequest, + GetDeliveryOffersResponse as FulfillmentOutboundApiModelGetDeliveryOffersResponse, + GetDeliveryOffersResult as FulfillmentOutboundApiModelGetDeliveryOffersResult, + GetDeliveryOffersTerms as FulfillmentOutboundApiModelGetDeliveryOffersTerms, GetFeatureInventoryResponse as FulfillmentOutboundApiModelGetFeatureInventoryResponse, GetFeatureInventoryResult as FulfillmentOutboundApiModelGetFeatureInventoryResult, GetFeatureSkuResponse as FulfillmentOutboundApiModelGetFeatureSkuResponse, @@ -641,10 +741,13 @@ export { ListAllFulfillmentOrdersResult as FulfillmentOutboundApiModelListAllFulfillmentOrdersResult, ListReturnReasonCodesResponse as FulfillmentOutboundApiModelListReturnReasonCodesResponse, ListReturnReasonCodesResult as FulfillmentOutboundApiModelListReturnReasonCodesResult, + LockerDetails as FulfillmentOutboundApiModelLockerDetails, ModelError as FulfillmentOutboundApiModelModelError, Money as FulfillmentOutboundApiModelMoney, + Origin as FulfillmentOutboundApiModelOrigin, PackageTrackingDetails as FulfillmentOutboundApiModelPackageTrackingDetails, PaymentInformation as FulfillmentOutboundApiModelPaymentInformation, + ProductIdentifier as FulfillmentOutboundApiModelProductIdentifier, ReasonCodeDetails as FulfillmentOutboundApiModelReasonCodeDetails, ReturnAuthorization as FulfillmentOutboundApiModelReturnAuthorization, ReturnItem as FulfillmentOutboundApiModelReturnItem, @@ -657,10 +760,12 @@ export { UpdateFulfillmentOrderItem as FulfillmentOutboundApiModelUpdateFulfillmentOrderItem, UpdateFulfillmentOrderRequest as FulfillmentOutboundApiModelUpdateFulfillmentOrderRequest, UpdateFulfillmentOrderResponse as FulfillmentOutboundApiModelUpdateFulfillmentOrderResponse, + VariablePrecisionAddress as FulfillmentOutboundApiModelVariablePrecisionAddress, Weight as FulfillmentOutboundApiModelWeight, FbaOutboundApiCancelFulfillmentOrderRequest as FulfillmentOutboundApiModelFbaOutboundApiCancelFulfillmentOrderRequest, FbaOutboundApiCreateFulfillmentOrderRequest as FulfillmentOutboundApiModelFbaOutboundApiCreateFulfillmentOrderRequest, FbaOutboundApiCreateFulfillmentReturnRequest as FulfillmentOutboundApiModelFbaOutboundApiCreateFulfillmentReturnRequest, + FbaOutboundApiDeliveryOffersRequest as FulfillmentOutboundApiModelFbaOutboundApiDeliveryOffersRequest, FbaOutboundApiGetFeatureInventoryRequest as FulfillmentOutboundApiModelFbaOutboundApiGetFeatureInventoryRequest, FbaOutboundApiGetFeatureSKURequest as FulfillmentOutboundApiModelFbaOutboundApiGetFeatureSKURequest, FbaOutboundApiGetFeaturesRequest as FulfillmentOutboundApiModelFbaOutboundApiGetFeaturesRequest, @@ -1069,6 +1174,10 @@ export { FeaturedOfferSegmentCustomerMembershipEnum as ProductPricingApiModelV20220501FeaturedOfferSegmentCustomerMembershipEnum, FulfillmentType as ProductPricingApiModelV20220501FulfillmentType, HttpMethod as ProductPricingApiModelV20220501HttpMethod, + LowestPricedOffersInputOfferTypeEnum as ProductPricingApiModelV20220501LowestPricedOffersInputOfferTypeEnum, + OfferSubConditionEnum as ProductPricingApiModelV20220501OfferSubConditionEnum, + PrimeDetailsEligibilityEnum as ProductPricingApiModelV20220501PrimeDetailsEligibilityEnum, + SegmentedFeaturedOfferSubConditionEnum as ProductPricingApiModelV20220501SegmentedFeaturedOfferSubConditionEnum, ShippingOptionShippingOptionTypeEnum as ProductPricingApiModelV20220501ShippingOptionShippingOptionTypeEnum, BatchRequest as ProductPricingApiModelV20220501BatchRequest, BatchResponse as ProductPricingApiModelV20220501BatchResponse, @@ -1091,12 +1200,16 @@ export { GetFeaturedOfferExpectedPriceBatchRequest as ProductPricingApiModelV20220501GetFeaturedOfferExpectedPriceBatchRequest, GetFeaturedOfferExpectedPriceBatchResponse as ProductPricingApiModelV20220501GetFeaturedOfferExpectedPriceBatchResponse, HttpStatusLine as ProductPricingApiModelV20220501HttpStatusLine, + LowestPricedOffer as ProductPricingApiModelV20220501LowestPricedOffer, + LowestPricedOffersInput as ProductPricingApiModelV20220501LowestPricedOffersInput, ModelError as ProductPricingApiModelV20220501ModelError, MoneyType as ProductPricingApiModelV20220501MoneyType, Offer as ProductPricingApiModelV20220501Offer, OfferIdentifier as ProductPricingApiModelV20220501OfferIdentifier, Points as ProductPricingApiModelV20220501Points, Price as ProductPricingApiModelV20220501Price, + PrimeDetails as ProductPricingApiModelV20220501PrimeDetails, + ReferencePrice as ProductPricingApiModelV20220501ReferencePrice, SegmentDetails as ProductPricingApiModelV20220501SegmentDetails, SegmentedFeaturedOffer as ProductPricingApiModelV20220501SegmentedFeaturedOffer, SegmentedFeaturedOfferAllOf as ProductPricingApiModelV20220501SegmentedFeaturedOfferAllOf, 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 a8c1143e8..8c7de78b7 100644 --- a/src/api-models/product-pricing-api-model-v20220501/api.ts +++ b/src/api-models/product-pricing-api-model-v20220501/api.ts @@ -103,7 +103,9 @@ export interface CompetitiveSummaryBatchResponse { * @enum {string} */ export enum CompetitiveSummaryIncludedData { - FeaturedBuyingOptions = 'featuredBuyingOptions' + FeaturedBuyingOptions = 'featuredBuyingOptions', + ReferencePrices = 'referencePrices', + LowestPricedOffers = 'lowestPricedOffers' } /** @@ -129,7 +131,13 @@ export interface CompetitiveSummaryRequest { * @type {Array} * @memberof CompetitiveSummaryRequest */ - includedData: Array<(CompetitiveSummaryIncludedData | 'featuredBuyingOptions')>; + 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`. + * @type {Array} + * @memberof CompetitiveSummaryRequest + */ + lowestPricedOffersInputs?: Array; /** * * @type {HttpMethod} @@ -187,11 +195,23 @@ export interface CompetitiveSummaryResponseBody { */ featuredBuyingOptions?: Array; /** - * - * @type {Errors} + * A list of the lowest priced offers for the given ASIN `marketplaceId` combination. + * @type {Array} + * @memberof CompetitiveSummaryResponseBody + */ + lowestPricedOffers?: Array; + /** + * A list of reference prices for the given ASIN `marketplaceId` combination. + * @type {Array} * @memberof CompetitiveSummaryResponseBody */ - errors?: Errors; + referencePrices?: Array; + /** + * A list of error responses returned when a request is unsuccessful. + * @type {Array} + * @memberof CompetitiveSummaryResponseBody + */ + errors?: Array; } /** * The condition of the item. @@ -248,7 +268,7 @@ export enum FeaturedBuyingOptionBuyingOptionTypeEnum { } /** - * + * Schema for `currentFeaturedOffer` or `competingFeaturedOffer`. * @export * @interface FeaturedOffer */ @@ -354,7 +374,7 @@ export interface FeaturedOfferExpectedPriceRequestParams { sku: string; } /** - * + * Schema for an individual featured offer expected price response. * @export * @interface FeaturedOfferExpectedPriceResponse */ @@ -556,6 +576,53 @@ export interface HttpStatusLine { */ reasonPhrase?: string; } +/** + * The lowest priced offer for the requested item condition and offer type. + * @export + * @interface LowestPricedOffer + */ +export interface LowestPricedOffer { + /** + * + * @type {LowestPricedOffersInput} + * @memberof LowestPricedOffer + */ + lowestPricedOffersInput: LowestPricedOffersInput; + /** + * A list of up to 20 lowest priced offers that match the criteria specified in the `lowestPricedOffersInput` parameter. + * @type {Array} + * @memberof LowestPricedOffer + */ + offers: Array; +} +/** + * The input required for building the `LowestPricedOffers` data in the response. + * @export + * @interface LowestPricedOffersInput + */ +export interface LowestPricedOffersInput { + /** + * + * @type {Condition} + * @memberof 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`. + * @type {string} + * @memberof LowestPricedOffersInput + */ + offerType: LowestPricedOffersInputOfferTypeEnum | 'CONSUMER'; +} + +/** + * @export + * @enum {string} + */ +export enum LowestPricedOffersInputOfferTypeEnum { + Consumer = 'CONSUMER' +} + /** * Error response returned when the request is unsuccessful. * @export @@ -582,7 +649,7 @@ export interface ModelError { details?: string; } /** - * + * Currency type and monetary value. Schema for demonstrating pricing info. * @export * @interface MoneyType */ @@ -618,6 +685,12 @@ export interface Offer { * @memberof Offer */ condition: Condition | 'New' | 'Used' | 'Collectible' | 'Refurbished' | 'Club'; + /** + * The item subcondition for the offer. + * @type {string} + * @memberof Offer + */ + subCondition?: OfferSubConditionEnum | 'New' | 'Mint' | 'VeryGood' | 'Good' | 'Acceptable' | 'Poor' | 'Club' | 'OEM' | 'Warranty' | 'RefurbishedWarranty' | 'Refurbished' | 'OpenBox' | 'Other'; /** * * @type {FulfillmentType} @@ -642,7 +715,34 @@ export interface Offer { * @memberof Offer */ points?: Points; + /** + * + * @type {PrimeDetails} + * @memberof Offer + */ + primeDetails?: PrimeDetails; +} + +/** + * @export + * @enum {string} + */ +export enum OfferSubConditionEnum { + New = 'New', + Mint = 'Mint', + VeryGood = 'VeryGood', + Good = 'Good', + Acceptable = 'Acceptable', + Poor = 'Poor', + Club = 'Club', + Oem = 'OEM', + Warranty = 'Warranty', + RefurbishedWarranty = 'RefurbishedWarranty', + Refurbished = 'Refurbished', + OpenBox = 'OpenBox', + Other = 'Other' } + /** * Identifies an offer from a particular seller on an ASIN. * @export @@ -681,7 +781,7 @@ export interface OfferIdentifier { fulfillmentType?: FulfillmentType | 'AFN' | 'MFN'; } /** - * + * The number of Amazon Points offered with the purchase of an item, and their monetary value. * @export * @interface Points */ @@ -700,7 +800,7 @@ export interface Points { pointsMonetaryValue?: MoneyType; } /** - * + * Schema for item\'s price information, including listing price, shipping price, and Amazon points. * @export * @interface Price */ @@ -724,6 +824,49 @@ export interface Price { */ points?: Points; } +/** + * Amazon Prime details. + * @export + * @interface PrimeDetails + */ +export interface PrimeDetails { + /** + * Indicates whether the offer is an Amazon Prime offer. + * @type {string} + * @memberof PrimeDetails + */ + eligibility: PrimeDetailsEligibilityEnum | 'NATIONAL' | 'REGIONAL' | 'NONE'; +} + +/** + * @export + * @enum {string} + */ +export enum PrimeDetailsEligibilityEnum { + National = 'NATIONAL', + Regional = 'REGIONAL', + None = 'NONE' +} + +/** + * The reference price for the given ASIN `marketplaceId` combination. + * @export + * @interface ReferencePrice + */ +export interface ReferencePrice { + /** + * The name of the reference price like `CompetitivePriceThreshold`. + * @type {string} + * @memberof ReferencePrice + */ + name: string; + /** + * + * @type {MoneyType} + * @memberof ReferencePrice + */ + price: MoneyType; +} /** * The details about the segment. * @export @@ -755,6 +898,12 @@ export interface SegmentedFeaturedOffer { * @memberof SegmentedFeaturedOffer */ condition: Condition | 'New' | 'Used' | 'Collectible' | 'Refurbished' | 'Club'; + /** + * The item subcondition for the offer. + * @type {string} + * @memberof SegmentedFeaturedOffer + */ + subCondition?: SegmentedFeaturedOfferSubConditionEnum | 'New' | 'Mint' | 'VeryGood' | 'Good' | 'Acceptable' | 'Poor' | 'Club' | 'OEM' | 'Warranty' | 'RefurbishedWarranty' | 'Refurbished' | 'OpenBox' | 'Other'; /** * * @type {FulfillmentType} @@ -779,6 +928,12 @@ export interface SegmentedFeaturedOffer { * @memberof SegmentedFeaturedOffer */ points?: Points; + /** + * + * @type {PrimeDetails} + * @memberof SegmentedFeaturedOffer + */ + primeDetails?: PrimeDetails; /** * The list of segment information in which the offer is featured. * @type {Array} @@ -786,6 +941,27 @@ export interface SegmentedFeaturedOffer { */ featuredOfferSegments: Array; } + +/** + * @export + * @enum {string} + */ +export enum SegmentedFeaturedOfferSubConditionEnum { + New = 'New', + Mint = 'Mint', + VeryGood = 'VeryGood', + Good = 'Good', + Acceptable = 'Acceptable', + Poor = 'Poor', + Club = 'Club', + Oem = 'OEM', + Warranty = 'Warranty', + RefurbishedWarranty = 'RefurbishedWarranty', + Refurbished = 'Refurbished', + OpenBox = 'OpenBox', + Other = 'Other' +} + /** * The list of segment information in which the offer is featured. * @export @@ -871,7 +1047,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). - * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody + * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -926,7 +1102,7 @@ export const ProductPricingApiFp = function(configuration?: 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). - * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody + * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -955,7 +1131,7 @@ export const ProductPricingApiFactory = function (configuration?: 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). - * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody + * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -986,7 +1162,7 @@ export interface ProductPricingApiGetCompetitiveSummaryRequest { */ export interface ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest { /** - * + * The batch of `getFeaturedOfferExpectedPrice` requests. * @type {GetFeaturedOfferExpectedPriceBatchRequest} * @memberof ProductPricingApiGetFeaturedOfferExpectedPriceBatch */ diff --git a/src/api-models/replenishment-api-model/api.ts b/src/api-models/replenishment-api-model/api.ts index f5acedbe0..a869a15e2 100644 --- a/src/api-models/replenishment-api-model/api.ts +++ b/src/api-models/replenishment-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 time period used to group data in the response. Note that this is only valid for the performance time period type. + * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type. * @export * @enum {string} */ @@ -85,7 +85,7 @@ export enum EnrollmentMethod { */ export interface ErrorList { /** - * + * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof ErrorList */ @@ -114,7 +114,7 @@ export interface GetSellingPartnerMetricsRequest { * @type {Array} * @memberof GetSellingPartnerMetricsRequest */ - metrics?: Array<(Metric | 'SHIPPED_SUBSCRIPTION_UNITS' | 'TOTAL_SUBSCRIPTIONS_REVENUE' | 'ACTIVE_SUBSCRIPTIONS' | 'NOT_DELIVERED_DUE_TO_OOS' | 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE')>; + metrics?: Array<(Metric | 'SHIPPED_SUBSCRIPTION_UNITS' | 'TOTAL_SUBSCRIPTIONS_REVENUE' | 'ACTIVE_SUBSCRIPTIONS' | 'NOT_DELIVERED_DUE_TO_OOS' | 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE' | 'LOST_REVENUE_DUE_TO_OOS' | 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS' | 'COUPONS_REVENUE_PENETRATION')>; /** * * @type {TimePeriodType} @@ -154,41 +154,65 @@ export interface GetSellingPartnerMetricsResponse { */ export interface GetSellingPartnerMetricsResponseMetric { /** - * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the PERFORMANCE timePeriodType. + * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof GetSellingPartnerMetricsResponseMetric */ notDeliveredDueToOOS?: number; /** - * The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType. + * The revenue generated from subscriptions over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`. * @type {number} * @memberof GetSellingPartnerMetricsResponseMetric */ totalSubscriptionsRevenue?: number; /** - * The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType. + * The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`. * @type {number} * @memberof GetSellingPartnerMetricsResponseMetric */ shippedSubscriptionUnits?: number; /** - * The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType. + * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof GetSellingPartnerMetricsResponseMetric */ activeSubscriptions?: number; /** - * The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the PERFORMANCE timePeriodType. + * The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof GetSellingPartnerMetricsResponseMetric */ subscriberAverageRevenue?: number; /** - * The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the PERFORMANCE timePeriodType. + * The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof GetSellingPartnerMetricsResponseMetric */ nonSubscriberAverageRevenue?: number; + /** + * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType. + * @type {number} + * @memberof GetSellingPartnerMetricsResponseMetric + */ + lostRevenueDueToOOS?: number; + /** + * The average reorders per subscriber of the program over a period of 12 months. Applicable only for the PERFORMANCE timePeriodType. + * @type {number} + * @memberof GetSellingPartnerMetricsResponseMetric + */ + subscriberAverageReorders?: number; + /** + * The average reorders per non-subscriber of the program over a period of past 12 months. Applicable only for the PERFORMANCE timePeriodType. + * @type {number} + * @memberof GetSellingPartnerMetricsResponseMetric + */ + nonSubscriberAverageReorders?: number; + /** + * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType. + * @type {number} + * @memberof GetSellingPartnerMetricsResponseMetric + */ + couponsRevenuePenetration?: number; /** * * @type {TimeInterval} @@ -340,67 +364,79 @@ export interface ListOfferMetricsResponseOffer { */ asin?: string; /** - * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the PERFORMANCE timePeriodType. + * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ notDeliveredDueToOOS?: number; /** - * The revenue generated from subscriptions over a period of time. Applicable only for the PERFORMANCE timePeriodType. + * The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ totalSubscriptionsRevenue?: number; /** - * The number of units shipped to the subscribers over a period of time. Applicable only for the PERFORMANCE timePeriodType. + * The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ shippedSubscriptionUnits?: number; /** - * The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType. + * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ activeSubscriptions?: number; /** - * The percentage of total program revenue out of total product revenue. Applicable only for the PERFORMANCE timePeriodType. + * The percentage of total program revenue out of total product revenue. Applicable only for the `PERFORMANCE` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ revenuePenetration?: number; /** - * The forecasted total subscription revenue for the next 30 days. Applicable only for the FORECAST timePeriodType. + * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType. + * @type {number} + * @memberof ListOfferMetricsResponseOffer + */ + lostRevenueDueToOOS?: number; + /** + * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType. + * @type {number} + * @memberof ListOfferMetricsResponseOffer + */ + couponsRevenuePenetration?: number; + /** + * The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ next30DayTotalSubscriptionsRevenue?: number; /** - * The forecasted total subscription revenue for the next 60 days. Applicable only for the FORECAST timePeriodType. + * The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ next60DayTotalSubscriptionsRevenue?: number; /** - * The forecasted total subscription revenue for the next 90 days. Applicable only for the FORECAST timePeriodType. + * The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ next90DayTotalSubscriptionsRevenue?: number; /** - * The forecasted shipped subscription units for the next 30 days. Applicable only for the FORECAST timePeriodType. + * The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ next30DayShippedSubscriptionUnits?: number; /** - * The forecasted shipped subscription units for the next 60 days. Applicable only for the FORECAST timePeriodType. + * The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ next60DayShippedSubscriptionUnits?: number; /** - * The forecasted shipped subscription units for the next 90 days. Applicable only for the FORECAST timePeriodType. + * The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`. * @type {number} * @memberof ListOfferMetricsResponseOffer */ @@ -638,7 +674,10 @@ export enum Metric { TotalSubscriptionsRevenue = 'TOTAL_SUBSCRIPTIONS_REVENUE', ActiveSubscriptions = 'ACTIVE_SUBSCRIPTIONS', NotDeliveredDueToOos = 'NOT_DELIVERED_DUE_TO_OOS', - SubscriberNonSubscriberAverageRevenue = 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE' + SubscriberNonSubscriberAverageRevenue = 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE', + LostRevenueDueToOos = 'LOST_REVENUE_DUE_TO_OOS', + SubscriberNonSubscriberAverageReorders = 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS', + CouponsRevenuePenetration = 'COUPONS_REVENUE_PENETRATION' } /** @@ -831,13 +870,13 @@ export enum SortOrder { */ export interface TimeInterval { /** - * When this object is used as a request parameter, the specified startDate is adjusted based on the aggregation frequency. * For WEEK the metric is computed from the first day of the week (that is, Sunday based on ISO 8601) that contains the startDate. * For MONTH the metric is computed from the first day of the month that contains the startDate. * For QUARTER the metric is computed from the first day of the quarter that contains the startDate. * For YEAR the metric is computed from the first day of the year that contains the startDate. + * When this object is used as a request parameter, the specified `startDate` is adjusted based on the aggregation frequency. * For `WEEK` the metric is computed from the first day of the week (Sunday, based on ISO 8601) that contains the `startDate`. * For `MONTH` the metric is computed from the first day of the month that contains the `startDate`. * For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`. * For `YEAR` the metric is computed from the first day of the year that contains the `startDate`. * @type {string} * @memberof TimeInterval */ startDate: string; /** - * When this object is used as a request parameter, the specified endDate is adjusted based on the aggregation frequency. * For WEEK the metric is computed up to the last day of the week (that is, Sunday based on ISO 8601) that contains the endDate. * For MONTH, the metric is computed up to the last day that contains the endDate. * For QUARTER the metric is computed up to the last day of the quarter that contains the endDate. * For YEAR the metric is computed up to the last day of the year that contains the endDate. Note: The end date may be adjusted to a lower value based on the data available in our system. + * When this object is used as a request parameter, the specified `endDate` is adjusted based on the aggregation frequency. * For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains the `endDate`. * For `MONTH`, the metric is computed up to the last day that contains the `endDate`. * For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`. * For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`. Note: The end date may be adjusted to a lower value based on the data available in our system. * @type {string} * @memberof TimeInterval */ @@ -894,8 +933,8 @@ export const OffersApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time. **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 {ListOffersRequest} [body] + * Returns the details of a selling partner\'s replenishment program offers. **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 {ListOffersRequest} [body] The request body for the `listOffers` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -947,8 +986,8 @@ export const OffersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time. **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 {ListOffersRequest} [body] + * Returns the details of a selling partner\'s replenishment program offers. **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 {ListOffersRequest} [body] The request body for the `listOffers` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -976,8 +1015,8 @@ export const OffersApiFactory = function (configuration?: Configuration, basePat return localVarFp.listOfferMetrics(body, options).then((request) => request(axios, basePath)); }, /** - * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time. **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 {ListOffersRequest} [body] + * Returns the details of a selling partner\'s replenishment program offers. **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 {ListOffersRequest} [body] The request body for the `listOffers` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1008,7 +1047,7 @@ export interface OffersApiListOfferMetricsRequest { */ export interface OffersApiListOffersRequest { /** - * + * The request body for the `listOffers` operation. * @type {ListOffersRequest} * @memberof OffersApiListOffers */ @@ -1034,7 +1073,7 @@ export class OffersApi extends BaseAPI { } /** - * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time. **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 details of a selling partner\'s replenishment program offers. **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 {OffersApiListOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1054,7 +1093,7 @@ export const SellingpartnersApiAxiosParamCreator = function (configuration?: Con return { /** * Returns aggregated replenishment program metrics for a selling partner. **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 {GetSellingPartnerMetricsRequest} [body] + * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1097,7 +1136,7 @@ export const SellingpartnersApiFp = function(configuration?: Configuration) { return { /** * Returns aggregated replenishment program metrics for a selling partner. **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 {GetSellingPartnerMetricsRequest} [body] + * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1117,7 +1156,7 @@ export const SellingpartnersApiFactory = function (configuration?: Configuration return { /** * Returns aggregated replenishment program metrics for a selling partner. **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 {GetSellingPartnerMetricsRequest} [body] + * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1134,7 +1173,7 @@ export const SellingpartnersApiFactory = function (configuration?: Configuration */ export interface SellingpartnersApiGetSellingPartnerMetricsRequest { /** - * + * The request body for the `getSellingPartnerMetrics` operation. * @type {GetSellingPartnerMetricsRequest} * @memberof SellingpartnersApiGetSellingPartnerMetrics */ diff --git a/src/api-models/reports-api-model/api.ts b/src/api-models/reports-api-model/api.ts index 0fd367eb8..e4ac296a0 100644 --- a/src/api-models/reports-api-model/api.ts +++ b/src/api-models/reports-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Reports - * Effective **June 27, 2023**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/reports-api-model/base.ts b/src/api-models/reports-api-model/base.ts index 3295216e5..d706b41c3 100644 --- a/src/api-models/reports-api-model/base.ts +++ b/src/api-models/reports-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Reports - * Effective **June 27, 2023**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/reports-api-model/common.ts b/src/api-models/reports-api-model/common.ts index dc25d332e..d233a6588 100644 --- a/src/api-models/reports-api-model/common.ts +++ b/src/api-models/reports-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Reports - * Effective **June 27, 2023**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/reports-api-model/configuration.ts b/src/api-models/reports-api-model/configuration.ts index 787e8ee50..6441ef0de 100644 --- a/src/api-models/reports-api-model/configuration.ts +++ b/src/api-models/reports-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Reports - * Effective **June 27, 2023**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * diff --git a/src/api-models/reports-api-model/index.ts b/src/api-models/reports-api-model/index.ts index c04f32938..4f9d99a39 100644 --- a/src/api-models/reports-api-model/index.ts +++ b/src/api-models/reports-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Reports - * Effective **June 27, 2023**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. + * Effective **June 27, 2024**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 *