@sp-api-sdk/fulfillment-inbound-api-2024-03-20
Version:
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 inte
365 lines • 279 kB
TypeScript
/**
* The Selling Partner API for FBA inbound operations.
* 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 type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { CancelInboundPlanResponse } from '../models';
import type { CancelSelfShipAppointmentRequest } from '../models';
import type { CancelSelfShipAppointmentResponse } from '../models';
import type { ConfirmDeliveryWindowOptionsResponse } from '../models';
import type { ConfirmPackingOptionResponse } from '../models';
import type { ConfirmPlacementOptionResponse } from '../models';
import type { ConfirmShipmentContentUpdatePreviewResponse } from '../models';
import type { ConfirmTransportationOptionsRequest } from '../models';
import type { ConfirmTransportationOptionsResponse } from '../models';
import type { ContentUpdatePreview } from '../models';
import type { CreateInboundPlanRequest } from '../models';
import type { CreateInboundPlanResponse } from '../models';
import type { CreateMarketplaceItemLabelsRequest } from '../models';
import type { CreateMarketplaceItemLabelsResponse } from '../models';
import type { GenerateDeliveryWindowOptionsResponse } from '../models';
import type { GeneratePackingOptionsResponse } from '../models';
import type { GeneratePlacementOptionsRequest } from '../models';
import type { GeneratePlacementOptionsResponse } from '../models';
import type { GenerateSelfShipAppointmentSlotsRequest } from '../models';
import type { GenerateSelfShipAppointmentSlotsResponse } from '../models';
import type { GenerateShipmentContentUpdatePreviewsRequest } from '../models';
import type { GenerateShipmentContentUpdatePreviewsResponse } from '../models';
import type { GenerateTransportationOptionsRequest } from '../models';
import type { GenerateTransportationOptionsResponse } from '../models';
import type { GetDeliveryChallanDocumentResponse } from '../models';
import type { GetSelfShipAppointmentSlotsResponse } from '../models';
import type { InboundOperationStatus } from '../models';
import type { InboundPlan } from '../models';
import type { ListDeliveryWindowOptionsResponse } from '../models';
import type { ListInboundPlanBoxesResponse } from '../models';
import type { ListInboundPlanItemsResponse } from '../models';
import type { ListInboundPlanPalletsResponse } from '../models';
import type { ListInboundPlansResponse } from '../models';
import type { ListItemComplianceDetailsResponse } from '../models';
import type { ListPackingGroupBoxesResponse } from '../models';
import type { ListPackingGroupItemsResponse } from '../models';
import type { ListPackingOptionsResponse } from '../models';
import type { ListPlacementOptionsResponse } from '../models';
import type { ListPrepDetailsResponse } from '../models';
import type { ListShipmentBoxesResponse } from '../models';
import type { ListShipmentContentUpdatePreviewsResponse } from '../models';
import type { ListShipmentItemsResponse } from '../models';
import type { ListShipmentPalletsResponse } from '../models';
import type { ListTransportationOptionsResponse } from '../models';
import type { ScheduleSelfShipAppointmentRequest } from '../models';
import type { ScheduleSelfShipAppointmentResponse } from '../models';
import type { SetPackingInformationRequest } from '../models';
import type { SetPackingInformationResponse } from '../models';
import type { SetPrepDetailsRequest } from '../models';
import type { SetPrepDetailsResponse } from '../models';
import type { Shipment } from '../models';
import type { UpdateInboundPlanNameRequest } from '../models';
import type { UpdateItemComplianceDetailsRequest } from '../models';
import type { UpdateItemComplianceDetailsResponse } from '../models';
import type { UpdateShipmentNameRequest } from '../models';
import type { UpdateShipmentSourceAddressRequest } from '../models';
import type { UpdateShipmentSourceAddressResponse } from '../models';
import type { UpdateShipmentTrackingDetailsRequest } from '../models';
import type { UpdateShipmentTrackingDetailsResponse } from '../models';
/**
* 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).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelInboundPlan: (inboundPlanId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelSelfShipAppointment: (inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createInboundPlan: (body: CreateInboundPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* For a given marketplace - creates labels for a list of MSKUs. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createMarketplaceItemLabels: (body: CreateMarketplaceItemLabelsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
generatePackingOptions: (inboundPlanId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
generateSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} operationId Identifier of an asynchronous operation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInboundOperationStatus: (operationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInboundPlan: (inboundPlanId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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 {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
* @param {ListInboundPlansSortByEnum} [sortBy] Sort by field.
* @param {ListInboundPlansSortOrderEnum} [sortOrder] The sort order.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listInboundPlans: (pageSize?: number, paginationToken?: string, status?: ListInboundPlansStatusEnum, sortBy?: ListInboundPlansSortByEnum, sortOrder?: ListInboundPlansSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {Array<string>} 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<string>, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get preparation details for a list of MSKUs in a specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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<string>} 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<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} inboundPlanId Identifier of an inbound plan.
* @param {