VendorShipments

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

VendorShipments SP-API Client :link:

The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.

submit_shipment_confirmations(**kwargs) → ApiResponse

submit_shipment_confirmations(self, **kwargs) -> ApiResponse

Submits one or more shipment confirmations for vendor orders.

Usage Plan:

Rate (requests per second) | Burst |
—- | —- |
10 | 10 |

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Args:

body: | * REQUIRED {‘description’: ‘The request schema for the SubmitShipmentConfirmations operation.’,

‘properties’: {‘shipmentConfirmations’: {‘description’: ‘A list of one or more shipment confirmations.’, ‘items’: {‘$ref’: ‘#/definitions/ShipmentConfirmation’}, ‘type’: ‘array’}}, ‘type’: ‘object’}

Returns:

ApiResponse:

submit_shipments(**kwargs) → ApiResponse

submit_shipments(self, **kwargs) -> ApiResponse

Submits one or more shipment request for vendor Orders.

Usage Plan:

Rate (requests per second) | Burst |
—- | —- |
10 | 10 |

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Args:

body: | * REQUIRED {‘description’: ‘The request schema for the SubmitShipments operation.’,

‘properties’: {‘shipments’: {‘description’: ‘A list of one or more shipments with underlying details.’, ‘items’: {‘$ref’: ‘#/definitions/Shipment’}, ‘type’: ‘array’}}, ‘type’: ‘object’}

Returns:

ApiResponse:

get_shipment_details(self, **kwargs) → ApiResponse

Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify.

Usage Plan:

Rate (requests per second) | Burst |
—- | —- |
10 | 10 |

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:
Return type:

ApiResponse