Method GET/partner
Read a B2B order back by its order reference. Requires the dispatch:write scope.
You read an order back by its reference, the one you sent at creation. The whole flow is in the guide Tie each unit to its order.
#
API key in the Authorization header, Bearer format, with the
dispatch:write scope. A key without it gets a 403 whose message names the
missing scope. The plan of the key's brand must include API access, and the
shipment's brand must be on the Compliance + Identity offer.
Authorization: Bearer votre_clef#Rate limit
The same as the other partner routes: one counter per key and one for the sum of your brand's keys, 120 calls per 60-second window by default. A read takes nothing from the daily quota.
#Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_ref | string | yes | The order reference, 1 to 100 characters. |
brand_code | string | no | With a reseller key, the client brand. |
#Example request
curl -i -X GET "https://api.sealtrust.io/v1/partner/dispatch/shipments?order_ref=SO-2026-1042" \
-H "Authorization: Bearer st_live_0000000000000000000000000000000000000000000000"#Example response
HTTP 200, the same object as the creation, without the created field.
#Errors
| Code | Condition | What to do |
|---|---|---|
| 401 | Key missing, malformed or unknown. | Send Authorization: Bearer <your key> with the whole key. |
| 403 | The key lacks the dispatch:write scope. Message Missing required scopes: dispatch:write. | Create a key that carries this scope. |
| 403 | The brand is on the Compliance offer. detail.code is OFFER_EXCLUDES_IDENTITY and detail.feature is dispatch. Nothing is recorded. | Move to the Compliance + Identity offer. Retrying changes nothing. |
| 429 | Rate limit or daily quota reached. | Wait the number of seconds in Retry-After, or midnight UTC for the quota. |
| 404 | No order of your brand has this reference. | Check the reference and brand_code. |
Was this page helpful?
Your answer opens a pre-filled email in your mail app, addressed to contact@sealtrust.io. You read it over before sending it.