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

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

Examples

literal blocks:

VendorShipments().submit_shipment_confirmations()

Parameters:: body – SubmitShipmentConfirmationsRequest | required A request to submit shipment confirmation.
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

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

Examples

literal blocks:

VendorShipments().submit_shipments()

Parameters:: body – SubmitShipments | required A request to submit shipment request.
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

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

Examples

literal blocks:

VendorShipments().get_shipment_details()

Parameters:

limit (key) – object | The limit to the number of records returned. Default value is 50 records.
sortOrder (key) – object | Sort in ascending or descending order by purchase order creation date.
nextToken (key) – object | Used for pagination when there are more shipments than the specified result size limit.
createdAfter (key) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | Get Shipment Details by passing Estimated Delivery Date After. Must be in <a href=’https://developer-docs.amazon.com/sp-api/docs/iso-8601’>ISO 8601</a> format.
shipmentDeliveryBefore (key) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | 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) – object | Get Shipment Details by passing Current shipment status.
vendorShipmentIdentifier (key) – object | Get Shipment Details by passing Vendor Shipment ID
buyerReferenceNumber (key) – object | Get Shipment Details by passing buyer Reference ID
buyerWarehouseCode (key) – object | Get Shipping Details based on buyer warehouse code. This value should be same as ‘shipToParty.partyId’ in the Shipment.
sellerWarehouseCode (key) – object | Get Shipping Details based on vendor warehouse code. This value should be same as ‘sellingParty.partyId’ in the Shipment.

Returns:

ApiResponse

submit_shipment_confirmation(self, **kwargs) → ApiResponse#

Submits one shipment confirmation for vendor orders and get response immediately.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorShipments().submit_shipment_confirmation()

Parameters:: body – SubmitShipmentConfirmationRequest | required A request to submit shipment confirmation.
Returns:: ApiResponse

get_shipment_labels(self, **kwargs) → ApiResponse#

Returns small parcel shipment labels based on the filters that you specify.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorShipments().get_shipment_labels()

Parameters:

limit (key) – object | The limit to the number of records returned. Default value is 50 records.
sortOrder (key) – object | Sort the list by shipment label creation date in ascending or descending order.
nextToken (key) – object | A token that you use to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified pageSize value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.
labelCreatedAfter (key) – object | Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
labelCreatedBefore (key) – object | Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
buyerReferenceNumber (key) – object | Get Shipment labels by passing buyer reference number.
vendorShipmentIdentifier (key) – object | Get Shipment labels by passing vendor shipment identifier.
sellerWarehouseCode (key) – object | Get Shipping labels based on vendor warehouse code. This value must be same as the sellingParty.partyId in the shipment.

Returns:

ApiResponse

VendorShipments#

This Page