HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

submitShipmentStatusUpdates

This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.

Usage Plan:

Rate (requests per second)Burst
1010

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.

Body Params

Request body containing the shipment status update data.

shipmentStatusUpdates
array of objects
length ≥ 1

Contains a list of one or more ShipmentStatusUpdate objects, each representing an update to the status of a specific shipment.

shipmentStatusUpdates
string
required

Purchase order number of the shipment for which to update the shipment status.

sellingParty
object
required

Name, address and tax details of a party.

shipFromParty
object
required

Name, address and tax details of a party.

statusUpdateDetails
object
required

Details for the shipment status update given by the vendor for the specific package.

Responses

Response body
object
payload
object

Response containing the transaction ID.

string

GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

errors
array of objects

A list of error responses returned when a request is unsuccessful.

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition.

string

Additional details that can help the caller understand or fix the issue.

Headers
object
string

Your rate limit (requests per second) for this operation.

string

Unique request reference identifier.

Language