ShipmentInvoicing V0

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

ShipmentInvoicing SP-API Client :link:

The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.

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

Returns the shipment details required to issue an invoice for the specified shipment.

Usage Plan:

Rate (requests per second)	Burst
1.133	25

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

ShipmentInvoicingV0().get_shipment_details("value")

Parameters:

shipmentId – object | required The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](doc:notifications-api-v1-use-case-guide).

Returns:

ApiResponse

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

Submits a shipment invoice document for a given shipment.

Usage Plan:

Rate (requests per second)	Burst
1.133	25

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

ShipmentInvoicingV0().submit_invoice("value")

Parameters:

• shipmentId – object | required The identifier for the shipment.

• body – SubmitInvoiceRequest | required

Returns:

ApiResponse

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

Returns the invoice status for the shipment you specify.

Usage Plan:

Rate (requests per second)	Burst
1.133	25

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

ShipmentInvoicingV0().get_invoice_status("value")

Parameters:

shipmentId – object | required The shipment identifier for the shipment.

Returns:

ApiResponse