FulfillmentInbound V0#

class sp_api.api.FulfillmentInboundV0(marketplace: ~sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None, proxies=None, verify=True, timeout=None, version=None, credential_providers=None, auth_token_client_class=<class 'sp_api.auth.access_token_client.AccessTokenClient'>)#

FulfillmentInbound SP-API Client :link:

The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon’s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.

item_guidance(self, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().item_guidance()
Parameters:

**kwargs

Returns:

ApiResponse

plans(self, data, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().plans("value")
Parameters:

  • data –

    required

  • **kwargs

Returns:

ApiResponse

create_shipment(self, shipment_id, data, **kwargs) → ApiResponse#

create_shipment(self, shipment_id, data, **kwargs)

Examples

literal blocks:

FulfillmentInboundV0().create_shipment("value", "value")
Parameters:

  • shipment_id –

    required

  • data –

    required

  • **kwargs

Returns:

ApiResponse

update_shipment(self, shipment_id, data, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().update_shipment("value", "value")
Parameters:

  • shipment_id –

    required

  • data –

    required

  • **kwargs

Returns:

ApiResponse

update_shipment_name(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

Updates the name of an existing shipment.

Examples

literal blocks:

FulfillmentInboundV0().update_shipment_name("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

preorder(self, shipment_id, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().preorder("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

confirm_preorder(self, shipment_id, **kwargs) → ApiResponse#

confirm_preorder(self, shipment_id, **kwargs)

Examples

literal blocks:

FulfillmentInboundV0().confirm_preorder("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

prep_instruction(self, data, **kwargs) → ApiResponse#

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon’s fulfillment network.

Examples

literal blocks:

FulfillmentInboundV0().prep_instruction("value")
Parameters:

  • data –

    required

  • **kwargs

Returns:

ApiResponse

get_transport_information(self, shipment_id, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().get_transport_information("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

update_transport_information(self, shipment_id, **kwargs) → ApiResponse#

putTransportDetails

Examples

literal blocks:

FulfillmentInboundV0().update_transport_information("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

void_transport(self, shipment_id, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().void_transport("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

estimate_transport(self, shipment_id, **kwargs) → ApiResponse#

Examples

literal blocks:

FulfillmentInboundV0().estimate_transport("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

confirm_transport(shipment_id, **kwargs)#
get_labels(self, shipment_id, **kwargs) → ApiResponse#

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

Examples

literal blocks:

FulfillmentInboundV0().get_labels("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

bill_of_lading(self, shipment_id, **kwargs) → ApiResponse#

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.

Examples

literal blocks:

FulfillmentInboundV0().bill_of_lading("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

get_shipments(self, **kwargs) → ApiResponse#

Returns a list of inbound shipments based on criteria that you specify.

Examples

literal blocks:

FulfillmentInboundV0().get_shipments()
Parameters:

**kwargs

Returns:

ApiResponse

shipment_items_by_shipment(self, shipment_id, **kwargs) → ApiResponse#

Returns a list of items in a specified inbound shipment.

Examples

literal blocks:

FulfillmentInboundV0().shipment_items_by_shipment("value")
Parameters:

  • shipment_id –

    required

  • **kwargs

Returns:

ApiResponse

shipment_items(self, **kwargs) → ApiResponse#

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.

Examples

literal blocks:

FulfillmentInboundV0().shipment_items()
Parameters:

**kwargs

Returns:

ApiResponse

get_shipments_by_id(self, shipment_id_list, **kwargs) → ApiResponse#

FulfillmentInbound().get_shipments_by_id(‘FBA16TBYQ6J6’)

Examples

literal blocks:

FulfillmentInboundV0().get_shipments_by_id("value")
Parameters:

  • shipment_id_list –

    required

  • **kwargs

Returns:

ApiResponse

list_inbound_plans(self, **kwargs) → ApiResponse#

Provides a list of inbound plans with minimal information.

Examples

literal blocks:

FulfillmentInboundV0().list_inbound_plans()
Parameters:

**kwargs

Returns:

ApiResponse

create_inbound_plan(self, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().create_inbound_plan()
Parameters:

**kwargs

Returns:

ApiResponse

get_inbound_plan(self, inboundPlanId, **kwargs) → ApiResponse#

Fetches the top level information about an inbound plan.

Examples

literal blocks:

FulfillmentInboundV0().get_inbound_plan("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

list_inbound_plan_boxes(self, inboundPlanId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().list_inbound_plan_boxes("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

cancel_inbound_plan(self, inboundPlanId, **kwargs) → ApiResponse#
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.

Examples

literal blocks:

FulfillmentInboundV0().cancel_inbound_plan("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

list_inbound_plan_items(self, inboundPlanId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().list_inbound_plan_items("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

set_packing_information(self, inboundPlanId, **kwargs) → ApiResponse#
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.

Examples

literal blocks:

FulfillmentInboundV0().set_packing_information("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

list_packing_options(self, inboundPlanId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().list_packing_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

generate_packing_options(self, inboundPlanId, **kwargs) → ApiResponse#

Generates available packing options for the inbound plan.

Examples

literal blocks:

FulfillmentInboundV0().generate_packing_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

confirm_packing_option(self, inboundPlanId, packingOptionId, **kwargs) → ApiResponse#

Confirms the packing option for an inbound plan.

Examples

literal blocks:

FulfillmentInboundV0().confirm_packing_option("value", "value")
Parameters:

  • inboundPlanId –

    required

  • packingOptionId –

    required

  • **kwargs

Returns:

ApiResponse

list_packing_group_items(self, inboundPlanId, packingGroupId, **kwargs) → ApiResponse#

Retrieves a list of all items in a packing options’s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed.

Examples

literal blocks:

FulfillmentInboundV0().list_packing_group_items("value", "value")
Parameters:

  • inboundPlanId –

    required

  • packingGroupId –

    required

  • **kwargs

Returns:

ApiResponse

list_inbound_plan_pallets(self, inboundPlanId, **kwargs) → ApiResponse#

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.

Examples

literal blocks:

FulfillmentInboundV0().list_inbound_plan_pallets("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

list_placement_options(self, inboundPlanId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().list_placement_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

generate_placement_options(self, inboundPlanId, **kwargs) → ApiResponse#

Generates placement options for the inbound plan.

Examples

literal blocks:

FulfillmentInboundV0().generate_placement_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

confirm_placement_option(self, inboundPlanId, placementOptionId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().confirm_placement_option("value", "value")
Parameters:

  • inboundPlanId –

    required

  • placementOptionId –

    required

  • **kwargs

Returns:

ApiResponse

get_shipment(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

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.

Examples

literal blocks:

FulfillmentInboundV0().get_shipment("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

get_delivery_challan_document(self, inboundPlanId, **kwargs) → ApiResponse#

Provide delivery challan document for PCP transportation in IN marketplace.

Examples

literal blocks:

FulfillmentInboundV0().get_delivery_challan_document("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

update_shipment_delivery_window(self, inboundPlanId, **kwargs) → ApiResponse#

Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse.

Examples

literal blocks:

FulfillmentInboundV0().update_shipment_delivery_window("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) → ApiResponse#

Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.

Examples

literal blocks:

FulfillmentInboundV0().get_self_ship_appointment_slots("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

generate_self_ship_appointment_slots(self, inboundPlanId, **kwargs) → ApiResponse#

Initiates the process of generating the appointment slots list.

Examples

literal blocks:

FulfillmentInboundV0().generate_self_ship_appointment_slots("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

schedule_self_ship_appointment(self, inboundPlanId, **kwargs) → ApiResponse#

Confirms or reschedules a self-ship appointment slot against a shipment.

Examples

literal blocks:

FulfillmentInboundV0().schedule_self_ship_appointment("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

list_transportation_options(self, inboundPlanId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().list_transportation_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

generate_transportation_options(self, inboundPlanId, **kwargs) → ApiResponse#

Generates available transportation options for a given placement option.

Examples

literal blocks:

FulfillmentInboundV0().generate_transportation_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

confirm_transportation_options(self, inboundPlanId, **kwargs) → ApiResponse#

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.

Examples

literal blocks:

FulfillmentInboundV0().confirm_transportation_options("value")
Parameters:

  • inboundPlanId –

    required

  • **kwargs

Returns:

ApiResponse

list_item_compliance_details(self, **kwargs) → ApiResponse#

List the inbound compliance details for MSKUs in a given marketplace.

Examples

literal blocks:

FulfillmentInboundV0().list_item_compliance_details()
Parameters:

**kwargs

Returns:

ApiResponse

update_item_compliance_details(self, **kwargs) → ApiResponse#

Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation.

Examples

literal blocks:

FulfillmentInboundV0().update_item_compliance_details()
Parameters:

**kwargs

Returns:

ApiResponse

get_inbound_operation_status(self, operationId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().get_inbound_operation_status("value")
Parameters:

  • operationId –

    required

  • **kwargs

Returns:

ApiResponse

generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

Generates available delivery window options for a given shipment.

Examples

literal blocks:

FulfillmentInboundV0().generate_delivery_window_options("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

list_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().list_delivery_window_options("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

confirm_delivery_window_options(self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs) → ApiResponse#

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.

Examples

literal blocks:

FulfillmentInboundV0().confirm_delivery_window_options("value", "value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • deliveryWindowOptionId –

    required

  • **kwargs

Returns:

ApiResponse

list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

Provides a paginated list of item packages in a shipment.

Examples

literal blocks:

FulfillmentInboundV0().list_shipment_items("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

create_marketplace_item_labels(self, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().create_marketplace_item_labels()
Parameters:

**kwargs

Returns:

ApiResponse

list_prep_details(self, **kwargs) → ApiResponse#

Get preparation details for a list of MSKUs in a specified marketplace.

Examples

literal blocks:

FulfillmentInboundV0().list_prep_details()
Parameters:

**kwargs

Returns:

ApiResponse

set_prep_details(self, **kwargs) → ApiResponse#

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

Examples

literal blocks:

FulfillmentInboundV0().set_prep_details()
Parameters:

**kwargs

Returns:

ApiResponse

list_shipment_boxes(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

Provides a paginated list of box packages in a shipment.

Examples

literal blocks:

FulfillmentInboundV0().list_shipment_boxes("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

update_shipment_tracking_details(self, inboundPlanId, shipmentId, **kwargs) → ApiResponse#

Updates a shipment’s tracking details.

Examples

literal blocks:

FulfillmentInboundV0().update_shipment_tracking_details("value", "value")
Parameters:

  • inboundPlanId –

    required

  • shipmentId –

    required

  • **kwargs

Returns:

ApiResponse

On this page

This Page