Function FulfillmentInboundApiFp

Returns {
    cancelInboundPlan(
        inboundPlanId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelInboundPlanResponse>,
    >;
    cancelSelfShipAppointment(
        inboundPlanId: string,
        shipmentId: string,
        body: CancelSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelSelfShipAppointmentResponse>,
    >;
    confirmDeliveryWindowOptions(
        inboundPlanId: string,
        shipmentId: string,
        deliveryWindowOptionId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmDeliveryWindowOptionsResponse>,
    >;
    confirmPackingOption(
        inboundPlanId: string,
        packingOptionId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmPackingOptionResponse>,
    >;
    confirmPlacementOption(
        inboundPlanId: string,
        placementOptionId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmPlacementOptionResponse>,
    >;
    confirmShipmentContentUpdatePreview(
        inboundPlanId: string,
        shipmentId: string,
        contentUpdatePreviewId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>,
    >;
    confirmTransportationOptions(
        inboundPlanId: string,
        body: ConfirmTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmTransportationOptionsResponse>,
    >;
    createInboundPlan(
        body: CreateInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateInboundPlanResponse>,
    >;
    createMarketplaceItemLabels(
        body: CreateMarketplaceItemLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateMarketplaceItemLabelsResponse>,
    >;
    generateDeliveryWindowOptions(
        inboundPlanId: string,
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateDeliveryWindowOptionsResponse>,
    >;
    generatePackingOptions(
        inboundPlanId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GeneratePackingOptionsResponse>,
    >;
    generatePlacementOptions(
        inboundPlanId: string,
        body: GeneratePlacementOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GeneratePlacementOptionsResponse>,
    >;
    generateSelfShipAppointmentSlots(
        inboundPlanId: string,
        shipmentId: string,
        body: GenerateSelfShipAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>,
    >;
    generateShipmentContentUpdatePreviews(
        inboundPlanId: string,
        shipmentId: string,
        body: GenerateShipmentContentUpdatePreviewsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>,
    >;
    generateTransportationOptions(
        inboundPlanId: string,
        body: GenerateTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateTransportationOptionsResponse>,
    >;
    getDeliveryChallanDocument(
        inboundPlanId: string,
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetDeliveryChallanDocumentResponse>,
    >;
    getInboundOperationStatus(
        operationId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundOperationStatus>,
    >;
    getInboundPlan(
        inboundPlanId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundPlan>,
    >;
    getSelfShipAppointmentSlots(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSelfShipAppointmentSlotsResponse>,
    >;
    getShipment(
        inboundPlanId: string,
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>,
    >;
    getShipmentContentUpdatePreview(
        inboundPlanId: string,
        shipmentId: string,
        contentUpdatePreviewId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ContentUpdatePreview>,
    >;
    listDeliveryWindowOptions(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListDeliveryWindowOptionsResponse>,
    >;
    listInboundPlanBoxes(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanBoxesResponse>,
    >;
    listInboundPlanItems(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanItemsResponse>,
    >;
    listInboundPlanPallets(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanPalletsResponse>,
    >;
    listInboundPlans(
        pageSize?: number,
        paginationToken?: string,
        status?: ListInboundPlansStatusEnum,
        sortBy?: ListInboundPlansSortByEnum,
        sortOrder?: ListInboundPlansSortOrderEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlansResponse>,
    >;
    listItemComplianceDetails(
        mskus: string[],
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListItemComplianceDetailsResponse>,
    >;
    listPackingGroupBoxes(
        inboundPlanId: string,
        packingGroupId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingGroupBoxesResponse>,
    >;
    listPackingGroupItems(
        inboundPlanId: string,
        packingGroupId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingGroupItemsResponse>,
    >;
    listPackingOptions(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingOptionsResponse>,
    >;
    listPlacementOptions(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPlacementOptionsResponse>,
    >;
    listPrepDetails(
        marketplaceId: string,
        mskus: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPrepDetailsResponse>,
    >;
    listShipmentBoxes(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentBoxesResponse>,
    >;
    listShipmentContentUpdatePreviews(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentContentUpdatePreviewsResponse>,
    >;
    listShipmentItems(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentItemsResponse>,
    >;
    listShipmentPallets(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentPalletsResponse>,
    >;
    listTransportationOptions(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        placementOptionId?: string,
        shipmentId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListTransportationOptionsResponse>,
    >;
    scheduleSelfShipAppointment(
        inboundPlanId: string,
        shipmentId: string,
        slotId: string,
        body: ScheduleSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ScheduleSelfShipAppointmentResponse>,
    >;
    setPackingInformation(
        inboundPlanId: string,
        body: SetPackingInformationRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SetPackingInformationResponse>,
    >;
    setPrepDetails(
        body: SetPrepDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SetPrepDetailsResponse>,
    >;
    updateInboundPlanName(
        inboundPlanId: string,
        body: UpdateInboundPlanNameRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateItemComplianceDetails(
        marketplaceId: string,
        body: UpdateItemComplianceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateItemComplianceDetailsResponse>,
    >;
    updateShipmentName(
        inboundPlanId: string,
        shipmentId: string,
        body: UpdateShipmentNameRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateShipmentSourceAddress(
        inboundPlanId: string,
        shipmentId: string,
        body: UpdateShipmentSourceAddressRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateShipmentSourceAddressResponse>,
    >;
    updateShipmentTrackingDetails(
        inboundPlanId: string,
        shipmentId: string,
        body: UpdateShipmentTrackingDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateShipmentTrackingDetailsResponse>,
    >;
}

• cancelInboundPlan: function

  • cancelInboundPlan(
        inboundPlanId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelInboundPlanResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelInboundPlanResponse>,
    >

    Throws

• cancelSelfShipAppointment: function

  • cancelSelfShipAppointment(
        inboundPlanId: string,
        shipmentId: string,
        body: CancelSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelSelfShipAppointmentResponse>,
    >

    Cancels a self-ship appointment slot against a shipment. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • body: CancelSelfShipAppointmentRequest

      The body of the request to `cancelSelfShipAppointment`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelSelfShipAppointmentResponse>,
    >

    Throws

• confirmDeliveryWindowOptions: function

  • confirmDeliveryWindowOptions(
        inboundPlanId: string,
        shipmentId: string,
        deliveryWindowOptionId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmDeliveryWindowOptionsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      The shipment to confirm the delivery window option for.

    • deliveryWindowOptionId: string

      The id of the delivery window option to be confirmed.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmDeliveryWindowOptionsResponse>,
    >

    Throws

• confirmPackingOption: function

  • confirmPackingOption(
        inboundPlanId: string,
        packingOptionId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmPackingOptionResponse>,
    >

    Confirms the packing option for an inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • packingOptionId: string

      Identifier of a packing option.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmPackingOptionResponse>,
    >

    Throws

• confirmPlacementOption: function

  • confirmPlacementOption(
        inboundPlanId: string,
        placementOptionId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmPlacementOptionResponse>,
    >

    Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • placementOptionId: string

      The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmPlacementOptionResponse>,
    >

    Throws

• confirmShipmentContentUpdatePreview: function

  • confirmShipmentContentUpdatePreview(
        inboundPlanId: string,
        shipmentId: string,
        contentUpdatePreviewId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>,
    >

    Confirm a shipment content update preview and accept the changes in transportation cost.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • contentUpdatePreviewId: string

      Identifier of a content update preview.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>,
    >

    Throws

• confirmTransportationOptions: function

  • confirmTransportationOptions(
        inboundPlanId: string,
        body: ConfirmTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmTransportationOptionsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • body: ConfirmTransportationOptionsRequest

      The body of the request to `confirmTransportationOptions`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConfirmTransportationOptionsResponse>,
    >

    Throws

• createInboundPlan: function

  • createInboundPlan(
        body: CreateInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateInboundPlanResponse>,
    >

    Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.

    Parameters

    • body: CreateInboundPlanRequest

      The body of the request to `createInboundPlan`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateInboundPlanResponse>,
    >

    Throws

• createMarketplaceItemLabels: function

  • createMarketplaceItemLabels(
        body: CreateMarketplaceItemLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateMarketplaceItemLabelsResponse>,
    >

    For a given marketplace - creates labels for a list of MSKUs.

    Parameters

    • body: CreateMarketplaceItemLabelsRequest

      The body of the request to `createMarketplaceItemLabels`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateMarketplaceItemLabelsResponse>,
    >

    Throws

• generateDeliveryWindowOptions: function

  • generateDeliveryWindowOptions(
        inboundPlanId: string,
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateDeliveryWindowOptionsResponse>,
    >

    Generates available delivery window options for a given shipment.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      The shipment to generate delivery window options for.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateDeliveryWindowOptionsResponse>,
    >

    Throws

• generatePackingOptions: function

  • generatePackingOptions(
        inboundPlanId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GeneratePackingOptionsResponse>,
    >

    Generates available packing options for the inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GeneratePackingOptionsResponse>,
    >

    Throws

• generatePlacementOptions: function

  • generatePlacementOptions(
        inboundPlanId: string,
        body: GeneratePlacementOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GeneratePlacementOptionsResponse>,
    >

    Generates placement options for the inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • body: GeneratePlacementOptionsRequest

      The body of the request to `generatePlacementOptions`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GeneratePlacementOptionsResponse>,
    >

    Throws

• generateSelfShipAppointmentSlots: function

  • generateSelfShipAppointmentSlots(
        inboundPlanId: string,
        shipmentId: string,
        body: GenerateSelfShipAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>,
    >

    Initiates the process of generating the appointment slots list. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • body: GenerateSelfShipAppointmentSlotsRequest

      The body of the request to `generateSelfShipAppointmentSlots`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>,
    >

    Throws

• generateShipmentContentUpdatePreviews: function

  • generateShipmentContentUpdatePreviews(
        inboundPlanId: string,
        shipmentId: string,
        body: GenerateShipmentContentUpdatePreviewsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • body: GenerateShipmentContentUpdatePreviewsRequest

      The body of the request to `generateShipmentContentUpdatePreviews`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>,
    >

    Throws

• generateTransportationOptions: function

  • generateTransportationOptions(
        inboundPlanId: string,
        body: GenerateTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateTransportationOptionsResponse>,
    >

    Generates available transportation options for a given placement option.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • body: GenerateTransportationOptionsRequest

      The body of the request to `generateTransportationOptions`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateTransportationOptionsResponse>,
    >

    Throws

• getDeliveryChallanDocument: function

  • getDeliveryChallanDocument(
        inboundPlanId: string,
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetDeliveryChallanDocumentResponse>,
    >

    Provide delivery challan document for PCP transportation in IN marketplace.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetDeliveryChallanDocumentResponse>,
    >

    Throws

• getInboundOperationStatus: function

  • getInboundOperationStatus(
        operationId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundOperationStatus>,
    >

    Gets the status of the processing of an asynchronous API call.

    Parameters

    • operationId: string

      Identifier of an asynchronous operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundOperationStatus>,
    >

    Throws

• getInboundPlan: function

  • getInboundPlan(
        inboundPlanId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundPlan>,
    >

    Fetches the top level information about an inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundPlan>>

    Throws

• getSelfShipAppointmentSlots: function

  • getSelfShipAppointmentSlots(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSelfShipAppointmentSlotsResponse>,
    >

    Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • OptionalpageSize: number

      The number of self ship appointment slots to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSelfShipAppointmentSlotsResponse>,
    >

    Throws

• getShipment: function

  • getShipment(
        inboundPlanId: string,
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>

    Throws

• getShipmentContentUpdatePreview: function

  • getShipmentContentUpdatePreview(
        inboundPlanId: string,
        shipmentId: string,
        contentUpdatePreviewId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ContentUpdatePreview>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • contentUpdatePreviewId: string

      Identifier of a content update preview.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ContentUpdatePreview>,
    >

    Throws

• listDeliveryWindowOptions: function

  • listDeliveryWindowOptions(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListDeliveryWindowOptionsResponse>,
    >

    Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      The shipment to get delivery window options for.

    • OptionalpageSize: number

      The number of delivery window options to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListDeliveryWindowOptionsResponse>,
    >

    Throws

• listInboundPlanBoxes: function

  • listInboundPlanBoxes(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanBoxesResponse>,
    >

    Provides a paginated list of box packages in an inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • OptionalpageSize: number

      The number of boxes to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanBoxesResponse>,
    >

    Throws

• listInboundPlanItems: function

  • listInboundPlanItems(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanItemsResponse>,
    >

    Provides a paginated list of item packages in an inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • OptionalpageSize: number

      The number of items to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanItemsResponse>,
    >

    Throws

• listInboundPlanPallets: function

  • listInboundPlanPallets(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanPalletsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • OptionalpageSize: number

      The number of pallets to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlanPalletsResponse>,
    >

    Throws

• listInboundPlans: function

  • listInboundPlans(
        pageSize?: number,
        paginationToken?: string,
        status?: ListInboundPlansStatusEnum,
        sortBy?: ListInboundPlansSortByEnum,
        sortOrder?: ListInboundPlansSortOrderEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlansResponse>,
    >

    Provides a list of inbound plans with minimal information.

    Parameters

    • OptionalpageSize: number

      The number of inbound plans to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionalstatus: ListInboundPlansStatusEnum

      The status of an inbound plan.

    • OptionalsortBy: ListInboundPlansSortByEnum

      Sort by field.

    • OptionalsortOrder: ListInboundPlansSortOrderEnum

      The sort order.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListInboundPlansResponse>,
    >

    Throws

• listItemComplianceDetails: function

  • listItemComplianceDetails(
        mskus: string[],
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListItemComplianceDetailsResponse>,
    >

    List the inbound compliance details for MSKUs in a given marketplace. Note: MSKUs that contain certain characters must be encoded. For more information, refer to URL Encoding. The following characters must be double percent encoded: - % - + - , Examples: An MSKU value of test%msku is encoded as test%2525msku. An MSKU value of test,msku is encoded as test%252Cmsku.

    Parameters

    • mskus: string[]

      A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.

    • marketplaceId: string

      The Marketplace ID. For a list of possible values, refer to Marketplace IDs.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListItemComplianceDetailsResponse>,
    >

    Throws

• listPackingGroupBoxes: function

  • listPackingGroupBoxes(
        inboundPlanId: string,
        packingGroupId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingGroupBoxesResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • packingGroupId: string

      Identifier of a packing group.

    • OptionalpageSize: number

      The number of packing group boxes to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingGroupBoxesResponse>,
    >

    Throws

• listPackingGroupItems: function

  • listPackingGroupItems(
        inboundPlanId: string,
        packingGroupId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingGroupItemsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • packingGroupId: string

      Identifier of a packing group.

    • OptionalpageSize: number

      The number of packing group items to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingGroupItemsResponse>,
    >

    Throws

• listPackingOptions: function

  • listPackingOptions(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingOptionsResponse>,
    >

    Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • OptionalpageSize: number

      The number of packing options to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPackingOptionsResponse>,
    >

    Throws

• listPlacementOptions: function

  • listPlacementOptions(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPlacementOptionsResponse>,
    >

    Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • OptionalpageSize: number

      The number of placement options to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPlacementOptionsResponse>,
    >

    Throws

• listPrepDetails: function

  • listPrepDetails(
        marketplaceId: string,
        mskus: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPrepDetailsResponse>,
    >

    Get preparation details for a list of MSKUs in a specified marketplace.\n\nNote: MSKUs that contain certain characters must be encoded. For more information, refer to URL Encoding.\n\nThe following characters must be double percent encoded:\n\n- %\n- +\n- ,\n\nExamples: An MSKU value of test%msku is encoded as test%2525msku. An MSKU value of test,msku is encoded as test%252Cmsku.

    Parameters

    • marketplaceId: string

      The marketplace ID. For a list of possible values, refer to Marketplace IDs.

    • mskus: string[]

      A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPrepDetailsResponse>,
    >

    Throws

• listShipmentBoxes: function

  • listShipmentBoxes(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentBoxesResponse>,
    >

    Provides a paginated list of box packages in a shipment.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • OptionalpageSize: number

      The number of boxes to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentBoxesResponse>,
    >

    Throws

• listShipmentContentUpdatePreviews: function

  • listShipmentContentUpdatePreviews(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentContentUpdatePreviewsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • OptionalpageSize: number

      The number of content update previews to return.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentContentUpdatePreviewsResponse>,
    >

    Throws

• listShipmentItems: function

  • listShipmentItems(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentItemsResponse>,
    >

    Provides a paginated list of item packages in a shipment.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • OptionalpageSize: number

      The number of items to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentItemsResponse>,
    >

    Throws

• listShipmentPallets: function

  • listShipmentPallets(
        inboundPlanId: string,
        shipmentId: string,
        pageSize?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentPalletsResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • OptionalpageSize: number

      The number of pallets to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListShipmentPalletsResponse>,
    >

    Throws

• listTransportationOptions: function

  • listTransportationOptions(
        inboundPlanId: string,
        pageSize?: number,
        paginationToken?: string,
        placementOptionId?: string,
        shipmentId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListTransportationOptionsResponse>,
    >

    Retrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions operation before becoming available.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • OptionalpageSize: number

      The number of transportation options to return in the response matching the given query.

    • OptionalpaginationToken: string

      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.

    • OptionalplacementOptionId: string

      The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.

    • OptionalshipmentId: string

      The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListTransportationOptionsResponse>,
    >

    Throws

• scheduleSelfShipAppointment: function

  • scheduleSelfShipAppointment(
        inboundPlanId: string,
        shipmentId: string,
        slotId: string,
        body: ScheduleSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ScheduleSelfShipAppointmentResponse>,
    >

    Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • slotId: string

      An identifier to a self-ship appointment slot.

    • body: ScheduleSelfShipAppointmentRequest

      The body of the request to `scheduleSelfShipAppointment`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ScheduleSelfShipAppointmentResponse>,
    >

    Throws

• setPackingInformation: function

  • setPackingInformation(
        inboundPlanId: string,
        body: SetPackingInformationRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SetPackingInformationResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • body: SetPackingInformationRequest

      The body of the request to `setPackingInformation`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SetPackingInformationResponse>,
    >

    Throws

• setPrepDetails: function

  • setPrepDetails(
        body: SetPrepDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SetPrepDetailsResponse>,
    >

    Set the preparation details for a list of MSKUs in a specified marketplace.

    Parameters

    • body: SetPrepDetailsRequest

      The body of the request to `setPrepDetails`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SetPrepDetailsResponse>,
    >

    Throws

• updateInboundPlanName: function

  • updateInboundPlanName(
        inboundPlanId: string,
        body: UpdateInboundPlanNameRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates the name of an existing inbound plan.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • body: UpdateInboundPlanNameRequest

      The body of the request to `updateInboundPlanName`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• updateItemComplianceDetails: function

  • updateItemComplianceDetails(
        marketplaceId: string,
        body: UpdateItemComplianceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateItemComplianceDetailsResponse>,
    >

    Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.

    Parameters

    • marketplaceId: string

      The Marketplace ID. For a list of possible values, refer to Marketplace IDs.

    • body: UpdateItemComplianceDetailsRequest

      The body of the request to `updateItemComplianceDetails`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateItemComplianceDetailsResponse>,
    >

    Throws

• updateShipmentName: function

  • updateShipmentName(
        inboundPlanId: string,
        shipmentId: string,
        body: UpdateShipmentNameRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates the name of an existing shipment.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • body: UpdateShipmentNameRequest

      The body of the request to `updateShipmentName`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• updateShipmentSourceAddress: function

  • updateShipmentSourceAddress(
        inboundPlanId: string,
        shipmentId: string,
        body: UpdateShipmentSourceAddressRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateShipmentSourceAddressResponse>,
    >

    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.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • body: UpdateShipmentSourceAddressRequest

      The body of the request to `updateShipmentSourceAddress`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateShipmentSourceAddressResponse>,
    >

    Throws

• updateShipmentTrackingDetails: function

  • updateShipmentTrackingDetails(
        inboundPlanId: string,
        shipmentId: string,
        body: UpdateShipmentTrackingDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateShipmentTrackingDetailsResponse>,
    >

    Updates a shipment's tracking details.

    Parameters

    • inboundPlanId: string

      Identifier of an inbound plan.

    • shipmentId: string

      Identifier of a shipment. A shipment contains the boxes and units being inbounded.

    • body: UpdateShipmentTrackingDetailsRequest

      The body of the request to `updateShipmentTrackingDetails`.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateShipmentTrackingDetailsResponse>,
    >

    Throws