Skip to content
Linra Omni Vendor Docs

Get vendor return request

Get one of your own return requests by id.

Returns

GET/api/v1/scent/returns/{id}

Reads a return request whose destination is your own vendor id (ReturnDestinationType == Supplier); any other request 404s (no existence leak). This is the resource the Location header of addVendorReturnEvidence’s 201 points to. Requires the Orders capability.

Path parameters

idstring (uuid)Required

The return request id.

Response

idstring (uuid)
returnRequestNumberstring
statusstring (enum)

Scent’s full return-request lifecycle. This door only ever ACTS on a request in InTransit/Received/UnderInspection, but a GET reflects any of the full 11 values (e.g. a request still Pending/Approved awaiting internal authorization, or a terminal InspectionRejected/RefundReleased/Withdrawn) — the field is documented exhaustively per the fleet’s R-DOCENUMS convention rather than narrowed to only the states this door itself transitions through.

requestedAtstring (date-time)
receivedAtstring (date-time)
inspectionStartedAtstring (date-time)
inspectionDecidedAtstring (date-time)
inspection.receivedAtstring (date-time)
inspection.inspectionStartedAtstring (date-time)
inspection.inspectionWindowDeadlinestring (date-time)
inspection.outcomeobject

A genuine defect (AcceptedDefect), a sound/changed-mind item (AcceptedSound), or Linra rejects the return outright (Rejected, e.g. opened/used with no defect found).

inspection.supplierProposedOutcomeobject

A genuine defect (AcceptedDefect), a sound/changed-mind item (AcceptedSound), or Linra rejects the return outright (Rejected, e.g. opened/used with no defect found).

inspection.requiresStaffReviewboolean
inspection.evidencearray of object
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 return request id, one belonging to another vendor, or one not destined to a supplier at all (a Linra-sorting-point-bound return — never reachable on this API).
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/returns/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b \
--header 'Authorization: Bearer $TOKEN'

Response

{
"state": "SUCCESS",
"payload": {
"id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"returnRequestNumber": "string",
"status": "Pending",
"requestedAt": "2026-08-22T09:14:03Z",
"receivedAt": "2026-08-22T09:14:03Z",
"inspectionStartedAt": "2026-08-22T09:14:03Z",
"inspectionDecidedAt": "2026-08-22T09:14:03Z",
"inspection": {
"receivedAt": "2026-08-22T09:14:03Z",
"inspectionStartedAt": "2026-08-22T09:14:03Z",
"inspectionWindowDeadline": "2026-08-22T09:14:03Z",
"outcome": {},
"supplierProposedOutcome": {},
"requiresStaffReview": true,
"evidence": [
{
"id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"url": "https://your-integration.example.com/webhooks/linra",
"kind": "Photo",
"uploadedAt": "2026-08-22T09:14:03Z"
}
]
},
"lines": [
{
"scentOrderLineId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"variantId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"sku": "string",
"quantity": 0,
"reasonCode": "Damaged"
}
]
},
"details": null
}