getShipmentReports

Fetches shipments from all legal entities associated with the partyId based on specified search criteria. This endpoint allows for detailed querying of shipment data, enabling comprehensive shipment reporting and analysis.

Usage Plan:

Rate (requests per second)Burst
0.510

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

📘

To test this API, populate each required input field with the pre-defined example values.

Query Params
date-time
required

The start of the order date range to search for shipments, in ISO 8601 format. Must not be more than 366 days before orderEndDate.",

date-time
required

The end of the order date range to search for shipments, in ISO 8601 format. Must not be in the future and must not be more than 366 days after orderStartDate.",

shipmentStatuses
array of strings
length ≥ 1

List of shipment status values used to filter the results.

Possible values:

  • SHIPPED : The shipment has been sent out.
  • PENDING_PAYMENT : The shipment is awaiting payment before it can be processed.
  • SHIPPING_SOON : The shipment is being prepared and will be shipped shortly.
  • SHIPPED_PLANNED : The shipment has been planned but not yet dispatched.
shipmentStatuses
orderIds
array of strings
length between 1 and 30

List of order IDs to filter by. If the order date for any specified order ID is not within the provided date range, an empty result will be returned.

orderIds
string
enum

The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty.

string

A page token returned in the response to your previous request when the number of results exceed the page size. Must be used with the same query parameters as the original request, changing parameters will result in an error. To get the next page of results, include pageToken as a parameter. There are no more pages to return when the response returns no nextPageToken.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json