FulfillmentInbound

class sp_api.api.FulfillmentInbound(marketplace: 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)

item_guidance(self, **kwargs) → ApiResponse

Examples

literal blocks:

FulfillmentInbound().item_guidance(**{"MarkeplaceId": "US", "ASINList": ["ASIN1"]})

Parameters:

**kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

res = FulfillmentInbound().plans({
        "ShipFromAddress": {
            "Name": "Name",
            "AddressLine1": "123 any st",
            "AddressLine2": "AddressLine2",
            "DistrictOrCounty": "Washtenaw",
            "City": "Ann Arbor",
            "StateOrProvinceCode": "MI",
            "CountryCode": "US",
            "PostalCode": "48188"
        },
        "LabelPrepPreference": "SELLER_LABEL",
        "ShipToCountryCode": "ShipToCountryCode",
        "ShipToCountrySubdivisionCode": "ShipToCountrySubdivisionCode",
        "InboundShipmentPlanRequestItems": [
            {
                "SellerSKU": "SellerSKU",
                "ASIN": "ASIN",
                "Condition": "NewItem",
                "Quantity": 1,
                "QuantityInCase": 1,
                "PrepDetailsList": [
                    {
                        "PrepInstruction": "Polybagging",
                        "PrepOwner": "AMAZON"
                    }
                ]
            }
        ]
    })

Parameters:

• data –

• **kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().create_shipment('123', {
        "InboundShipmentHeader": {
            "ShipmentName": "43545345",
            "ShipFromAddress": {
                "Name": "35435345",
                "AddressLine1": "123 any st",
                "DistrictOrCounty": "Washtenaw",
                "City": "Ann Arbor",
                "StateOrProvinceCode": "Test",
                "CountryCode": "US",
                "PostalCode": "48103"
            },
            "DestinationFulfillmentCenterId": "AEB2",
            "AreCasesRequired": True,
            "ShipmentStatus": "WORKING",
            "LabelPrepPreference": "SELLER_LABEL",
            "IntendedBoxContentsSource": "NONE"
        },
        "InboundShipmentItems": [
            {
                "ShipmentId": "345453",
                "SellerSKU": "34534545",
                "FulfillmentNetworkSKU": "435435435",
                "QuantityShipped": 0,
                "QuantityReceived": 0,
                "QuantityInCase": 0,
                "ReleaseDate": "2020-04-23",
                "PrepDetailsList": [
                    {
                        "PrepInstruction": "Polybagging",
                        "PrepOwner": "AMAZON"
                    }
                ]
            }
        ],
        "MarketplaceId": "MarketplaceId"
    })

Parameters:

• shipment_id –

• data –

• **kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().update_shipment('123', {
        "MarketplaceId": "ATVPDKIKX0DER",
        "InboundShipmentHeader": {
            "ShipmentName": "Shipment for FBA15DJCQ1ZF",
            "ShipFromAddress": {
                "Name": "Uma Test",
                "AddressLine1": "123 any st",
                "AddressLine2": "",
                "DistrictOrCounty": "Washtenaw",
                "City": "Ann Arbor",
                "StateOrProvinceCode": "CO",
                "CountryCode": "US",
                "PostalCode": "48104"
            },
            "DestinationFulfillmentCenterId": "ABE2",
            "ShipmentStatus": "WORKING",
            "LabelPrepPreference": "SELLER_LABEL"
        },
        "InboundShipmentItems": [
            {
                "SellerSKU": "PSMM-TEST-SKU-Apr-03_21_17_20-0379",
                "QuantityShipped": 1
            }
        ]
    })

Parameters:

• shipment_id –

• data –

• **kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().preorder('shipmentId1', MarketplaceId='MarketplaceId1')

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

confirm_preorder(self, shipment_id, **kwargs)

Parameters:

• shipment_id –

• **kwargs –

Returns:

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

Examples

literal blocks:

FulfillmentInbound().prep_instruction({"ShipToCountryCode": "US", "ASINList": ["ASIN1"]})

Parameters:

• data –

• **kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().get_transport_information('shipmentId1')

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

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

putTransportDetails

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().void_transport('shipmentId1')

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().estimate_transport('shipmentId1')

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

confirm_transport(shipment_id, **kwargs)

get_labels(self, shipment_id, **kwargs)

Parameters:

• shipment_id –

• **kwargs –

Returns:

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

Examples

literal blocks:

FulfillmentInbound().bill_of_lading('shipmentId')

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

get_shipments(self, **kwargs) → ApiResponse

Examples

literal blocks:

FulfillmentInbound().get_shipments(QueryType='SHIPMENT', MarketplaceId="ATVPDKIKX0DER")

Parameters:

**kwargs –

Returns:

ApiResponse

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

Examples

literal blocks:

FulfillmentInbound().shipment_items_by_shipment('FBA15DJ9SVVD', MarketplaceId="ATVPDKIKX0DER")

Parameters:

• shipment_id –

• **kwargs –

Returns:

ApiResponse

shipment_items(self, **kwargs) → ApiResponse

Examples

literal blocks:

FulfillmentInbound().shipment_items(QueryType='SHIPMENT', MarketplaceId="ATVPDKIKX0DER", NextToken='NextToken')

Parameters:

**kwargs –

Returns:

ApiResponse

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

FulfillmentInbound().get_shipments_by_id(‘FBA16TBYQ6J6’)

Parameters:

• shipment_id_list – str or [str]

• **kwargs –

Returns:

ApiResponse