Function FulfillmentInboundApiFactory

FulfillmentInboundApi - factory interface

Export

FulfillmentInboundApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    cancelInboundPlan(
        requestParameters: FulfillmentInboundApiCancelInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelInboundPlanResponse>;
    cancelSelfShipAppointment(
        requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelSelfShipAppointmentResponse>;
    confirmDeliveryWindowOptions(
        requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmDeliveryWindowOptionsResponse>;
    confirmPackingOption(
        requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPackingOptionResponse>;
    confirmPlacementOption(
        requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPlacementOptionResponse>;
    confirmShipmentContentUpdatePreview(
        requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>;
    confirmTransportationOptions(
        requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmTransportationOptionsResponse>;
    createInboundPlan(
        requestParameters: FulfillmentInboundApiCreateInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateInboundPlanResponse>;
    createMarketplaceItemLabels(
        requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateMarketplaceItemLabelsResponse>;
    generateDeliveryWindowOptions(
        requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateDeliveryWindowOptionsResponse>;
    generatePackingOptions(
        requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GeneratePackingOptionsResponse>;
    generatePlacementOptions(
        requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GeneratePlacementOptionsResponse>;
    generateSelfShipAppointmentSlots(
        requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>;
    generateShipmentContentUpdatePreviews(
        requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>;
    generateTransportationOptions(
        requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateTransportationOptionsResponse>;
    getDeliveryChallanDocument(
        requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetDeliveryChallanDocumentResponse>;
    getInboundOperationStatus(
        requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundOperationStatus>;
    getInboundPlan(
        requestParameters: FulfillmentInboundApiGetInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundPlan>;
    getSelfShipAppointmentSlots(
        requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetSelfShipAppointmentSlotsResponse>;
    getShipment(
        requestParameters: FulfillmentInboundApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<Shipment>;
    getShipmentContentUpdatePreview(
        requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ContentUpdatePreview>;
    listDeliveryWindowOptions(
        requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListDeliveryWindowOptionsResponse>;
    listInboundPlanBoxes(
        requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanBoxesResponse>;
    listInboundPlanItems(
        requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanItemsResponse>;
    listInboundPlanPallets(
        requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanPalletsResponse>;
    listInboundPlans(
        requestParameters?: FulfillmentInboundApiListInboundPlansRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlansResponse>;
    listItemComplianceDetails(
        requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListItemComplianceDetailsResponse>;
    listPackingGroupBoxes(
        requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPackingGroupBoxesResponse>;
    listPackingGroupItems(
        requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPackingGroupItemsResponse>;
    listPackingOptions(
        requestParameters: FulfillmentInboundApiListPackingOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPackingOptionsResponse>;
    listPlacementOptions(
        requestParameters: FulfillmentInboundApiListPlacementOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPlacementOptionsResponse>;
    listPrepDetails(
        requestParameters: FulfillmentInboundApiListPrepDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPrepDetailsResponse>;
    listShipmentBoxes(
        requestParameters: FulfillmentInboundApiListShipmentBoxesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentBoxesResponse>;
    listShipmentContentUpdatePreviews(
        requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentContentUpdatePreviewsResponse>;
    listShipmentItems(
        requestParameters: FulfillmentInboundApiListShipmentItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentItemsResponse>;
    listShipmentPallets(
        requestParameters: FulfillmentInboundApiListShipmentPalletsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentPalletsResponse>;
    listTransportationOptions(
        requestParameters: FulfillmentInboundApiListTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListTransportationOptionsResponse>;
    scheduleSelfShipAppointment(
        requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ScheduleSelfShipAppointmentResponse>;
    setPackingInformation(
        requestParameters: FulfillmentInboundApiSetPackingInformationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetPackingInformationResponse>;
    setPrepDetails(
        requestParameters: FulfillmentInboundApiSetPrepDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetPrepDetailsResponse>;
    updateInboundPlanName(
        requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateItemComplianceDetails(
        requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateItemComplianceDetailsResponse>;
    updateShipmentName(
        requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateShipmentSourceAddress(
        requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateShipmentSourceAddressResponse>;
    updateShipmentTrackingDetails(
        requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateShipmentTrackingDetailsResponse>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    cancelInboundPlan(
        requestParameters: FulfillmentInboundApiCancelInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelInboundPlanResponse>;
    cancelSelfShipAppointment(
        requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelSelfShipAppointmentResponse>;
    confirmDeliveryWindowOptions(
        requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmDeliveryWindowOptionsResponse>;
    confirmPackingOption(
        requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPackingOptionResponse>;
    confirmPlacementOption(
        requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPlacementOptionResponse>;
    confirmShipmentContentUpdatePreview(
        requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>;
    confirmTransportationOptions(
        requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmTransportationOptionsResponse>;
    createInboundPlan(
        requestParameters: FulfillmentInboundApiCreateInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateInboundPlanResponse>;
    createMarketplaceItemLabels(
        requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateMarketplaceItemLabelsResponse>;
    generateDeliveryWindowOptions(
        requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateDeliveryWindowOptionsResponse>;
    generatePackingOptions(
        requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GeneratePackingOptionsResponse>;
    generatePlacementOptions(
        requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GeneratePlacementOptionsResponse>;
    generateSelfShipAppointmentSlots(
        requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>;
    generateShipmentContentUpdatePreviews(
        requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>;
    generateTransportationOptions(
        requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateTransportationOptionsResponse>;
    getDeliveryChallanDocument(
        requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetDeliveryChallanDocumentResponse>;
    getInboundOperationStatus(
        requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundOperationStatus>;
    getInboundPlan(
        requestParameters: FulfillmentInboundApiGetInboundPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundPlan>;
    getSelfShipAppointmentSlots(
        requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetSelfShipAppointmentSlotsResponse>;
    getShipment(
        requestParameters: FulfillmentInboundApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<Shipment>;
    getShipmentContentUpdatePreview(
        requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ContentUpdatePreview>;
    listDeliveryWindowOptions(
        requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListDeliveryWindowOptionsResponse>;
    listInboundPlanBoxes(
        requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanBoxesResponse>;
    listInboundPlanItems(
        requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanItemsResponse>;
    listInboundPlanPallets(
        requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanPalletsResponse>;
    listInboundPlans(
        requestParameters?: FulfillmentInboundApiListInboundPlansRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlansResponse>;
    listItemComplianceDetails(
        requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListItemComplianceDetailsResponse>;
    listPackingGroupBoxes(
        requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPackingGroupBoxesResponse>;
    listPackingGroupItems(
        requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPackingGroupItemsResponse>;
    listPackingOptions(
        requestParameters: FulfillmentInboundApiListPackingOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPackingOptionsResponse>;
    listPlacementOptions(
        requestParameters: FulfillmentInboundApiListPlacementOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPlacementOptionsResponse>;
    listPrepDetails(
        requestParameters: FulfillmentInboundApiListPrepDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPrepDetailsResponse>;
    listShipmentBoxes(
        requestParameters: FulfillmentInboundApiListShipmentBoxesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentBoxesResponse>;
    listShipmentContentUpdatePreviews(
        requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentContentUpdatePreviewsResponse>;
    listShipmentItems(
        requestParameters: FulfillmentInboundApiListShipmentItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentItemsResponse>;
    listShipmentPallets(
        requestParameters: FulfillmentInboundApiListShipmentPalletsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentPalletsResponse>;
    listTransportationOptions(
        requestParameters: FulfillmentInboundApiListTransportationOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListTransportationOptionsResponse>;
    scheduleSelfShipAppointment(
        requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ScheduleSelfShipAppointmentResponse>;
    setPackingInformation(
        requestParameters: FulfillmentInboundApiSetPackingInformationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetPackingInformationResponse>;
    setPrepDetails(
        requestParameters: FulfillmentInboundApiSetPrepDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetPrepDetailsResponse>;
    updateInboundPlanName(
        requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateItemComplianceDetails(
        requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateItemComplianceDetailsResponse>;
    updateShipmentName(
        requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateShipmentSourceAddress(
        requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateShipmentSourceAddressResponse>;
    updateShipmentTrackingDetails(
        requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateShipmentTrackingDetailsResponse>;
}
- cancelInboundPlan:function
  - cancelInboundPlan(
    requestParameters: FulfillmentInboundApiCancelInboundPlanRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiCancelInboundPlanRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CancelInboundPlanResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2754
- cancelSelfShipAppointment:function
  - cancelSelfShipAppointment(
    requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelSelfShipAppointmentResponse>
  - Cancels a self-ship appointment slot against a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CancelSelfShipAppointmentResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2764
- confirmDeliveryWindowOptions:function
  - confirmDeliveryWindowOptions(
    requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ConfirmDeliveryWindowOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2774
- confirmPackingOption:function
  - confirmPackingOption(
    requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPackingOptionResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ConfirmPackingOptionResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2784
- confirmPlacementOption:function
  - confirmPlacementOption(
    requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPlacementOptionResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ConfirmPlacementOptionResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2794
- confirmShipmentContentUpdatePreview:function
  - confirmShipmentContentUpdatePreview(
    requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2804
- confirmTransportationOptions:function
  - confirmTransportationOptions(
    requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ConfirmTransportationOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2814
- createInboundPlan:function
  - createInboundPlan(
    requestParameters: FulfillmentInboundApiCreateInboundPlanRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateInboundPlanResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiCreateInboundPlanRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateInboundPlanResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2824
- createMarketplaceItemLabels:function
  - createMarketplaceItemLabels(
    requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateMarketplaceItemLabelsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateMarketplaceItemLabelsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2834
- generateDeliveryWindowOptions:function
  - generateDeliveryWindowOptions(
    requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateDeliveryWindowOptionsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GenerateDeliveryWindowOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2844
- generatePackingOptions:function
  - generatePackingOptions(
    requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GeneratePackingOptionsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GeneratePackingOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2854
- generatePlacementOptions:function
  - generatePlacementOptions(
    requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GeneratePlacementOptionsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GeneratePlacementOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2864
- generateSelfShipAppointmentSlots:function
  - generateSelfShipAppointmentSlots(
    requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>
  - Initiates the process of generating the appointment slots list. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2874
- generateShipmentContentUpdatePreviews:function
  - generateShipmentContentUpdatePreviews(
    requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2884
- generateTransportationOptions:function
  - generateTransportationOptions(
    requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GenerateTransportationOptionsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GenerateTransportationOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2894
- getDeliveryChallanDocument:function
  - getDeliveryChallanDocument(
    requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetDeliveryChallanDocumentResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetDeliveryChallanDocumentResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2904
- getInboundOperationStatus:function
  - getInboundOperationStatus(
    requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundOperationStatus>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<InboundOperationStatus>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2914
- getInboundPlan:function
  - getInboundPlan(
    requestParameters: FulfillmentInboundApiGetInboundPlanRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundPlan>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGetInboundPlanRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<InboundPlan>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2924
- getSelfShipAppointmentSlots:function
  - getSelfShipAppointmentSlots(
    requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetSelfShipAppointmentSlotsResponse>
  - Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetSelfShipAppointmentSlotsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2934
- getShipment:function
  - getShipment(
    requestParameters: FulfillmentInboundApiGetShipmentRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGetShipmentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<Shipment>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2944
- getShipmentContentUpdatePreview:function
  - getShipmentContentUpdatePreview(
    requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ContentUpdatePreview>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2954
- listDeliveryWindowOptions:function
  - listDeliveryWindowOptions(
    requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListDeliveryWindowOptionsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListDeliveryWindowOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2964
- listInboundPlanBoxes:function
  - listInboundPlanBoxes(
    requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanBoxesResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListInboundPlanBoxesResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2974
- listInboundPlanItems:function
  - listInboundPlanItems(
    requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlanItemsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListInboundPlanItemsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2984
- listInboundPlanPallets:function
  - listInboundPlanPallets(
    requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListInboundPlanPalletsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:2994
- listInboundPlans:function
  - listInboundPlans(
    requestParameters?: FulfillmentInboundApiListInboundPlansRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListInboundPlansResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListInboundPlansRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListInboundPlansResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3004
- listItemComplianceDetails:function
  - listItemComplianceDetails(
    requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListItemComplianceDetailsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListItemComplianceDetailsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3014
- listPackingGroupBoxes:function
  - listPackingGroupBoxes(
    requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListPackingGroupBoxesResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3024
- listPackingGroupItems:function
  - listPackingGroupItems(
    requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListPackingGroupItemsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3034
- listPackingOptions:function
  - listPackingOptions(
    requestParameters: FulfillmentInboundApiListPackingOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListPackingOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListPackingOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3044
- listPlacementOptions:function
  - listPlacementOptions(
    requestParameters: FulfillmentInboundApiListPlacementOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListPlacementOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListPlacementOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3054
- listPrepDetails:function
  - listPrepDetails(
    requestParameters: FulfillmentInboundApiListPrepDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPrepDetailsResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListPrepDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListPrepDetailsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3064
- listShipmentBoxes:function
  - listShipmentBoxes(
    requestParameters: FulfillmentInboundApiListShipmentBoxesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentBoxesResponse>
  - 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListShipmentBoxesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListShipmentBoxesResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3074
- listShipmentContentUpdatePreviews:function
  - listShipmentContentUpdatePreviews(
    requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListShipmentContentUpdatePreviewsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3084
- listShipmentItems:function
  - listShipmentItems(
    requestParameters: FulfillmentInboundApiListShipmentItemsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListShipmentItemsResponse>
  - Provides a paginated list of item packages in a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiListShipmentItemsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListShipmentItemsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3094
- listShipmentPallets:function
  - listShipmentPallets(
    requestParameters: FulfillmentInboundApiListShipmentPalletsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiListShipmentPalletsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListShipmentPalletsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3104
- listTransportationOptions:function
  - listTransportationOptions(
    requestParameters: FulfillmentInboundApiListTransportationOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListTransportationOptionsResponse>
  - Retrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions operation before becoming available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiListTransportationOptionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListTransportationOptionsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3114
- scheduleSelfShipAppointment:function
  - scheduleSelfShipAppointment(
    requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ScheduleSelfShipAppointmentResponse>
  - Confirms or reschedules a self-ship appointment slot against a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ScheduleSelfShipAppointmentResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3124
- setPackingInformation:function
  - setPackingInformation(
    requestParameters: FulfillmentInboundApiSetPackingInformationRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiSetPackingInformationRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<SetPackingInformationResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3134
- setPrepDetails:function
  - setPrepDetails(
    requestParameters: FulfillmentInboundApiSetPrepDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<SetPrepDetailsResponse>
  - Set the preparation details for a list of MSKUs in a specified marketplace. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiSetPrepDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<SetPrepDetailsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3144
- updateInboundPlanName:function
  - updateInboundPlanName(
    requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Updates the name of an existing inbound plan. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3154
- updateItemComplianceDetails:function
  - updateItemComplianceDetails(
    requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<UpdateItemComplianceDetailsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3164
- updateShipmentName:function
  - updateShipmentName(
    requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Updates the name of an existing shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3174
- updateShipmentSourceAddress:function
  - updateShipmentSourceAddress(
    requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest,
    options?: RawAxiosRequestConfig,
    ): 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. 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.
    Parameters
    - requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<UpdateShipmentSourceAddressResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3184
- updateShipmentTrackingDetails:function
  - updateShipmentTrackingDetails(
    requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateShipmentTrackingDetailsResponse>
  - Updates a shipment's tracking details. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<UpdateShipmentTrackingDetailsResponse>
    Throws
    - Defined in api-model/api/fulfillment-inbound-api.ts:3194
- Defined in api-model/api/fulfillment-inbound-api.ts:2744

Function FulfillmentInboundApiFactory

Export

Parameters

cancelInboundPlan:function

Parameters

Returns AxiosPromise<CancelInboundPlanResponse>

Throws

cancelSelfShipAppointment:function

Parameters

Returns AxiosPromise<CancelSelfShipAppointmentResponse>

Throws

confirmDeliveryWindowOptions:function

Parameters

Returns AxiosPromise<ConfirmDeliveryWindowOptionsResponse>

Throws

confirmPackingOption:function

Parameters

Returns AxiosPromise<ConfirmPackingOptionResponse>

Throws

confirmPlacementOption:function

Parameters

Returns AxiosPromise<ConfirmPlacementOptionResponse>

Throws

confirmShipmentContentUpdatePreview:function

Parameters

Returns AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>

Throws

confirmTransportationOptions:function

Parameters

Returns AxiosPromise<ConfirmTransportationOptionsResponse>

Throws

createInboundPlan:function

Parameters

Returns AxiosPromise<CreateInboundPlanResponse>

Throws

createMarketplaceItemLabels:function

Parameters

Returns AxiosPromise<CreateMarketplaceItemLabelsResponse>

Throws

generateDeliveryWindowOptions:function

Parameters

Returns AxiosPromise<GenerateDeliveryWindowOptionsResponse>

Throws

generatePackingOptions:function

Parameters

Returns AxiosPromise<GeneratePackingOptionsResponse>

Throws

generatePlacementOptions:function

Parameters

Returns AxiosPromise<GeneratePlacementOptionsResponse>

Throws

generateSelfShipAppointmentSlots:function

Parameters

Returns AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>

Throws

generateShipmentContentUpdatePreviews:function

Parameters

Returns AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>

Throws

generateTransportationOptions:function

Parameters

Returns AxiosPromise<GenerateTransportationOptionsResponse>

Throws

getDeliveryChallanDocument:function

Parameters

Returns AxiosPromise<GetDeliveryChallanDocumentResponse>

Throws

getInboundOperationStatus:function

Parameters

Returns AxiosPromise<InboundOperationStatus>

Throws

getInboundPlan:function

Parameters

Returns AxiosPromise<InboundPlan>

Throws

getSelfShipAppointmentSlots:function

Parameters

Returns AxiosPromise<GetSelfShipAppointmentSlotsResponse>

Throws

getShipment:function