Skip to content
Linra Omni Developer Docs

List return requests by customer

List your own return requests for one end customer.

Returns

GET/api/v1/scent/return-requests/by-customer/{customerRef}

API Docs Review effort, Phase N2 (D71): returns the calling partner’s own return requests (every status) for one end customer, identified by the required customerRef path segment (the same opaque reference used at checkout) — newest first. An unknown or never-used customerRef simply returns an empty page (there’s no separate existence to 404 on).

Path parameters

customerRefstringRequired

The per-customer cart/registration selector this endpoint operates on (max 128 chars, URL-encoded) — every cart/wishlist/stock-notification endpoint carries it in the path (API Docs Review effort, Phase F/G, D29/R-CUSTOMERREF). Also the value a per-customer redemption cap, if any, is checked against.

Query parameters

pageinteger

1-based page number (default 1). A value below 1, or one that is not a whole number, returns 400 VALIDATION_INVALID_PAGE.

pageSizeinteger

Items per page, 1 to 100 (default 20). Any other value returns 400 VALIDATION_INVALID_PAGE_SIZE; it is never silently clamped.

Response

itemsarray of object
pagination.pageinteger
pagination.pageSizeinteger
pagination.totalCountinteger
pagination.totalPagesinteger
pagination.hasPreviousboolean

Whether there is a previous page.

pagination.hasNextboolean

Whether there is a next page.

Other responses

400A query parameter was rejected. Unknown parameter name: VALIDATION_UNKNOWN_QUERY_PARAMETER (details.allowedParameters). Value that does not parse (id, enum, number, boolean): VALIDATION_INVALID_QUERY_PARAMETER (enums add details.allowedValues). Unknown include token: VALIDATION_UNKNOWN_INCLUDE (details.allowedValues). pageSize outside 1–100: VALIDATION_INVALID_PAGE_SIZE. page below 1: VALIDATION_INVALID_PAGE. Unparseable date, or a from/to pair with from after to: VALIDATION_INVALID_DATE. details.errors names every offending parameter.
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 Errors guide.
403The route is not available to your credential (FORBIDDEN).
404No API route matches this path (NOT_FOUND_ROUTE). A missing resource on a real route returns that service’s own NOT_FOUND_* code instead.
429Too many requests — see the Rate limits guide. 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.linra.net/api/v1/scent/return-requests/by-customer/value \
--header 'Authorization: Bearer $TOKEN'

Response

{
"state": "SUCCESS",
"payload": {
"items": [
{
"id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"orderId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"fulfillmentGroupId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"returnRequestNumber": "string",
"status": "Requested",
"declineReason": "string",
"timeline": {
"requestedAt": "2026-08-22T09:14:03Z",
"decidedAt": "2026-08-22T09:14:03Z",
"waybillIssuedAt": "2026-08-22T09:14:03Z",
"collectionScheduledAt": "2026-08-22T09:14:03Z",
"inTransitAt": "2026-08-22T09:14:03Z",
"refundReleasedAt": "2026-08-22T09:14:03Z"
},
"logistics": {
"waybillNumber": "string",
"carrier": "string",
"carrierNameOther": "string",
"returnDestinationType": "SortingPoint"
},
"inspection": {
"receivedAt": "2026-08-22T09:14:03Z",
"inspectionStartedAt": "2026-08-22T09:14:03Z",
"decidedAt": "2026-08-22T09:14:03Z",
"outcome": "Accepted",
"shippingFeeRefundApplies": true
},
"refund": {
"currency": "SAR",
"goods": {
"net": 0,
"vat": 0,
"total": 0
},
"commissionClawback": 0,
"shippingFeeRefund": 0,
"total": 0
},
"lines": [
{
"id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"scentOrderLineId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"allocationId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"quantity": 0,
"reasonCode": "string"
}
]
}
],
"pagination": {
"page": 0,
"pageSize": 0,
"totalCount": 0,
"totalPages": 0,
"hasPrevious": true,
"hasNext": true
}
},
"details": null
}