Skip to content
Linra Omni Developer Docs

List the caller's scent orders

GET
/api/v1/orders/scent
curl --request GET \
  --url 'https://api-omni.linra.net/api/v1/orders/scent?page=1&pageSize=20' \
  --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
status
string
fromDate
string format: date-time
toDate
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

A page of scent orders.

Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required
object
items
Array<object>
object
id
string format: uuid
orderGlobalId
string
sagaId
string
partnerId
string format: uuid
externalReference
string
customerRef
string
nullable
totalAmount
number format: decimal
totalCommission
number format: decimal
currency
string
status
string
lines
Array<object>

Deliberately omits internal cost/wholesale fields.

object
id
string format: uuid
variantId
string format: uuid
quantity
integer
returnedQuantity
integer
unitAmount
number format: decimal
lineTotal
number format: decimal
partnerCommission
number format: decimal
nullable
pricingMode
string
source
string
nullable
taxClassification
string
vatRateApplied
number format: decimal
lineGoodsVatAmount
number format: decimal
lineCommissionVatAmount
number format: decimal
nullable
unitAmountDisplay
number
nullable
lineTotalDisplay
number
nullable
partnerCommissionDisplay
number
nullable
fulfillmentGroups
Array<object>
object
id
string format: uuid
status
string
deliveredAt
string format: date-time
nullable
deliveryRollup
object
totalGroups
integer
deliveredGroups
integer
totalGoodsVatAmount
number format: decimal
totalCommissionVatAmount
number format: decimal
totalAmountWithVat
number
nullable
totalCommissionWithVat
number
nullable
taxPoint
string format: date-time
nullable
platformTaxRegistrationNumber
string
nullable
partnerTaxRegistrationNumber
string
nullable
partnerIsVatRegistered
boolean
displayCurrency
string
nullable
rate
number
nullable
totalAmountDisplay
number
nullable
pagination
object
page
integer
pageSize
integer
totalCount
integer
totalPages
integer
Example
{
  "state": "SUCCESS",
  "payload": {
    "items": [
      {
        "currency": "SAR"
      }
    ]
  }
}

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.