Skip to content
Linra Omni Vendor Docs

Get vendor order by ID

Get one shipment assigned to you.

Orders

GET/api/v1/scent/orders/{groupId}

Returns a single fulfilment group by ID, scoped to the calling vendor. A group belonging to another vendor is reported as 404. Requires the Orders capability.

Path parameters

groupIdstring (uuid)Required

Response

groupIdstring (uuid)
statusstring (enum)
vendorOrderIdstring

Your own order/reference id at your end, if previously pushed.

packedAtstring (date-time)
shippedAtstring (date-time)
deliveredAtstring (date-time)
shipTo.recipientstring
shipTo.line1string
shipTo.line2string
shipTo.citystring
shipTo.regionstring
shipTo.postalCodestring
shipTo.countrystring
shipTo.phonestring
tracking.refstring

Carrier tracking reference, if set (on Shipped).

tracking.carrierobject

One of the three fixed carriers, or Other (requires carrierNameOther on the request).

tracking.carrierNameOtherstring

Set alongside carrier == Other.

linesarray of object

Other responses

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Rate limits & errors guide.
403Your token doesn’t carry the capability this endpoint requires.
404Unknown fulfilment group id, or one belonging to another vendor.
429Too many requests. Retry after the Retry-After header (seconds).
502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.
503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.
504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.
curl --request GET \
--url https://api-omni-vendors.linra.net/api/v1/scent/orders/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b \
--header 'Authorization: Bearer $TOKEN'

Response

{
"state": "SUCCESS",
"payload": {
"groupId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"status": "Pending",
"vendorOrderId": "string",
"packedAt": "2026-08-22T09:14:03Z",
"shippedAt": "2026-08-22T09:14:03Z",
"deliveredAt": "2026-08-22T09:14:03Z",
"shipTo": {
"recipient": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"phone": "string"
},
"tracking": {
"ref": "string",
"carrier": {},
"carrierNameOther": "string"
},
"lines": [
{
"lineId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"variantId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"sku": "string",
"quantity": 0
}
]
},
"details": null
}