vendorShipments_GetShipmentDetails

Get shipment details from Amazon with date and status filters.

readAmazon Seller (SP-API)sp.vendorShipments

Amazon SP-API · GetShipmentDetails · GET /vendor/shipping/v1/shipments

Call it

In an AI client (MCP)

tools/call
{
  "name": "vendorShipments_GetShipmentDetails",
  "arguments": {
    "store": "myStore-US"
  }
}

From code (Tool API)

curl -X POST https://api.sellersheetai.com/api/v1/tools/vendorShipments_GetShipmentDetails \
  -H "Authorization: Bearer $SELLERSHEET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store":"myStore-US"}'
Early access — the Tool API is open on request, contact us.

Arguments

NameTypeDescription
storerequiredstringthe store ref `<store>-<CC>` (name-country, e.g. 'myStore-US') — one of get_user_context's store_refs, verbatim.
created_afterstring · date-timeISO 8601 — shipment record created after.
created_beforestring · date-timeISO 8601 — shipment record created before.
shipment_confirmed_beforestring · date-timeISO 8601 — confirmed date upper bound.
shipment_confirmed_afterstring · date-timeISO 8601 — confirmed date lower bound.
package_label_created_beforestring · date-timeISO 8601 — buyer label creation date upper bound.
package_label_created_afterstring · date-timeISO 8601 — buyer label creation date lower bound.
shipped_beforestring · date-timeISO 8601 — shipped date upper bound.
shipped_afterstring · date-timeISO 8601 — shipped date lower bound.
estimated_delivery_beforestring · date-timeISO 8601 — estimated delivery upper bound.
estimated_delivery_afterstring · date-timeISO 8601 — estimated delivery lower bound.
shipment_delivery_beforestring · date-timeISO 8601 — actual delivery upper bound.
shipment_delivery_afterstring · date-timeISO 8601 — actual delivery lower bound.
requested_pick_up_beforestring · date-timeISO 8601 — requested pick-up upper bound.
requested_pick_up_afterstring · date-timeISO 8601 — requested pick-up lower bound.
scheduled_pick_up_beforestring · date-timeISO 8601 — scheduled pick-up upper bound.
scheduled_pick_up_afterstring · date-timeISO 8601 — scheduled pick-up lower bound.
current_shipment_statusstringfilter by shipment status. Allowed: Created | TransportationRequested | CarrierAssigned | Shipped.
vendor_shipment_identifierstringFilter by vendor's own shipment ID.
buyer_reference_numberstringFilter by Amazon buyer reference number.
buyer_warehouse_codestringshipToParty.partyId value from the shipment.
seller_warehouse_codestringsellingParty.partyId value from the shipment.
limitinteger · 1–50Max records returned, 1–50 (Amazon default 50).
sort_orderstringASC or DESC.ASCDESC
next_tokenstringthe cursor from the previous call's data.nextToken; omit for the first page.

Result

Every tool answers {notification, data, human_action}; data carries:

  • data.shipments — list of shipment detail dicts.
  • data.count — number of shipments returned.
  • data.nextToken — pass to next call if present.

Workflow

  • 1. Call with created_after/created_before to fetch recent shipments. 2. Narrow by a date pair (shipped_*, shipment_confirmed_*, estimated_delivery_*, shipment_delivery_*, requested_pick_up_*, scheduled_pick_up_*) or an identifier (vendor_shipment_identifier, buyer_reference_number, buyer_warehouse_code, seller_warehouse_code). 3. While data.nextToken is present, call again with it as next_token.

On this page

Actions

View as Markdown

Ask an assistant

Ask ChatGPTAsk Claude