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(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(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:
limit (key) โ integer | The limit to the number of records returned. Default value is 50 records.
sortOrder (key) โ string | Sort in ascending or descending order by purchase order creation date.
nextToken (key) โ string | Used for pagination when there are more shipments than the specified result size limit.
createdAfter (key) โ string | Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
createdBefore (key) โ string | Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
shipmentConfirmedBefore (key) โ string | Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
shipmentConfirmedAfter (key) โ string | Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
packageLabelCreatedBefore (key) โ string | Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
packageLabelCreatedAfter (key) โ string | Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
shippedBefore (key) โ string | Get Shipment Details by passing Shipped Date Before. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
shippedAfter (key) โ string | Get Shipment Details by passing Shipped Date After. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
estimatedDeliveryBefore (key) โ string | Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
estimatedDeliveryAfter (key) โ string | Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
shipmentDeliveryBefore (key) โ string | Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
shipmentDeliveryAfter (key) โ string | Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
requestedPickUpBefore (key) โ string | Get Shipment Details by passing Before Requested pickup date. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
requestedPickUpAfter (key) โ string | Get Shipment Details by passing After Requested pickup date. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
scheduledPickUpBefore (key) โ string | Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
scheduledPickUpAfter (key) โ string | Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=โhttps://developer-docs.amazon.com/sp-api/docs/iso-8601โ>ISO 8601</a> format.
currentShipmentStatus (key) โ string | Get Shipment Details by passing Current shipment status.
vendorShipmentIdentifier (key) โ string | Get Shipment Details by passing Vendor Shipment ID
buyerReferenceNumber (key) โ string | Get Shipment Details by passing buyer Reference ID
buyerWarehouseCode (key) โ string | Get Shipping Details based on buyer warehouse code. This value should be same as โshipToParty.partyIdโ in the Shipment.
sellerWarehouseCode (key) โ string | Get Shipping Details based on vendor warehouse code. This value should be same as โsellingParty.partyIdโ in the Shipment.
- Return type: