Skip to main content
POST
Look Up Shipment

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Body

application/json
account_id
string
required

The selling account, prefixed biz_.

Maximum string length: 255
Example:

"biz_xxxxxxxxxxxxxx"

email
string<email>
required

The buyer's current receipt email.

Maximum string length: 254
Example:

"marcus@shinetime.example"

order_number
string

The payment ID prefixed pay_, or the order number printed on the receipt (optional leading #). Supply this or tracking_number, not both.

Maximum string length: 255
Example:

"pay_xxxxxxxxxxxxxx"

tracking_number
string

The exact carrier tracking number. Supply this or order_number, not both.

Maximum string length: 255

Response

shipment found

payment_id
string
required

The matching payment, prefixed pay_.

Example:

"pay_xxxxxxxxxxxxxx"

shipment
object | null
required

The payment's latest shipment, or null when a paid physical purchase has no tracking yet.