ExternalFulfillmentShipping V2021_01_06

class sp_api.api.ExternalFulfillmentShippingV20210106(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'>)

External Fulfillment Shipments API (version 2021-01-06).

process_shipment(self, shipmentId, operation, **kwargs) → ApiResponse

Confirms/Rejects that a seller will be fulfilling or cancelling the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().process_shipment("value", "value")

Parameters:

• shipmentId –

  required

• operation –

  required

• **kwargs

Returns:

ApiResponse

create_packages(self, shipmentId, **kwargs) → ApiResponse

Provides details about the packages that will be used to fulfill the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().create_packages("value")

Parameters:

• shipmentId –

  required

• **kwargs

Returns:

ApiResponse

update_package(self, shipmentId, packageId, **kwargs) → ApiResponse

Updates the details about the packages that will be used to fulfill the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().update_package("value", "value")

Parameters:

• shipmentId –

  required

• packageId –

  required

• **kwargs

Returns:

ApiResponse

update_package_status(self, shipmentId, packageId, **kwargs) → ApiResponse

Updates the status of the packages.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().update_package_status("value", "value")

Parameters:

• shipmentId –

  required

• packageId –

  required

• **kwargs

Returns:

ApiResponse

generate_invoice(self, shipmentId, **kwargs) → ApiResponse

Generates and retrieves the invoice for the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().generate_invoice("value")

Parameters:

• shipmentId –

  required

• **kwargs

Returns:

ApiResponse

retrieve_invoice(self, shipmentId, **kwargs) → ApiResponse

Retrieves invoice for the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().retrieve_invoice("value")

Parameters:

• shipmentId –

  required

• **kwargs

Returns:

ApiResponse

retrieve_shipping_options(self, shipmentId, packageId, **kwargs) → ApiResponse

An API for a client to retrieve an optional list of shippingOptions that marketplace/channel provides

for the pickup of the packages of an shipment. This API will return a list of shippingOptions if the marketplace/channel provides transportation and allows the seller to choose a shippingOption. If the marketplace/channel does not allow for a shippingOption to be selected, but has a pre-determined shippingOption, then this API will return an empty response.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().retrieve_shipping_options("value", "value")

Parameters:

• shipmentId –

  required

• packageId –

  required

• **kwargs

Returns:

ApiResponse

generate_ship_labels(self, shipmentId, operation, **kwargs) → ApiResponse

Generates and retrieves all ship-labels for one or more packages in the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().generate_ship_labels("value", "value")

Parameters:

• shipmentId –

  required

• operation –

  required

• **kwargs

Returns:

ApiResponse

retrieve_ship_label(self, shipmentId, packageId, **kwargs) → ApiResponse

retrieves a ship-label for the specified package in the specified shipment.

Examples

literal blocks:

ExternalFulfillmentShippingV20210106().retrieve_ship_label("value", "value")

Parameters:

• shipmentId –

  required

• packageId –

  required

• **kwargs

Returns:

ApiResponse