Skip to content
Linra Omni Developer Docs

List all your orders, across every product type

GET
/api/v1/orders
curl --request GET \
  --url 'https://api-omni.linra.net/api/v1/orders?page=1&pageSize=20&productType=Scent&status=Processing' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1
pageSize
integer
default: 20 >= 1 <= 100
productType

Scent is the only product line documented on this site — see the Changelog for why Topup/eSIM were removed. The underlying spine’s status vocabulary is shared across every product it has ever supported; this document scopes strictly to what a partner can actually reach today.

string
Allowed values: Scent
status

The one status vocabulary every product’s order maps into. Today only Processing, Failed, and PartiallyReturned are actually written — fulfillment-status sync into Completed/Cancelled/Returned is a tracked future improvement, not yet live.

string
Allowed values: Processing Completed Failed Cancelled PartiallyReturned Returned
from
string format: date-time
to
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

A page of unified order summaries.

Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required
object
items
Array<object>
object
orderGlobalId
string
partnerId
string format: uuid
productType

Scent is the only product line documented on this site — see the Changelog for why Topup/eSIM were removed. The underlying spine’s status vocabulary is shared across every product it has ever supported; this document scopes strictly to what a partner can actually reach today.

string
Allowed values: Scent
productOrderId
string format: uuid
nullable
externalReference
string
amount
number format: decimal
currency
string
status

The one status vocabulary every product’s order maps into. Today only Processing, Failed, and PartiallyReturned are actually written — fulfillment-status sync into Completed/Cancelled/Returned is a tracked future improvement, not yet live.

string
Allowed values: Processing Completed Failed Cancelled PartiallyReturned Returned
failureCode
string
nullable
createdAt
string format: date-time
completedAt
string format: date-time
nullable
displayCurrency

Set only when the partner’s preferred display currency differs from SAR.

string
nullable
rate
number
nullable
amountDisplay
number
nullable
pagination
object
page
integer
pageSize
integer
totalCount
integer
totalPages
integer
Example
{
  "state": "SUCCESS",
  "payload": {
    "items": [
      {
        "productType": "Scent",
        "currency": "SAR",
        "status": "Processing"
      }
    ]
  }
}

429

Section titled “429”

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Example
{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.