/** * Fulfillment Inbound v2024-03-20 * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface. * * The version of the OpenAPI document: 2024-03-20 * * * 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 { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * Specific details to identify a place. * @export * @interface Address */ export interface Address { /** * Street address information. * @type {string} * @memberof Address */ addressLine1: string; /** * Additional street address information. * @type {string} * @memberof Address */ addressLine2?: string; /** * The city. * @type {string} * @memberof Address */ city: string; /** * The name of the business. * @type {string} * @memberof Address */ companyName?: string; /** * The country code in two-character ISO 3166-1 alpha-2 format. * @type {string} * @memberof Address */ countryCode: string; /** * 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} * @memberof Address */ postalCode: string; /** * The state or province code. * @type {string} * @memberof 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; } /** * A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints. * @export * @enum {string} */ export declare enum AllOwnersConstraint { MustMatch = "MUST_MATCH" } /** * The fulfillment center appointment slot for the transportation option. * @export * @interface AppointmentSlot */ export interface AppointmentSlot { /** * An identifier to a self-ship appointment slot. * @type {string} * @memberof AppointmentSlot */ slotId: string; /** * * @type {AppointmentSlotTime} * @memberof AppointmentSlot */ slotTime: AppointmentSlotTime; } /** * An appointment slot time with start and end. * @export * @interface AppointmentSlotTime */ export interface AppointmentSlotTime { /** * The end timestamp of the appointment in UTC. * @type {string} * @memberof AppointmentSlotTime */ endTime: string; /** * The start timestamp of the appointment in UTC. * @type {string} * @memberof AppointmentSlotTime */ startTime: string; } /** * 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. * @type {string} * @memberof Box */ boxId?: string; /** * * @type {BoxContentInformationSource} * @memberof Box */ contentInformationSource?: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; /** * * @type {Region} * @memberof Box */ destinationRegion?: Region; /** * * @type {Dimensions} * @memberof Box */ dimensions?: Dimensions; /** * Items contained within the box. * @type {Array} * @memberof Box */ items?: Array; /** * Primary key to uniquely identify a Package (Box or Pallet). * @type {string} * @memberof Box */ packageId: string; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} * @memberof Box */ quantity?: number; /** * Template name of the box. * @type {string} * @memberof Box */ templateName?: string; /** * * @type {Weight} * @memberof Box */ weight?: Weight; } /** * Indication of how box content is meant to be provided. * @export * @enum {string} */ export declare enum BoxContentInformationSource { BoxContentProvided = "BOX_CONTENT_PROVIDED", ManualProcess = "MANUAL_PROCESS", Barcode2D = "BARCODE_2D" } /** * Input information for a given box. * @export * @interface BoxInput */ export interface BoxInput { /** * * @type {BoxContentInformationSource} * @memberof BoxInput */ contentInformationSource: BoxContentInformationSource | 'BOX_CONTENT_PROVIDED' | 'MANUAL_PROCESS' | 'BARCODE_2D'; /** * * @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} * @memberof BoxInput */ quantity: number; /** * * @type {Weight} * @memberof BoxInput */ 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 BoxUpdateInput */ weight: Weight; } /** * The `cancelInboundPlan` response. * @export * @interface CancelInboundPlanResponse */ export interface CancelInboundPlanResponse { /** * UUID for the given operation. * @type {string} * @memberof CancelInboundPlanResponse */ operationId: string; } /** * The `cancelSelfShipAppointment` request. * @export * @interface CancelSelfShipAppointmentRequest */ export interface CancelSelfShipAppointmentRequest { /** * * @type {ReasonComment} * @memberof 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. * @export * @interface CancelSelfShipAppointmentResponse */ export interface CancelSelfShipAppointmentResponse { /** * UUID for the given operation. * @type {string} * @memberof CancelSelfShipAppointmentResponse */ operationId: string; } /** * The carrier for the inbound shipment. * @export * @interface Carrier */ export interface Carrier { /** * The carrier code. For example, USPS or DHLEX. * @type {string} * @memberof Carrier */ alphaCode?: string; /** * The name of the carrier. * @type {string} * @memberof 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 * @interface ComplianceDetail */ export interface ComplianceDetail { /** * The Amazon Standard Identification Number, which identifies the detail page identifier. * @type {string} * @memberof ComplianceDetail */ asin?: string; /** * The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition. * @type {string} * @memberof ComplianceDetail */ fnsku?: string; /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof ComplianceDetail */ msku?: string; /** * * @type {TaxDetails} * @memberof 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 * @interface ConfirmPackingOptionResponse */ export interface ConfirmPackingOptionResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmPackingOptionResponse */ operationId: string; } /** * The `confirmPlacementOption` response. * @export * @interface ConfirmPlacementOptionResponse */ export interface ConfirmPlacementOptionResponse { /** * UUID for the given operation. * @type {string} * @memberof 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 * @interface ConfirmTransportationOptionsRequest */ export interface ConfirmTransportationOptionsRequest { /** * Information needed to confirm one of the available transportation options. * @type {Array} * @memberof ConfirmTransportationOptionsRequest */ transportationSelections: Array; } /** * The `confirmTransportationOptions` response. * @export * @interface ConfirmTransportationOptionsResponse */ export interface ConfirmTransportationOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof ConfirmTransportationOptionsResponse */ operationId: string; } /** * The seller\'s contact information. * @export * @interface ContactInformation */ export interface ContactInformation { /** * The email address. * @type {string} * @memberof ContactInformation */ email?: string; /** * The contact\'s name. * @type {string} * @memberof ContactInformation */ name: string; /** * The phone number. * @type {string} * @memberof ContactInformation */ phoneNumber: string; } /** * Preview of the changes that will be applied to the shipment. * @export * @interface ContentUpdatePreview */ export interface ContentUpdatePreview { /** * Identifier of a content update preview. * @type {string} * @memberof ContentUpdatePreview */ contentUpdatePreviewId: string; /** * The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof ContentUpdatePreview */ expiration: string; /** * * @type {RequestedUpdates} * @memberof ContentUpdatePreview */ requestedUpdates: RequestedUpdates; /** * * @type {TransportationOption} * @memberof ContentUpdatePreview */ 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} * @memberof CreateInboundPlanRequest */ destinationMarketplaces: Array; /** * Items included in this plan. * @type {Array} * @memberof CreateInboundPlanRequest */ items: Array; /** * Name for the Inbound Plan. If one isn\'t provided, a default name will be provided. * @type {string} * @memberof CreateInboundPlanRequest */ name?: string; /** * * @type {AddressInput} * @memberof CreateInboundPlanRequest */ sourceAddress: AddressInput; } /** * The `createInboundPlan` response. * @export * @interface CreateInboundPlanResponse */ export interface CreateInboundPlanResponse { /** * Identifier of an inbound plan. * @type {string} * @memberof CreateInboundPlanResponse */ inboundPlanId: string; /** * UUID for the given operation. * @type {string} * @memberof 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. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @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; } /** * The type and amount of currency. * @export * @interface Currency */ export interface Currency { /** * Decimal value of the currency. * @type {number} * @memberof Currency */ amount: number; /** * ISO 4217 standard of a currency code. * @type {string} * @memberof Currency */ code: string; } /** * Provide units going to the warehouse. * @export * @interface CustomPlacementInput */ export interface CustomPlacementInput { /** * Items included while creating Inbound Plan. * @type {Array} * @memberof CustomPlacementInput */ items: Array; /** * Warehouse Id. * @type {string} * @memberof CustomPlacementInput */ warehouseId: string; } /** * Specifies the date that the seller expects their shipment will be shipped. * @export * @interface Dates */ export interface Dates { /** * * @type {Window} * @memberof Dates */ readyToShipWindow?: Window; } /** * Contains information pertaining to a delivery window option. * @export * @interface DeliveryWindowOption */ export interface DeliveryWindowOption { /** * Identifies type of Delivery Window Availability. Values: `AVAILABLE`, `CONGESTED` * @type {string} * @memberof DeliveryWindowOption */ 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 time at which this delivery window option ends. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`. * @type {string} * @memberof DeliveryWindowOption */ endDate: string; /** * The time at which this delivery window option starts. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`. * @type {string} * @memberof DeliveryWindowOption */ startDate: string; /** * The time at which this window delivery option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`. * @type {string} * @memberof DeliveryWindowOption */ validUntil: string; } /** * Measurement of a package\'s dimensions. * @export * @interface Dimensions */ export interface Dimensions { /** * The height of a package. * @type {number} * @memberof Dimensions */ height: number; /** * The length of a package. * @type {number} * @memberof Dimensions */ length: number; /** * * @type {UnitOfMeasurement} * @memberof Dimensions */ unitOfMeasurement: UnitOfMeasurement | 'IN' | 'CM'; /** * The width of a package. * @type {number} * @memberof Dimensions */ width: number; } /** * Resource to download the requested document. * @export * @interface DocumentDownload */ export interface DocumentDownload { /** * The type of download. Possible values: `URL`. * @type {string} * @memberof DocumentDownload */ downloadType: string; /** * The URI\'s expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof DocumentDownload */ expiration?: string; /** * Uniform resource identifier to identify where the document is located. * @type {string} * @memberof DocumentDownload */ uri: string; } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * List of errors. * @type {Array} * @memberof ErrorList */ errors: Array; } /** * Freight information describes the skus being transported. Freight carrier options and quotes will only be returned if the freight information is provided. * @export * @interface FreightInformation */ export interface FreightInformation { /** * * @type {Currency} * @memberof FreightInformation */ declaredValue?: Currency; /** * Freight class. Possible values: `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. * @export * @interface GeneratePlacementOptionsRequest */ export interface GeneratePlacementOptionsRequest { /** * Custom placement options you want to add to the plan. This is only used for the India (IN - A21TJRUUN4KGV) marketplace. * @type {Array} * @memberof GeneratePlacementOptionsRequest */ customPlacement?: Array; } /** * The `generatePlacementOptions` response. * @export * @interface GeneratePlacementOptionsResponse */ export interface GeneratePlacementOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof GeneratePlacementOptionsResponse */ operationId: string; } /** * The `generateSelfShipAppointmentSlots` request. * @export * @interface GenerateSelfShipAppointmentSlotsRequest */ export interface GenerateSelfShipAppointmentSlotsRequest { /** * The desired end date. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof GenerateSelfShipAppointmentSlotsRequest */ desiredEndDate?: string; /** * The desired start date. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof GenerateSelfShipAppointmentSlotsRequest */ desiredStartDate?: string; } /** * The `generateSelfShipAppointmentSlots` response. * @export * @interface GenerateSelfShipAppointmentSlotsResponse */ export interface GenerateSelfShipAppointmentSlotsResponse { /** * UUID for the given operation. * @type {string} * @memberof 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 * @interface GenerateTransportationOptionsRequest */ export interface GenerateTransportationOptionsRequest { /** * The placement option to generate transportation options for. * @type {string} * @memberof GenerateTransportationOptionsRequest */ placementOptionId: string; /** * List of shipment transportation configurations. * @type {Array} * @memberof GenerateTransportationOptionsRequest */ shipmentTransportationConfigurations: Array; } /** * The `generateTransportationOptions` response. * @export * @interface GenerateTransportationOptionsResponse */ export interface GenerateTransportationOptionsResponse { /** * UUID for the given operation. * @type {string} * @memberof GenerateTransportationOptionsResponse */ operationId: string; } /** * The `getDeliveryChallanDocumentResponse` response. * @export * @interface GetDeliveryChallanDocumentResponse */ export interface GetDeliveryChallanDocumentResponse { /** * * @type {DocumentDownload} * @memberof GetDeliveryChallanDocumentResponse */ documentDownload: DocumentDownload; } /** * The `getSelfShipAppointmentSlots` response. * @export * @interface GetSelfShipAppointmentSlotsResponse */ export interface GetSelfShipAppointmentSlotsResponse { /** * * @type {Pagination} * @memberof GetSelfShipAppointmentSlotsResponse */ pagination?: Pagination; /** * * @type {SelfShipAppointmentSlotsAvailability} * @memberof GetSelfShipAppointmentSlotsResponse */ selfShipAppointmentSlotsAvailability: SelfShipAppointmentSlotsAvailability; } /** * GetInboundOperationStatus response. * @export * @interface InboundOperationStatus */ export interface InboundOperationStatus { /** * 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. * @type {string} * @memberof InboundOperationStatus */ operationId: string; /** * The problems in the processing of the asynchronous operation. * @type {Array} * @memberof InboundOperationStatus */ operationProblems: Array; /** * * @type {OperationStatus} * @memberof InboundOperationStatus */ operationStatus: OperationStatus | 'SUCCESS' | 'FAILED' | 'IN_PROGRESS'; } /** * Inbound plan containing details of the inbound workflow. * @export * @interface InboundPlan */ export interface InboundPlan { /** * The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlan */ createdAt: string; /** * Identifier of an inbound plan. * @type {string} * @memberof InboundPlan */ inboundPlanId: string; /** * The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlan */ lastUpdatedAt: string; /** * A list of marketplace IDs. * @type {Array} * @memberof InboundPlan */ marketplaceIds: Array; /** * 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 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 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; /** * A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details. * @type {Array} * @memberof InboundPlan */ shipments?: Array; /** * * @type {Address} * @memberof InboundPlan */ sourceAddress: Address; /** * Current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`. * @type {string} * @memberof InboundPlan */ status: string; } /** * A light-weight inbound plan. * @export * @interface InboundPlanSummary */ export interface InboundPlanSummary { /** * The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlanSummary */ createdAt: string; /** * Identifier of an inbound plan. * @type {string} * @memberof InboundPlanSummary */ inboundPlanId: string; /** * The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`. * @type {string} * @memberof InboundPlanSummary */ lastUpdatedAt: string; /** * A list of marketplace IDs. * @type {Array} * @memberof InboundPlanSummary */ marketplaceIds: Array; /** * Human-readable name of the inbound plan. * @type {string} * @memberof InboundPlanSummary */ name: string; /** * * @type {Address} * @memberof InboundPlanSummary */ sourceAddress: Address; /** * The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`. * @type {string} * @memberof InboundPlanSummary */ status: string; } /** * Contains details about cost related modifications to the placement cost. * @export * @interface Incentive */ export interface Incentive { /** * Description of the incentive. * @type {string} * @memberof Incentive */ description: string; /** * Target of the incentive. Possible values: \'Placement Services\', \'Fulfillment Fee Discount\'. * @type {string} * @memberof Incentive */ target: string; /** * Type of incentive. Possible values: `FEE`, `DISCOUNT`. * @type {string} * @memberof Incentive */ type: string; /** * * @type {Currency} * @memberof Incentive */ value: Currency; } /** * Information associated with a single SKU in the seller\'s catalog. * @export * @interface Item */ export interface Item { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof Item */ asin: string; /** * The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box. * @type {string} * @memberof Item */ expiration?: string; /** * A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. * @type {string} * @memberof Item */ fnsku: string; /** * Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. * @type {string} * @memberof Item */ labelOwner: string; /** * The manufacturing lot code. * @type {string} * @memberof Item */ manufacturingLotCode?: string; /** * The merchant SKU, a merchant-supplied identifier of a specific SKU. * @type {string} * @memberof Item */ msku: string; /** * Special preparations that are required for an item. * @type {Array} * @memberof Item */ prepInstructions: Array; /** * The number of the specified MSKU. * @type {number} * @memberof Item */ quantity: number; } /** * Defines an item\'s input parameters. * @export * @interface ItemInput */ export interface ItemInput { /** * The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box. * @type {string} * @memberof ItemInput */ expiration?: string; /** * * @type {LabelOwner} * @memberof ItemInput */ labelOwner: LabelOwner | 'AMAZON' | 'SELLER' | 'NONE'; /** * The manufacturing lot code. * @type {string} * @memberof ItemInput */ manufacturingLotCode?: string; /** * The merchant SKU, a merchant-supplied identifier of a specific SKU. * @type {string} * @memberof ItemInput */ msku: string; /** * * @type {PrepOwner} * @memberof ItemInput */ prepOwner: PrepOwner | 'AMAZON' | 'SELLER' | 'NONE'; /** * The number of units of the specified MSKU that will be shipped. * @type {number} * @memberof ItemInput */ quantity: number; } /** * 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 declare 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 declare enum LabelOwner { Amazon = "AMAZON", Seller = "SELLER", None = "NONE" } /** * Indicates the type of print type for a given label. * @export * @enum {string} */ export declare 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 */ export interface ListInboundPlanBoxesResponse { /** * A list of boxes in an inbound plan. * @type {Array} * @memberof ListInboundPlanBoxesResponse */ boxes: Array; /** * * @type {Pagination} * @memberof ListInboundPlanBoxesResponse */ pagination?: Pagination; } /** * The `listInboundPlanItems` response. * @export * @interface ListInboundPlanItemsResponse */ export interface ListInboundPlanItemsResponse { /** * The items in an inbound plan. * @type {Array} * @memberof ListInboundPlanItemsResponse */ items: Array; /** * * @type {Pagination} * @memberof ListInboundPlanItemsResponse */ pagination?: Pagination; } /** * The `listInboundPlanPallets` response. * @export * @interface ListInboundPlanPalletsResponse */ export interface ListInboundPlanPalletsResponse { /** * * @type {Pagination} * @memberof ListInboundPlanPalletsResponse */ pagination?: Pagination; /** * The pallets in an inbound plan. * @type {Array} * @memberof ListInboundPlanPalletsResponse */ pallets: Array; } /** * The `listInboundPlans` response. * @export * @interface ListInboundPlansResponse */ export interface ListInboundPlansResponse { /** * A list of inbound plans with minimal information. * @type {Array} * @memberof ListInboundPlansResponse */ inboundPlans?: Array; /** * * @type {Pagination} * @memberof ListInboundPlansResponse */ pagination?: Pagination; } /** * The `listItemComplianceDetails` response. * @export * @interface ListItemComplianceDetailsResponse */ export interface ListItemComplianceDetailsResponse { /** * List of compliance details. * @type {Array} * @memberof ListItemComplianceDetailsResponse */ complianceDetails?: Array; } /** * 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 packing group. * @type {Array} * @memberof ListPackingGroupItemsResponse */ items: Array; /** * * @type {Pagination} * @memberof ListPackingGroupItemsResponse */ pagination?: Pagination; } /** * The `listPlacementOptions` response. * @export * @interface ListPackingOptionsResponse */ export interface ListPackingOptionsResponse { /** * List of packing options. * @type {Array} * @memberof ListPackingOptionsResponse */ packingOptions: Array; /** * * @type {Pagination} * @memberof ListPackingOptionsResponse */ pagination?: Pagination; } /** * The `listPlacementOptions` response. * @export * @interface ListPlacementOptionsResponse */ export interface ListPlacementOptionsResponse { /** * * @type {Pagination} * @memberof ListPlacementOptionsResponse */ pagination?: Pagination; /** * Placement options generated for the inbound plan. * @type {Array} * @memberof ListPlacementOptionsResponse */ placementOptions: Array; } /** * The response to the `listPrepDetails` operation. * @export * @interface ListPrepDetailsResponse */ export interface ListPrepDetailsResponse { /** * A list of MSKUs and related prep details. * @type {Array} * @memberof ListPrepDetailsResponse */ mskuPrepDetails: Array; } /** * 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 */ export interface ListTransportationOptionsResponse { /** * * @type {Pagination} * @memberof ListTransportationOptionsResponse */ pagination?: Pagination; /** * Transportation options generated for the placement option. * @type {Array} * @memberof ListTransportationOptionsResponse */ transportationOptions: Array; } /** * Contains information related to Less-Than-Truckload (LTL) shipment tracking. * @export * @interface LtlTrackingDetail */ export interface LtlTrackingDetail { /** * The number of the carrier shipment acknowledgement document. * @type {string} * @memberof LtlTrackingDetail */ billOfLadingNumber?: string; /** * The number associated with the freight bill. * @type {Array} * @memberof LtlTrackingDetail */ freightBillNumber?: Array; } /** * Contains input information to update Less-Than-Truckload (LTL) tracking information. * @export * @interface LtlTrackingDetailInput */ export interface LtlTrackingDetailInput { /** * The number of the carrier shipment acknowledgement document. * @type {string} * @memberof LtlTrackingDetailInput */ billOfLadingNumber?: string; /** * Number associated with the freight bill. * @type {Array} * @memberof LtlTrackingDetailInput */ freightBillNumber: Array; } /** * Error object containing information about what went wrong. * @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; } /** * An MSKU and its related prep details. * @export * @interface MskuPrepDetail */ export interface MskuPrepDetail { /** * * @type {AllOwnersConstraint} * @memberof MskuPrepDetail */ allOwnersConstraint?: AllOwnersConstraint | 'MUST_MATCH'; /** * * @type {OwnerConstraint} * @memberof MskuPrepDetail */ labelOwnerConstraint?: OwnerConstraint | 'AMAZON_ONLY' | 'NONE_ONLY' | 'SELLER_ONLY'; /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof MskuPrepDetail */ msku: string; /** * * @type {PrepCategory} * @memberof MskuPrepDetail */ prepCategory: PrepCategory | 'ADULT' | 'BABY' | 'FC_PROVIDED' | 'FRAGILE' | 'GRANULAR' | 'HANGER' | 'LIQUID' | 'PERFORATED' | 'SET' | 'SHARP' | 'SMALL' | 'TEXTILE' | 'UNKNOWN' | 'NONE'; /** * * @type {OwnerConstraint} * @memberof MskuPrepDetail */ prepOwnerConstraint?: OwnerConstraint | 'AMAZON_ONLY' | 'NONE_ONLY' | 'SELLER_ONLY'; /** * A list of preparation types associated with a preparation category. * @type {Array} * @memberof MskuPrepDetail */ prepTypes: Array<(PrepType | 'ITEM_BLACK_SHRINKWRAP' | 'ITEM_BLANKSTK' | 'ITEM_BOXING' | 'ITEM_BUBBLEWRAP' | 'ITEM_CAP_SEALING' | 'ITEM_DEBUNDLE' | 'ITEM_HANG_GARMENT' | 'ITEM_LABELING' | 'ITEM_NO_PREP' | 'ITEM_POLYBAGGING' | 'ITEM_RMOVHANG' | 'ITEM_SETCREAT' | 'ITEM_SETSTK' | 'ITEM_SIOC' | 'ITEM_SUFFOSTK' | 'ITEM_TAPING')>; } /** * An MSKU and its related prep details. * @export * @interface MskuPrepDetailInput */ export interface MskuPrepDetailInput { /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof MskuPrepDetailInput */ msku: string; /** * * @type {PrepCategory} * @memberof MskuPrepDetailInput */ prepCategory: PrepCategory | 'ADULT' | 'BABY' | 'FC_PROVIDED' | 'FRAGILE' | 'GRANULAR' | 'HANGER' | 'LIQUID' | 'PERFORATED' | 'SET' | 'SHARP' | 'SMALL' | 'TEXTILE' | 'UNKNOWN' | 'NONE'; /** * A list of preparation types associated with a preparation category. * @type {Array} * @memberof MskuPrepDetailInput */ prepTypes: Array<(PrepType | 'ITEM_BLACK_SHRINKWRAP' | 'ITEM_BLANKSTK' | 'ITEM_BOXING' | 'ITEM_BUBBLEWRAP' | 'ITEM_CAP_SEALING' | 'ITEM_DEBUNDLE' | 'ITEM_HANG_GARMENT' | 'ITEM_LABELING' | 'ITEM_NO_PREP' | 'ITEM_POLYBAGGING' | 'ITEM_RMOVHANG' | 'ITEM_SETCREAT' | 'ITEM_SETSTK' | 'ITEM_SIOC' | 'ITEM_SUFFOSTK' | 'ITEM_TAPING')>; } /** * 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 * @interface OperationProblem */ export interface OperationProblem { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof OperationProblem */ code: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof OperationProblem */ details?: string; /** * A message that describes the error condition. * @type {string} * @memberof OperationProblem */ message: string; /** * The severity of the problem. Possible values: `WARNING`, `ERROR`. * @type {string} * @memberof OperationProblem */ severity: string; } /** * The status of an operation. * @export * @enum {string} */ export declare enum OperationStatus { Success = "SUCCESS", Failed = "FAILED", InProgress = "IN_PROGRESS" } /** * A constraint that can apply to an individual owner. If no constraint is specified, both `AMAZON` and `SELLER` are acceptable. * @export * @enum {string} */ export declare enum OwnerConstraint { AmazonOnly = "AMAZON_ONLY", NoneOnly = "NONE_ONLY", SellerOnly = "SELLER_ONLY" } /** * Packing information for the inbound plan. * @export * @interface PackageGroupingInput */ export interface PackageGroupingInput { /** * Box level information being provided. * @type {Array} * @memberof PackageGroupingInput */ boxes: Array; /** * The ID of the `packingGroup` that packages are grouped according to. The `PackingGroupId` can only be provided before placement confirmation, and it must belong to the confirmed `PackingOption`. One of `ShipmentId` or `PackingGroupId` must be provided with every request. * @type {string} * @memberof PackageGroupingInput */ packingGroupId?: string; /** * The ID of the shipment that packages are grouped according to. The `ShipmentId` can only be provided after placement confirmation, and the shipment must belong to the confirmed placement option. One of `ShipmentId` or `PackingGroupId` must be provided with every request. * @type {string} * @memberof PackageGroupingInput */ shipmentId?: string; } /** * A packing option contains a set of pack groups plus additional information about the packing option, such as any discounts or fees if it\'s selected. * @export * @interface PackingOption */ export interface PackingOption { /** * Discount for the offered option. * @type {Array} * @memberof PackingOption */ discounts: Array; /** * The time at which this packing option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof PackingOption */ expiration?: string; /** * Fee for the offered option. * @type {Array} * @memberof PackingOption */ fees: Array; /** * Packing group IDs. * @type {Array} * @memberof PackingOption */ packingGroups: Array; /** * Identifier of a packing option. * @type {string} * @memberof PackingOption */ packingOptionId: string; /** * The status of the packing option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`. * @type {string} * @memberof PackingOption */ status: string; /** * List of supported shipping modes. * @type {Array} * @memberof PackingOption */ supportedShippingConfigurations: Array; } /** * Summary information about a packing option. * @export * @interface PackingOptionSummary */ export interface PackingOptionSummary { /** * Identifier of a packing option. * @type {string} * @memberof PackingOptionSummary */ packingOptionId: string; /** * The status of a packing option. Possible values: \'OFFERED\', \'ACCEPTED\', \'EXPIRED\'. * @type {string} * @memberof PackingOptionSummary */ status: string; } /** * Contains tokens to fetch from a certain page. * @export * @interface Pagination */ export interface Pagination { /** * When present, pass this string token in the next request to return the next response page. * @type {string} * @memberof Pagination */ nextToken?: string; } /** * Contains information about a pallet that is used in the inbound plan. The pallet is a container that holds multiple items or boxes. * @export * @interface Pallet */ export interface Pallet { /** * * @type {Dimensions} * @memberof Pallet */ dimensions?: Dimensions; /** * Primary key to uniquely identify a Package (Box or Pallet). * @type {string} * @memberof Pallet */ packageId: string; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} * @memberof Pallet */ quantity?: number; /** * * @type {Stackability} * @memberof Pallet */ stackability?: Stackability | 'STACKABLE' | 'NON_STACKABLE'; /** * * @type {Weight} * @memberof Pallet */ weight?: Weight; } /** * Contains input information about a pallet to be used in the inbound plan. * @export * @interface PalletInput */ export interface PalletInput { /** * * @type {Dimensions} * @memberof PalletInput */ dimensions?: Dimensions; /** * The number of containers where all other properties like weight or dimensions are identical. * @type {number} * @memberof PalletInput */ quantity: number; /** * * @type {Stackability} * @memberof PalletInput */ stackability?: Stackability | 'STACKABLE' | 'NON_STACKABLE'; /** * * @type {Weight} * @memberof PalletInput */ weight?: Weight; } /** * Contains information pertaining to the placement of the contents of an inbound plan and the related costs. * @export * @interface PlacementOption */ export interface PlacementOption { /** * Discount for the offered option. * @type {Array} * @memberof PlacementOption */ discounts: Array; /** * The expiration date of the placement option. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof PlacementOption */ expiration?: string; /** * The fee for the offered option. * @type {Array} * @memberof PlacementOption */ fees: Array; /** * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} * @memberof PlacementOption */ placementOptionId: string; /** * Shipment ids. * @type {Array} * @memberof PlacementOption */ shipmentIds: Array; /** * The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`. * @type {string} * @memberof PlacementOption */ status: string; } /** * Summary information about a placement option. * @export * @interface PlacementOptionSummary */ export interface PlacementOptionSummary { /** * 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. Possible values: `OFFERED`, `ACCEPTED`. * @type {string} * @memberof PlacementOptionSummary */ status: string; } /** * The preparation category for shipping an item to Amazon\'s fulfillment network. * @export * @enum {string} */ export declare enum PrepCategory { Adult = "ADULT", Baby = "BABY", FcProvided = "FC_PROVIDED", Fragile = "FRAGILE", Granular = "GRANULAR", Hanger = "HANGER", Liquid = "LIQUID", Perforated = "PERFORATED", Set = "SET", Sharp = "SHARP", Small = "SMALL", Textile = "TEXTILE", Unknown = "UNKNOWN", None = "NONE" } /** * Information pertaining to the preparation of inbound goods. * @export * @interface PrepInstruction */ export interface PrepInstruction { /** * * @type {Currency} * @memberof PrepInstruction */ fee?: Currency; /** * 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. Possible values: `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; } /** * The owner of the preparations, if special preparations are required. * @export * @enum {string} */ export declare enum PrepOwner { Amazon = "AMAZON", Seller = "SELLER", None = "NONE" } /** * Preparation instructions for shipping an item to Amazon\'s fulfillment network. For more information about preparing items for shipment to Amazon\'s fulfillment network, refer to [Seller Central Help for your marketplace](https://developer-docs.amazon.com/sp-api/docs/seller-central-urls). * @export * @enum {string} */ export declare enum PrepType { BlackShrinkwrap = "ITEM_BLACK_SHRINKWRAP", Blankstk = "ITEM_BLANKSTK", Boxing = "ITEM_BOXING", Bubblewrap = "ITEM_BUBBLEWRAP", CapSealing = "ITEM_CAP_SEALING", Debundle = "ITEM_DEBUNDLE", HangGarment = "ITEM_HANG_GARMENT", Labeling = "ITEM_LABELING", NoPrep = "ITEM_NO_PREP", Polybagging = "ITEM_POLYBAGGING", Rmovhang = "ITEM_RMOVHANG", Setcreat = "ITEM_SETCREAT", Setstk = "ITEM_SETSTK", Sioc = "ITEM_SIOC", Suffostk = "ITEM_SUFFOSTK", Taping = "ITEM_TAPING" } /** * The estimated shipping cost associated with the transportation option. * @export * @interface Quote */ export interface Quote { /** * * @type {Currency} * @memberof Quote */ cost: Currency; /** * The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. * @type {string} * @memberof Quote */ expiration?: string; /** * Voidable until timestamp. * @type {string} * @memberof Quote */ voidableUntil?: string; } /** * Reason for cancelling or rescheduling a self-ship appointment. * @export * @enum {string} */ export declare enum ReasonComment { AppointmentRequestedByMistake = "APPOINTMENT_REQUESTED_BY_MISTAKE", VehicleDelay = "VEHICLE_DELAY", SlotNotSuitable = "SLOT_NOT_SUITABLE", OutsideCarrierBusinessHours = "OUTSIDE_CARRIER_BUSINESS_HOURS", UnfavourableExternalConditions = "UNFAVOURABLE_EXTERNAL_CONDITIONS", ProcurementDelay = "PROCUREMENT_DELAY", ShippingPlanChanged = "SHIPPING_PLAN_CHANGED", IncreasedQuantity = "INCREASED_QUANTITY", Other = "OTHER" } /** * Representation of a location used within the inbounding experience. * @export * @interface Region */ export interface Region { /** * ISO 3166 standard alpha-2 country code. * @type {string} * @memberof Region */ countryCode?: string; /** * State. * @type {string} * @memberof Region */ state?: string; /** * An identifier for a warehouse, such as a FC, IXD, upstream storage. * @type {string} * @memberof Region */ warehouseId?: string; } /** * 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 */ export interface ScheduleSelfShipAppointmentRequest { /** * * @type {ReasonComment} * @memberof 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'; } /** * The `scheduleSelfShipAppointment` response. * @export * @interface ScheduleSelfShipAppointmentResponse */ export interface ScheduleSelfShipAppointmentResponse { /** * * @type {SelfShipAppointmentDetails} * @memberof 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 * @interface SelfShipAppointmentDetails */ export interface SelfShipAppointmentDetails { /** * Identifier for appointment. * @type {number} * @memberof SelfShipAppointmentDetails */ appointmentId?: number; /** * * @type {AppointmentSlotTime} * @memberof SelfShipAppointmentDetails */ appointmentSlotTime?: AppointmentSlotTime; /** * Status of the appointment. * @type {string} * @memberof SelfShipAppointmentDetails */ appointmentStatus?: string; } /** * The self ship appointment time slots availability and an expiration date for which the slots can be scheduled. * @export * @interface SelfShipAppointmentSlotsAvailability */ export interface SelfShipAppointmentSlotsAvailability { /** * The time at which the self ship appointment slot expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. * @type {string} * @memberof SelfShipAppointmentSlotsAvailability */ expiresAt?: string; /** * A list of appointment slots. * @type {Array} * @memberof SelfShipAppointmentSlotsAvailability */ slots?: Array; } /** * The `setPackingInformation` request. * @export * @interface SetPackingInformationRequest */ export interface SetPackingInformationRequest { /** * List of packing information for the inbound plan. * @type {Array} * @memberof SetPackingInformationRequest */ packageGroupings: Array; } /** * The `setPackingInformation` response. * @export * @interface SetPackingInformationResponse */ export interface SetPackingInformationResponse { /** * UUID for the given operation. * @type {string} * @memberof SetPackingInformationResponse */ operationId: string; } /** * The `setPrepDetails` request. * @export * @interface SetPrepDetailsRequest */ export interface SetPrepDetailsRequest { /** * The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} * @memberof SetPrepDetailsRequest */ marketplaceId: string; /** * A list of MSKUs and related prep details. * @type {Array} * @memberof SetPrepDetailsRequest */ mskuPrepDetails: Array; } /** * The `setPrepDetails` response. * @export * @interface SetPrepDetailsResponse */ export interface SetPrepDetailsResponse { /** * UUID for the given operation. * @type {string} * @memberof SetPrepDetailsResponse */ operationId: string; } /** * Contains information pertaining to a shipment in an inbound plan. * @export * @interface Shipment */ export interface Shipment { /** * A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment. * @type {string} * @memberof Shipment */ amazonReferenceId?: string; /** * * @type {ContactInformation} * @memberof Shipment */ contactInformation?: ContactInformation; /** * * @type {Dates} * @memberof Shipment */ dates?: Dates; /** * * @type {ShipmentDestination} * @memberof Shipment */ destination: ShipmentDestination; /** * * @type {FreightInformation} * @memberof Shipment */ freightInformation?: FreightInformation; /** * The name of the shipment. * @type {string} * @memberof Shipment */ name?: string; /** * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} * @memberof Shipment */ placementOptionId: string; /** * * @type {SelectedDeliveryWindow} * @memberof Shipment */ selectedDeliveryWindow?: SelectedDeliveryWindow; /** * Identifier of a transportation option. A transportation option represent one option for how to send a shipment. * @type {string} * @memberof Shipment */ selectedTransportationOptionId?: string; /** * List of self ship appointment details. * @type {Array} * @memberof Shipment */ selfShipAppointmentDetails?: Array; /** * The confirmed shipment ID which shows up on labels (for example, `FBA1234ABCD`). * @type {string} * @memberof Shipment */ shipmentConfirmationId?: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof Shipment */ shipmentId: string; /** * * @type {ShipmentSource} * @memberof Shipment */ source: ShipmentSource; /** * The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING` * @type {string} * @memberof Shipment */ status?: string; /** * * @type {TrackingDetails} * @memberof Shipment */ trackingDetails?: TrackingDetails; } /** * The Amazon fulfillment center address and warehouse ID. * @export * @interface ShipmentDestination */ export interface ShipmentDestination { /** * * @type {Address} * @memberof ShipmentDestination */ address?: Address; /** * The type of destination for this shipment. Possible values: `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`. * @type {string} * @memberof ShipmentDestination */ warehouseId?: string; } /** * Specifies the \'ship from\' address for the shipment. * @export * @interface ShipmentSource */ export interface ShipmentSource { /** * * @type {Address} * @memberof ShipmentSource */ address?: Address; /** * The type of source for this shipment. Possible values: `SELLER_FACILITY`. * @type {string} * @memberof ShipmentSource */ sourceType: string; } /** * Summary information about a shipment. * @export * @interface ShipmentSummary */ export interface ShipmentSummary { /** * 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 as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING` * @type {string} * @memberof ShipmentSummary */ status: string; } /** * Details needed to generate the transportation options. * @export * @interface ShipmentTransportationConfiguration */ export interface ShipmentTransportationConfiguration { /** * * @type {ContactInformation} * @memberof ShipmentTransportationConfiguration */ contactInformation?: ContactInformation; /** * * @type {FreightInformation} * @memberof ShipmentTransportationConfiguration */ freightInformation?: FreightInformation; /** * List of pallet configuration inputs. * @type {Array} * @memberof ShipmentTransportationConfiguration */ pallets?: Array; /** * * @type {WindowInput} * @memberof ShipmentTransportationConfiguration */ readyToShipWindow: WindowInput; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof ShipmentTransportationConfiguration */ shipmentId: string; } /** * The shipping configurations supported for the packing 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. * @export * @interface ShippingConfiguration */ export interface ShippingConfiguration { /** * Mode of shipment transportation that this option will provide. Possible values: `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. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`. * @type {string} * @memberof ShippingConfiguration */ shippingSolution?: string; } /** * Contains information related to Small Parcel Delivery (SPD) shipment tracking. * @export * @interface SpdTrackingDetail */ export interface SpdTrackingDetail { /** * List of Small Parcel Delivery (SPD) tracking items. * @type {Array} * @memberof SpdTrackingDetail */ spdTrackingItems?: Array; } /** * Contains input information to update Small Parcel Delivery (SPD) tracking information. * @export * @interface SpdTrackingDetailInput */ export interface SpdTrackingDetailInput { /** * List of Small Parcel Delivery (SPD) tracking items input. * @type {Array} * @memberof SpdTrackingDetailInput */ spdTrackingItems: Array; } /** * Contains information used to track and identify a Small Parcel Delivery (SPD) item. * @export * @interface SpdTrackingItem */ 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. * @type {string} * @memberof SpdTrackingItem */ boxId?: string; /** * The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. * @type {string} * @memberof 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. Possible values: `VALIDATED`, `NOT_VALIDATED`. * @type {string} * @memberof SpdTrackingItem */ trackingNumberValidationStatus?: string; } /** * Small Parcel Delivery (SPD) tracking items input information. * @export * @interface SpdTrackingItemInput */ 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. * @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. * @type {string} * @memberof SpdTrackingItemInput */ trackingId: string; } /** * Indicates whether pallets will be stacked when carrier arrives for pick-up. * @export * @enum {string} */ export declare enum Stackability { Stackable = "STACKABLE", NonStackable = "NON_STACKABLE" } /** * Information used to determine the tax compliance. * @export * @interface TaxDetails */ export interface TaxDetails { /** * * @type {Currency} * @memberof TaxDetails */ declaredValue?: Currency; /** * Harmonized System of Nomenclature code. * @type {string} * @memberof TaxDetails */ hsnCode?: string; /** * List of tax rates. * @type {Array} * @memberof TaxDetails */ taxRates?: Array; } /** * Contains the type and rate of tax. * @export * @interface TaxRate */ export interface TaxRate { /** * Rate of cess tax. * @type {number} * @memberof TaxRate */ cessRate?: number; /** * Rate of gst tax. * @type {number} * @memberof TaxRate */ gstRate?: number; /** * Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`. * @type {string} * @memberof TaxRate */ taxType?: string; } /** * Tracking information for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments. * @export * @interface TrackingDetails */ export interface TrackingDetails { /** * * @type {LtlTrackingDetail} * @memberof TrackingDetails */ ltlTrackingDetail?: LtlTrackingDetail; /** * * @type {SpdTrackingDetail} * @memberof TrackingDetails */ spdTrackingDetail?: SpdTrackingDetail; } /** * Tracking information input for Less-Than-Truckload (LTL) and Small Parcel Delivery (SPD) shipments. * @export * @interface TrackingDetailsInput */ export interface TrackingDetailsInput { /** * * @type {LtlTrackingDetailInput} * @memberof TrackingDetailsInput */ ltlTrackingDetail?: LtlTrackingDetailInput; /** * * @type {SpdTrackingDetailInput} * @memberof TrackingDetailsInput */ spdTrackingDetail?: SpdTrackingDetailInput; } /** * Contains information pertaining to a transportation option and the related carrier. * @export * @interface TransportationOption */ export interface TransportationOption { /** * * @type {Carrier} * @memberof TransportationOption */ carrier: Carrier; /** * * @type {CarrierAppointment} * @memberof TransportationOption */ carrierAppointment?: CarrierAppointment; /** * Identifies a list of preconditions for confirming the transportation option. * @type {Array} * @memberof TransportationOption */ preconditions: Array; /** * * @type {Quote} * @memberof TransportationOption */ quote?: Quote; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof TransportationOption */ shipmentId: string; /** * Mode of shipment transportation that this option will provide. Possible values: `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; /** * Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`. * @type {string} * @memberof TransportationOption */ shippingSolution: string; /** * Identifier of a transportation option. A transportation option represent one option for how to send a shipment. * @type {string} * @memberof TransportationOption */ transportationOptionId: string; } /** * The transportation option selected to confirm. * @export * @interface TransportationSelection */ export interface TransportationSelection { /** * * @type {ContactInformation} * @memberof TransportationSelection */ contactInformation?: ContactInformation; /** * Shipment ID that the transportation Option is for. * @type {string} * @memberof TransportationSelection */ shipmentId: string; /** * Transportation option being selected for the provided shipment. * @type {string} * @memberof TransportationSelection */ transportationOptionId: string; } /** * Unit of linear measure. * @export * @enum {string} */ export declare enum UnitOfMeasurement { In = "IN", Cm = "CM" } /** * Unit of the weight being measured. * @export * @enum {string} */ export declare enum UnitOfWeight { Lb = "LB", 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 * @interface UpdateItemComplianceDetailsRequest */ export interface UpdateItemComplianceDetailsRequest { /** * The merchant SKU, a merchant-supplied identifier for a specific SKU. * @type {string} * @memberof UpdateItemComplianceDetailsRequest */ msku: string; /** * * @type {TaxDetails} * @memberof UpdateItemComplianceDetailsRequest */ taxDetails: TaxDetails; } /** * The `updateItemComplianceDetails` response. * @export * @interface UpdateItemComplianceDetailsResponse */ export interface UpdateItemComplianceDetailsResponse { /** * UUID for the given operation. * @type {string} * @memberof UpdateItemComplianceDetailsResponse */ operationId: string; } /** * The `updateShipmentName` request. * @export * @interface UpdateShipmentNameRequest */ export interface UpdateShipmentNameRequest { /** * A human-readable name to update the shipment name to. * @type {string} * @memberof UpdateShipmentNameRequest */ name: string; } /** * The `UpdateShipmentSourceAddress` request. * @export * @interface UpdateShipmentSourceAddressRequest */ 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 UpdateShipmentSourceAddressResponse */ operationId: string; } /** * The `updateShipmentTrackingDetails` request. * @export * @interface UpdateShipmentTrackingDetailsRequest */ export interface UpdateShipmentTrackingDetailsRequest { /** * * @type {TrackingDetailsInput} * @memberof UpdateShipmentTrackingDetailsRequest */ trackingDetails: TrackingDetailsInput; } /** * The `updateShipmentTrackingDetails` response. * @export * @interface UpdateShipmentTrackingDetailsResponse */ export interface UpdateShipmentTrackingDetailsResponse { /** * UUID for the given operation. * @type {string} * @memberof UpdateShipmentTrackingDetailsResponse */ operationId: string; } /** * The weight of a package. * @export * @interface Weight */ export interface Weight { /** * * @type {UnitOfWeight} * @memberof Weight */ unit: UnitOfWeight | 'LB' | 'KG'; /** * Value of a weight. * @type {number} * @memberof Weight */ value: number; } /** * Contains a start and end DateTime representing a time range. * @export * @interface Window */ export interface Window { /** * The timestamp at which this Window can no longer be edited. * @type {string} * @memberof Window */ editableUntil?: string; /** * The end timestamp of the window. * @type {string} * @memberof Window */ end: string; /** * The start timestamp of the window. * @type {string} * @memberof Window */ start: string; } /** * Contains only a starting DateTime. * @export * @interface WindowInput */ export interface WindowInput { /** * The start date of the window. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with minute precision. Supports patterns `yyyy-MM-ddTHH:mmZ`, `yyyy-MM-ddTHH:mm:ssZ`, or `yyyy-MM-ddTHH:mm:ss.sssZ`. Note that non-zero second and millisecond components are removed. * @type {string} * @memberof WindowInput */ start: string; } /** * FulfillmentInboundApi - axios parameter creator * @export */ export declare const FulfillmentInboundApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelInboundPlan: (inboundPlanId: string, options?: any) => Promise; /** * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSelfShipAppointment: (inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: any) => Promise; /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to confirm the delivery window option for. * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmDeliveryWindowOptions: (inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: any) => Promise; /** * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPackingOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmPackingOption: (inboundPlanId: string, packingOptionId: string, options?: any) => Promise; /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPlacementOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmPlacementOption: (inboundPlanId: string, placementOptionId: string, options?: any) => Promise; /** * Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmShipmentContentUpdatePreview: (inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any) => Promise; /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmTransportationOptions: (inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: any) => Promise; /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createInboundPlan * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInboundPlan: (body: CreateInboundPlanRequest, options?: any) => Promise; /** * For a given marketplace - creates labels for a list of MSKUs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createMarketplaceItemLabels * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMarketplaceItemLabels: (body: CreateMarketplaceItemLabelsRequest, options?: any) => Promise; /** * Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to generate delivery window options for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateDeliveryWindowOptions: (inboundPlanId: string, shipmentId: string, options?: any) => Promise; /** * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generatePackingOptions: (inboundPlanId: string, options?: any) => Promise; /** * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generatePlacementOptions: (inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: any) => Promise; /** * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: any) => Promise; /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateShipmentContentUpdatePreviews: (inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: any) => Promise; /** * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateTransportationOptions: (inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: any) => Promise; /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getDeliveryChallanDocument * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeliveryChallanDocument: (inboundPlanId: string, shipmentId: string, options?: any) => Promise; /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundOperationStatus * @param {string} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundOperationStatus: (operationId: string, options?: any) => Promise; /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundPlan: (inboundPlanId: string, options?: any) => Promise; /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query. * @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} */ getSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipment: (inboundPlanId: string, shipmentId: string, options?: any) => Promise; /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentContentUpdatePreview: (inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any) => Promise; /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to get delivery window options for. * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query. * @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) => Promise; /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanBoxes: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanItems: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanPallets: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlans * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan. * @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field. * @param {'ASC' | 'DESC'} [sortOrder] The sort order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlans: (pageSize?: number, paginationToken?: string, status?: "ACTIVE" | "VOIDED" | "SHIPPED", sortBy?: "LAST_UPDATED_TIME" | "CREATION_TIME", sortOrder?: "ASC" | "DESC", options?: any) => Promise; /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listItemComplianceDetails * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listItemComplianceDetails: (mskus: Array, marketplaceId: string, options?: any) => Promise; /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query. * @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) => Promise; /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. * @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, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of packing options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPackingOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of placement options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPlacementOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any) => Promise; /** * Get preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPrepDetails * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPrepDetails: (marketplaceId: string, mskus: Array, options?: any) => Promise; /** * Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @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) => Promise; /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of content update previews to return. * @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) => Promise; /** * Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @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) => Promise; /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @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) => Promise; /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of transportation options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @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} */ listTransportationOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: any) => Promise; /** * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary scheduleSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} slotId An identifier to a self-ship appointment slot. * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ scheduleSelfShipAppointment: (inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: any) => Promise; /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPackingInformation * @param {string} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPackingInformation: (inboundPlanId: string, body: SetPackingInformationRequest, options?: any) => Promise; /** * Set the preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPrepDetails * @param {SetPrepDetailsRequest} body The body of the request to `setPrepDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPrepDetails: (body: SetPrepDetailsRequest, options?: any) => Promise; /** * Updates the name of an existing inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateInboundPlanName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInboundPlanName: (inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: any) => Promise; /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateItemComplianceDetails * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateItemComplianceDetails: (marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: any) => Promise; /** * Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentName: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: any) => Promise; /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentSourceAddress * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentSourceAddress: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: any) => Promise; /** * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentTrackingDetails * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentTrackingDetails: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: any) => Promise; }; /** * FulfillmentInboundApi - functional programming interface * @export */ export declare const FulfillmentInboundApiFp: (configuration?: Configuration) => { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelInboundPlan(inboundPlanId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to confirm the delivery window option for. * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPackingOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmPackingOption(inboundPlanId: string, packingOptionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPlacementOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmPlacementOption(inboundPlanId: string, placementOptionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmTransportationOptions(inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createInboundPlan * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInboundPlan(body: CreateInboundPlanRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * For a given marketplace - creates labels for a list of MSKUs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createMarketplaceItemLabels * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMarketplaceItemLabels(body: CreateMarketplaceItemLabelsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to generate delivery window options for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generatePackingOptions(inboundPlanId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generatePlacementOptions(inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateTransportationOptions(inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getDeliveryChallanDocument * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeliveryChallanDocument(inboundPlanId: string, shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundOperationStatus * @param {string} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundOperationStatus(operationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundPlan(inboundPlanId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query. * @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} */ getSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipment(inboundPlanId: string, shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to get delivery window options for. * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query. * @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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanBoxes(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanItems(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanPallets(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlans * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan. * @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field. * @param {'ASC' | 'DESC'} [sortOrder] The sort order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlans(pageSize?: number, paginationToken?: string, status?: "ACTIVE" | "VOIDED" | "SHIPPED", sortBy?: "LAST_UPDATED_TIME" | "CREATION_TIME", sortOrder?: "ASC" | "DESC", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listItemComplianceDetails * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listItemComplianceDetails(mskus: Array, marketplaceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query. * @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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. * @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, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of packing options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPackingOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of placement options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPlacementOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPrepDetails * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPrepDetails(marketplaceId: string, mskus: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of content update previews to return. * @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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of transportation options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @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} */ listTransportationOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary scheduleSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} slotId An identifier to a self-ship appointment slot. * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ scheduleSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPackingInformation * @param {string} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPackingInformation(inboundPlanId: string, body: SetPackingInformationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set the preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPrepDetails * @param {SetPrepDetailsRequest} body The body of the request to `setPrepDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPrepDetails(body: SetPrepDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the name of an existing inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateInboundPlanName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInboundPlanName(inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateItemComplianceDetails * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateItemComplianceDetails(marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentName(inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentSourceAddress * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentSourceAddress(inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentTrackingDetails * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentTrackingDetails(inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FulfillmentInboundApi - factory interface * @export */ export declare const FulfillmentInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelInboundPlan(inboundPlanId: string, options?: any): AxiosPromise; /** * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: any): AxiosPromise; /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to confirm the delivery window option for. * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: any): AxiosPromise; /** * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPackingOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingOptionId Identifier of a packing option. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmPackingOption(inboundPlanId: string, packingOptionId: string, options?: any): AxiosPromise; /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPlacementOption * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmPlacementOption(inboundPlanId: string, placementOptionId: string, options?: any): AxiosPromise; /** * Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): AxiosPromise; /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmTransportationOptions(inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: any): AxiosPromise; /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createInboundPlan * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInboundPlan(body: CreateInboundPlanRequest, options?: any): AxiosPromise; /** * For a given marketplace - creates labels for a list of MSKUs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createMarketplaceItemLabels * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMarketplaceItemLabels(body: CreateMarketplaceItemLabelsRequest, options?: any): AxiosPromise; /** * Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to generate delivery window options for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, options?: any): AxiosPromise; /** * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generatePackingOptions(inboundPlanId: string, options?: any): AxiosPromise; /** * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generatePlacementOptions(inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: any): AxiosPromise; /** * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: any): AxiosPromise; /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: any): AxiosPromise; /** * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateTransportationOptions(inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: any): AxiosPromise; /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getDeliveryChallanDocument * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeliveryChallanDocument(inboundPlanId: string, shipmentId: string, options?: any): AxiosPromise; /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundOperationStatus * @param {string} operationId Identifier of an asynchronous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundOperationStatus(operationId: string, options?: any): AxiosPromise; /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundPlan * @param {string} inboundPlanId Identifier of an inbound plan. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInboundPlan(inboundPlanId: string, options?: any): AxiosPromise; /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getSelfShipAppointmentSlots * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query. * @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} */ getSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipment(inboundPlanId: string, shipmentId: string, options?: any): AxiosPromise; /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipmentContentUpdatePreview * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} contentUpdatePreviewId Identifier of a content update preview. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: any): AxiosPromise; /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listDeliveryWindowOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId The shipment to get delivery window options for. * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query. * @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; /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanBoxes(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanItems(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlanPallets(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlans * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan. * @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field. * @param {'ASC' | 'DESC'} [sortOrder] The sort order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInboundPlans(pageSize?: number, paginationToken?: string, status?: "ACTIVE" | "VOIDED" | "SHIPPED", sortBy?: "LAST_UPDATED_TIME" | "CREATION_TIME", sortOrder?: "ASC" | "DESC", options?: any): AxiosPromise; /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listItemComplianceDetails * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listItemComplianceDetails(mskus: Array, marketplaceId: string, options?: any): AxiosPromise; /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query. * @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; /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} packingGroupId Identifier of a packing group. * @param {number} [pageSize] The number of packing group items to return in the response matching the given query. * @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, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of packing options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPackingOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPlacementOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of placement options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPlacementOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: any): AxiosPromise; /** * Get preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPrepDetails * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {Array} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPrepDetails(marketplaceId: string, mskus: Array, options?: any): AxiosPromise; /** * Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentBoxes * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of boxes to return in the response matching the given query. * @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; /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentContentUpdatePreviews * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of content update previews to return. * @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; /** * Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentItems * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of items to return in the response matching the given query. * @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; /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentPallets * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {number} [pageSize] The number of pallets to return in the response matching the given query. * @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; /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listTransportationOptions * @param {string} inboundPlanId Identifier of an inbound plan. * @param {number} [pageSize] The number of transportation options to return in the response matching the given query. * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @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} */ listTransportationOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: any): AxiosPromise; /** * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary scheduleSelfShipAppointment * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {string} slotId An identifier to a self-ship appointment slot. * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ scheduleSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: any): AxiosPromise; /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPackingInformation * @param {string} inboundPlanId Identifier of an inbound plan. * @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPackingInformation(inboundPlanId: string, body: SetPackingInformationRequest, options?: any): AxiosPromise; /** * Set the preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPrepDetails * @param {SetPrepDetailsRequest} body The body of the request to `setPrepDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPrepDetails(body: SetPrepDetailsRequest, options?: any): AxiosPromise; /** * Updates the name of an existing inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateInboundPlanName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInboundPlanName(inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: any): AxiosPromise; /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateItemComplianceDetails * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateItemComplianceDetails(marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: any): AxiosPromise; /** * Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentName * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentName(inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: any): AxiosPromise; /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentSourceAddress * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentSourceAddress(inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: any): AxiosPromise; /** * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentTrackingDetails * @param {string} inboundPlanId Identifier of an inbound plan. * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateShipmentTrackingDetails(inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: any): AxiosPromise; }; /** * Request parameters for cancelInboundPlan operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiCancelInboundPlanRequest */ export interface FulfillmentInboundApiCancelInboundPlanRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiCancelInboundPlan */ readonly inboundPlanId: string; } /** * Request parameters for cancelSelfShipAppointment operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiCancelSelfShipAppointmentRequest */ export interface FulfillmentInboundApiCancelSelfShipAppointmentRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiCancelSelfShipAppointment */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiCancelSelfShipAppointment */ readonly shipmentId: string; /** * The body of the request to `cancelSelfShipAppointment`. * @type {CancelSelfShipAppointmentRequest} * @memberof FulfillmentInboundApiCancelSelfShipAppointment */ readonly body: CancelSelfShipAppointmentRequest; } /** * Request parameters for confirmDeliveryWindowOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest */ export interface FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiConfirmDeliveryWindowOptions */ readonly inboundPlanId: string; /** * The shipment to confirm the delivery window option for. * @type {string} * @memberof FulfillmentInboundApiConfirmDeliveryWindowOptions */ readonly shipmentId: string; /** * The id of the delivery window option to be confirmed. * @type {string} * @memberof FulfillmentInboundApiConfirmDeliveryWindowOptions */ readonly deliveryWindowOptionId: string; } /** * Request parameters for confirmPackingOption operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiConfirmPackingOptionRequest */ export interface FulfillmentInboundApiConfirmPackingOptionRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiConfirmPackingOption */ readonly inboundPlanId: string; /** * Identifier of a packing option. * @type {string} * @memberof FulfillmentInboundApiConfirmPackingOption */ readonly packingOptionId: string; } /** * Request parameters for confirmPlacementOption operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiConfirmPlacementOptionRequest */ export interface FulfillmentInboundApiConfirmPlacementOptionRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiConfirmPlacementOption */ readonly inboundPlanId: string; /** * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. * @type {string} * @memberof FulfillmentInboundApiConfirmPlacementOption */ readonly placementOptionId: string; } /** * Request parameters for confirmShipmentContentUpdatePreview operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest */ export interface FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiConfirmShipmentContentUpdatePreview */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiConfirmShipmentContentUpdatePreview */ readonly shipmentId: string; /** * Identifier of a content update preview. * @type {string} * @memberof FulfillmentInboundApiConfirmShipmentContentUpdatePreview */ readonly contentUpdatePreviewId: string; } /** * Request parameters for confirmTransportationOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiConfirmTransportationOptionsRequest */ export interface FulfillmentInboundApiConfirmTransportationOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiConfirmTransportationOptions */ readonly inboundPlanId: string; /** * The body of the request to `confirmTransportationOptions`. * @type {ConfirmTransportationOptionsRequest} * @memberof FulfillmentInboundApiConfirmTransportationOptions */ readonly body: ConfirmTransportationOptionsRequest; } /** * Request parameters for createInboundPlan operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiCreateInboundPlanRequest */ export interface FulfillmentInboundApiCreateInboundPlanRequest { /** * The body of the request to `createInboundPlan`. * @type {CreateInboundPlanRequest} * @memberof FulfillmentInboundApiCreateInboundPlan */ readonly body: CreateInboundPlanRequest; } /** * Request parameters for createMarketplaceItemLabels operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiCreateMarketplaceItemLabelsRequest */ export interface FulfillmentInboundApiCreateMarketplaceItemLabelsRequest { /** * The body of the request to `createMarketplaceItemLabels`. * @type {CreateMarketplaceItemLabelsRequest} * @memberof FulfillmentInboundApiCreateMarketplaceItemLabels */ readonly body: CreateMarketplaceItemLabelsRequest; } /** * Request parameters for generateDeliveryWindowOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest */ export interface FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGenerateDeliveryWindowOptions */ readonly inboundPlanId: string; /** * The shipment to generate delivery window options for. * @type {string} * @memberof FulfillmentInboundApiGenerateDeliveryWindowOptions */ readonly shipmentId: string; } /** * Request parameters for generatePackingOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGeneratePackingOptionsRequest */ export interface FulfillmentInboundApiGeneratePackingOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGeneratePackingOptions */ readonly inboundPlanId: string; } /** * Request parameters for generatePlacementOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGeneratePlacementOptionsRequest */ export interface FulfillmentInboundApiGeneratePlacementOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGeneratePlacementOptions */ readonly inboundPlanId: string; /** * The body of the request to `generatePlacementOptions`. * @type {GeneratePlacementOptionsRequest} * @memberof FulfillmentInboundApiGeneratePlacementOptions */ readonly body: GeneratePlacementOptionsRequest; } /** * Request parameters for generateSelfShipAppointmentSlots operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest */ export interface FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGenerateSelfShipAppointmentSlots */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiGenerateSelfShipAppointmentSlots */ readonly shipmentId: string; /** * The body of the request to `generateSelfShipAppointmentSlots`. * @type {GenerateSelfShipAppointmentSlotsRequest} * @memberof FulfillmentInboundApiGenerateSelfShipAppointmentSlots */ readonly body: GenerateSelfShipAppointmentSlotsRequest; } /** * Request parameters for generateShipmentContentUpdatePreviews operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest */ export interface FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGenerateShipmentContentUpdatePreviews */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiGenerateShipmentContentUpdatePreviews */ readonly shipmentId: string; /** * The body of the request to `generateShipmentContentUpdatePreviews`. * @type {GenerateShipmentContentUpdatePreviewsRequest} * @memberof FulfillmentInboundApiGenerateShipmentContentUpdatePreviews */ readonly body: GenerateShipmentContentUpdatePreviewsRequest; } /** * Request parameters for generateTransportationOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGenerateTransportationOptionsRequest */ export interface FulfillmentInboundApiGenerateTransportationOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGenerateTransportationOptions */ readonly inboundPlanId: string; /** * The body of the request to `generateTransportationOptions`. * @type {GenerateTransportationOptionsRequest} * @memberof FulfillmentInboundApiGenerateTransportationOptions */ readonly body: GenerateTransportationOptionsRequest; } /** * Request parameters for getDeliveryChallanDocument operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGetDeliveryChallanDocumentRequest */ export interface FulfillmentInboundApiGetDeliveryChallanDocumentRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGetDeliveryChallanDocument */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiGetDeliveryChallanDocument */ readonly shipmentId: string; } /** * Request parameters for getInboundOperationStatus operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGetInboundOperationStatusRequest */ export interface FulfillmentInboundApiGetInboundOperationStatusRequest { /** * Identifier of an asynchronous operation. * @type {string} * @memberof FulfillmentInboundApiGetInboundOperationStatus */ readonly operationId: string; } /** * Request parameters for getInboundPlan operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGetInboundPlanRequest */ export interface FulfillmentInboundApiGetInboundPlanRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGetInboundPlan */ readonly inboundPlanId: string; } /** * Request parameters for getSelfShipAppointmentSlots operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest */ export interface FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly shipmentId: string; /** * The number of self ship appointment slots to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiGetSelfShipAppointmentSlots */ readonly paginationToken?: string; } /** * Request parameters for getShipment operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGetShipmentRequest */ export interface FulfillmentInboundApiGetShipmentRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGetShipment */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiGetShipment */ readonly shipmentId: string; } /** * Request parameters for getShipmentContentUpdatePreview operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest */ export interface FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiGetShipmentContentUpdatePreview */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiGetShipmentContentUpdatePreview */ readonly shipmentId: string; /** * Identifier of a content update preview. * @type {string} * @memberof FulfillmentInboundApiGetShipmentContentUpdatePreview */ readonly contentUpdatePreviewId: string; } /** * Request parameters for listDeliveryWindowOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListDeliveryWindowOptionsRequest */ export interface FulfillmentInboundApiListDeliveryWindowOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly inboundPlanId: string; /** * The shipment to get delivery window options for. * @type {string} * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly shipmentId: string; /** * The number of delivery window options to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListDeliveryWindowOptions */ readonly paginationToken?: string; } /** * Request parameters for listInboundPlanBoxes operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListInboundPlanBoxesRequest */ export interface FulfillmentInboundApiListInboundPlanBoxesRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListInboundPlanBoxes */ readonly inboundPlanId: string; /** * The number of boxes to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListInboundPlanBoxes */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListInboundPlanBoxes */ readonly paginationToken?: string; } /** * Request parameters for listInboundPlanItems operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListInboundPlanItemsRequest */ export interface FulfillmentInboundApiListInboundPlanItemsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListInboundPlanItems */ readonly inboundPlanId: string; /** * The number of items to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListInboundPlanItems */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListInboundPlanItems */ readonly paginationToken?: string; } /** * Request parameters for listInboundPlanPallets operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListInboundPlanPalletsRequest */ export interface FulfillmentInboundApiListInboundPlanPalletsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListInboundPlanPallets */ readonly inboundPlanId: string; /** * The number of pallets to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListInboundPlanPallets */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListInboundPlanPallets */ readonly paginationToken?: string; } /** * Request parameters for listInboundPlans operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListInboundPlansRequest */ export interface FulfillmentInboundApiListInboundPlansRequest { /** * The number of inbound plans to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListInboundPlans */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListInboundPlans */ readonly paginationToken?: string; /** * The status of an inbound plan. * @type {'ACTIVE' | 'VOIDED' | 'SHIPPED'} * @memberof FulfillmentInboundApiListInboundPlans */ readonly status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED'; /** * Sort by field. * @type {'LAST_UPDATED_TIME' | 'CREATION_TIME'} * @memberof FulfillmentInboundApiListInboundPlans */ readonly sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME'; /** * The sort order. * @type {'ASC' | 'DESC'} * @memberof FulfillmentInboundApiListInboundPlans */ readonly sortOrder?: 'ASC' | 'DESC'; } /** * Request parameters for listItemComplianceDetails operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListItemComplianceDetailsRequest */ export interface FulfillmentInboundApiListItemComplianceDetailsRequest { /** * A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @type {Array} * @memberof FulfillmentInboundApiListItemComplianceDetails */ readonly mskus: Array; /** * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} * @memberof FulfillmentInboundApiListItemComplianceDetails */ readonly marketplaceId: string; } /** * Request parameters for listPackingGroupBoxes operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListPackingGroupBoxesRequest */ export interface FulfillmentInboundApiListPackingGroupBoxesRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly inboundPlanId: string; /** * Identifier of a packing group. * @type {string} * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly packingGroupId: string; /** * The number of packing group boxes to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListPackingGroupBoxes */ readonly paginationToken?: string; } /** * Request parameters for listPackingGroupItems operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListPackingGroupItemsRequest */ export interface FulfillmentInboundApiListPackingGroupItemsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly inboundPlanId: string; /** * Identifier of a packing group. * @type {string} * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly packingGroupId: string; /** * The number of packing group items to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListPackingGroupItems */ readonly paginationToken?: string; } /** * Request parameters for listPackingOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListPackingOptionsRequest */ export interface FulfillmentInboundApiListPackingOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListPackingOptions */ readonly inboundPlanId: string; /** * The number of packing options to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListPackingOptions */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListPackingOptions */ readonly paginationToken?: string; } /** * Request parameters for listPlacementOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListPlacementOptionsRequest */ export interface FulfillmentInboundApiListPlacementOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListPlacementOptions */ readonly inboundPlanId: string; /** * The number of placement options to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListPlacementOptions */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListPlacementOptions */ readonly paginationToken?: string; } /** * Request parameters for listPrepDetails operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListPrepDetailsRequest */ export interface FulfillmentInboundApiListPrepDetailsRequest { /** * The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} * @memberof FulfillmentInboundApiListPrepDetails */ readonly marketplaceId: string; /** * A list of merchant SKUs, a merchant-supplied identifier of a specific SKU. * @type {Array} * @memberof FulfillmentInboundApiListPrepDetails */ readonly mskus: Array; } /** * Request parameters for listShipmentBoxes operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListShipmentBoxesRequest */ export interface FulfillmentInboundApiListShipmentBoxesRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly shipmentId: string; /** * The number of boxes to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListShipmentBoxes */ readonly paginationToken?: string; } /** * Request parameters for listShipmentContentUpdatePreviews operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest */ export interface FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly shipmentId: string; /** * The number of content update previews to return. * @type {number} * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListShipmentContentUpdatePreviews */ readonly paginationToken?: string; } /** * Request parameters for listShipmentItems operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListShipmentItemsRequest */ export interface FulfillmentInboundApiListShipmentItemsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListShipmentItems */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiListShipmentItems */ readonly shipmentId: string; /** * The number of items to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListShipmentItems */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListShipmentItems */ readonly paginationToken?: string; } /** * Request parameters for listShipmentPallets operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListShipmentPalletsRequest */ export interface FulfillmentInboundApiListShipmentPalletsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListShipmentPallets */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiListShipmentPallets */ readonly shipmentId: string; /** * The number of pallets to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListShipmentPallets */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListShipmentPallets */ readonly paginationToken?: string; } /** * Request parameters for listTransportationOptions operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiListTransportationOptionsRequest */ export interface FulfillmentInboundApiListTransportationOptionsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiListTransportationOptions */ readonly inboundPlanId: string; /** * The number of transportation options to return in the response matching the given query. * @type {number} * @memberof FulfillmentInboundApiListTransportationOptions */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result. * @type {string} * @memberof FulfillmentInboundApiListTransportationOptions */ readonly paginationToken?: string; /** * The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @type {string} * @memberof FulfillmentInboundApiListTransportationOptions */ readonly placementOptionId?: string; /** * The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified. * @type {string} * @memberof FulfillmentInboundApiListTransportationOptions */ readonly shipmentId?: string; } /** * Request parameters for scheduleSelfShipAppointment operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiScheduleSelfShipAppointmentRequest */ export interface FulfillmentInboundApiScheduleSelfShipAppointmentRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly shipmentId: string; /** * An identifier to a self-ship appointment slot. * @type {string} * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly slotId: string; /** * The body of the request to `scheduleSelfShipAppointment`. * @type {ScheduleSelfShipAppointmentRequest} * @memberof FulfillmentInboundApiScheduleSelfShipAppointment */ readonly body: ScheduleSelfShipAppointmentRequest; } /** * Request parameters for setPackingInformation operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiSetPackingInformationRequest */ export interface FulfillmentInboundApiSetPackingInformationRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiSetPackingInformation */ readonly inboundPlanId: string; /** * The body of the request to `setPackingInformation`. * @type {SetPackingInformationRequest} * @memberof FulfillmentInboundApiSetPackingInformation */ readonly body: SetPackingInformationRequest; } /** * Request parameters for setPrepDetails operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiSetPrepDetailsRequest */ export interface FulfillmentInboundApiSetPrepDetailsRequest { /** * The body of the request to `setPrepDetails`. * @type {SetPrepDetailsRequest} * @memberof FulfillmentInboundApiSetPrepDetails */ readonly body: SetPrepDetailsRequest; } /** * Request parameters for updateInboundPlanName operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiUpdateInboundPlanNameRequest */ export interface FulfillmentInboundApiUpdateInboundPlanNameRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiUpdateInboundPlanName */ readonly inboundPlanId: string; /** * The body of the request to `updateInboundPlanName`. * @type {UpdateInboundPlanNameRequest} * @memberof FulfillmentInboundApiUpdateInboundPlanName */ readonly body: UpdateInboundPlanNameRequest; } /** * Request parameters for updateItemComplianceDetails operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiUpdateItemComplianceDetailsRequest */ export interface FulfillmentInboundApiUpdateItemComplianceDetailsRequest { /** * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @type {string} * @memberof FulfillmentInboundApiUpdateItemComplianceDetails */ readonly marketplaceId: string; /** * The body of the request to `updateItemComplianceDetails`. * @type {UpdateItemComplianceDetailsRequest} * @memberof FulfillmentInboundApiUpdateItemComplianceDetails */ readonly body: UpdateItemComplianceDetailsRequest; } /** * Request parameters for updateShipmentName operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiUpdateShipmentNameRequest */ export interface FulfillmentInboundApiUpdateShipmentNameRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiUpdateShipmentName */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiUpdateShipmentName */ readonly shipmentId: string; /** * The body of the request to `updateShipmentName`. * @type {UpdateShipmentNameRequest} * @memberof FulfillmentInboundApiUpdateShipmentName */ readonly body: UpdateShipmentNameRequest; } /** * Request parameters for updateShipmentSourceAddress operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiUpdateShipmentSourceAddressRequest */ export interface FulfillmentInboundApiUpdateShipmentSourceAddressRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiUpdateShipmentSourceAddress */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiUpdateShipmentSourceAddress */ readonly shipmentId: string; /** * The body of the request to `updateShipmentSourceAddress`. * @type {UpdateShipmentSourceAddressRequest} * @memberof FulfillmentInboundApiUpdateShipmentSourceAddress */ readonly body: UpdateShipmentSourceAddressRequest; } /** * Request parameters for updateShipmentTrackingDetails operation in FulfillmentInboundApi. * @export * @interface FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest */ export interface FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest { /** * Identifier of an inbound plan. * @type {string} * @memberof FulfillmentInboundApiUpdateShipmentTrackingDetails */ readonly inboundPlanId: string; /** * Identifier of a shipment. A shipment contains the boxes and units being inbounded. * @type {string} * @memberof FulfillmentInboundApiUpdateShipmentTrackingDetails */ readonly shipmentId: string; /** * The body of the request to `updateShipmentTrackingDetails`. * @type {UpdateShipmentTrackingDetailsRequest} * @memberof FulfillmentInboundApiUpdateShipmentTrackingDetails */ readonly body: UpdateShipmentTrackingDetailsRequest; } /** * FulfillmentInboundApi - object-oriented interface * @export * @class FulfillmentInboundApi * @extends {BaseAPI} */ export declare class FulfillmentInboundApi extends BaseAPI { /** * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelInboundPlan * @param {FulfillmentInboundApiCancelInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ cancelInboundPlan(requestParameters: FulfillmentInboundApiCancelInboundPlanRequest, options?: any): Promise>; /** * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary cancelSelfShipAppointment * @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ cancelSelfShipAppointment(requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest, options?: any): Promise>; /** * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmDeliveryWindowOptions * @param {FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ confirmDeliveryWindowOptions(requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest, options?: any): Promise>; /** * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPackingOption * @param {FulfillmentInboundApiConfirmPackingOptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ confirmPackingOption(requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest, options?: any): Promise>; /** * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmPlacementOption * @param {FulfillmentInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ confirmPlacementOption(requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest, options?: any): Promise>; /** * Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmShipmentContentUpdatePreview * @param {FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ confirmShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest, options?: any): Promise>; /** * Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary confirmTransportationOptions * @param {FulfillmentInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ confirmTransportationOptions(requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest, options?: any): Promise>; /** * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createInboundPlan * @param {FulfillmentInboundApiCreateInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ createInboundPlan(requestParameters: FulfillmentInboundApiCreateInboundPlanRequest, options?: any): Promise>; /** * For a given marketplace - creates labels for a list of MSKUs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createMarketplaceItemLabels * @param {FulfillmentInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ createMarketplaceItemLabels(requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest, options?: any): Promise>; /** * Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateDeliveryWindowOptions * @param {FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ generateDeliveryWindowOptions(requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest, options?: any): Promise>; /** * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePackingOptions * @param {FulfillmentInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ generatePackingOptions(requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest, options?: any): Promise>; /** * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generatePlacementOptions * @param {FulfillmentInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ generatePlacementOptions(requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest, options?: any): Promise>; /** * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateSelfShipAppointmentSlots * @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ generateSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: any): Promise>; /** * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateShipmentContentUpdatePreviews * @param {FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ generateShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest, options?: any): Promise>; /** * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary generateTransportationOptions * @param {FulfillmentInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ generateTransportationOptions(requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest, options?: any): Promise>; /** * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getDeliveryChallanDocument * @param {FulfillmentInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ getDeliveryChallanDocument(requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest, options?: any): Promise>; /** * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundOperationStatus * @param {FulfillmentInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ getInboundOperationStatus(requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest, options?: any): Promise>; /** * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getInboundPlan * @param {FulfillmentInboundApiGetInboundPlanRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ getInboundPlan(requestParameters: FulfillmentInboundApiGetInboundPlanRequest, options?: any): Promise>; /** * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getSelfShipAppointmentSlots * @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ getSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest, options?: any): Promise>; /** * Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipment * @param {FulfillmentInboundApiGetShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ getShipment(requestParameters: FulfillmentInboundApiGetShipmentRequest, options?: any): Promise>; /** * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary getShipmentContentUpdatePreview * @param {FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ getShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest, options?: any): Promise>; /** * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listDeliveryWindowOptions * @param {FulfillmentInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listDeliveryWindowOptions(requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest, options?: any): Promise>; /** * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanBoxes * @param {FulfillmentInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listInboundPlanBoxes(requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest, options?: any): Promise>; /** * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanItems * @param {FulfillmentInboundApiListInboundPlanItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listInboundPlanItems(requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest, options?: any): Promise>; /** * Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlanPallets * @param {FulfillmentInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listInboundPlanPallets(requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest, options?: any): Promise>; /** * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listInboundPlans * @param {FulfillmentInboundApiListInboundPlansRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listInboundPlans(requestParameters?: FulfillmentInboundApiListInboundPlansRequest, options?: any): Promise>; /** * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listItemComplianceDetails * @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listItemComplianceDetails(requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest, options?: any): Promise>; /** * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupBoxes * @param {FulfillmentInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listPackingGroupBoxes(requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest, options?: any): Promise>; /** * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingGroupItems * @param {FulfillmentInboundApiListPackingGroupItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listPackingGroupItems(requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest, options?: any): Promise>; /** * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPackingOptions * @param {FulfillmentInboundApiListPackingOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listPackingOptions(requestParameters: FulfillmentInboundApiListPackingOptionsRequest, options?: any): Promise>; /** * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPlacementOptions * @param {FulfillmentInboundApiListPlacementOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listPlacementOptions(requestParameters: FulfillmentInboundApiListPlacementOptionsRequest, options?: any): Promise>; /** * Get preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listPrepDetails * @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listPrepDetails(requestParameters: FulfillmentInboundApiListPrepDetailsRequest, options?: any): Promise>; /** * Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentBoxes * @param {FulfillmentInboundApiListShipmentBoxesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listShipmentBoxes(requestParameters: FulfillmentInboundApiListShipmentBoxesRequest, options?: any): Promise>; /** * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentContentUpdatePreviews * @param {FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest, options?: any): Promise>; /** * Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentItems * @param {FulfillmentInboundApiListShipmentItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listShipmentItems(requestParameters: FulfillmentInboundApiListShipmentItemsRequest, options?: any): Promise>; /** * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listShipmentPallets * @param {FulfillmentInboundApiListShipmentPalletsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listShipmentPallets(requestParameters: FulfillmentInboundApiListShipmentPalletsRequest, options?: any): Promise>; /** * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary listTransportationOptions * @param {FulfillmentInboundApiListTransportationOptionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ listTransportationOptions(requestParameters: FulfillmentInboundApiListTransportationOptionsRequest, options?: any): Promise>; /** * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary scheduleSelfShipAppointment * @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ scheduleSelfShipAppointment(requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest, options?: any): Promise>; /** * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPackingInformation * @param {FulfillmentInboundApiSetPackingInformationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ setPackingInformation(requestParameters: FulfillmentInboundApiSetPackingInformationRequest, options?: any): Promise>; /** * Set the preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary setPrepDetails * @param {FulfillmentInboundApiSetPrepDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ setPrepDetails(requestParameters: FulfillmentInboundApiSetPrepDetailsRequest, options?: any): Promise>; /** * Updates the name of an existing inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateInboundPlanName * @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ updateInboundPlanName(requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest, options?: any): Promise>; /** * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateItemComplianceDetails * @param {FulfillmentInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ updateItemComplianceDetails(requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest, options?: any): Promise>; /** * Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentName * @param {FulfillmentInboundApiUpdateShipmentNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ updateShipmentName(requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest, options?: any): Promise>; /** * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentSourceAddress * @param {FulfillmentInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ updateShipmentSourceAddress(requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest, options?: any): Promise>; /** * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary updateShipmentTrackingDetails * @param {FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FulfillmentInboundApi */ updateShipmentTrackingDetails(requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest, options?: any): Promise>; }