List the shipments assigned to you

GET

/api/v1/scent/orders

const url = 'https://api-omni-vendors.linra.net/api/v1/scent/orders?page=1&pageSize=20&status=Pending';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns a paged, cost-stripped list of your own fulfilment groups — the API’s term for the shipment/parcel assigned to you (groupId in the response). Never a sibling vendor’s shipment, Linra’s own Self-fulfilled one, or an order’s OTHER vendors’ lines. No partner identity, order totals, commission, or any money field is ever present (see the schema’s own field-by-field remarks). Set changedSince for delta sync: only groups whose PARENT ORDER changed strictly after that instant are returned, ordered by change time ascending. A sibling vendor’s own group changing on the SAME order also bumps this timestamp — treat a repeat of your own unchanged group as a safe, over-inclusive signal, never under-inclusive, and reconcile idempotently. Requires the Orders capability.

Authorizations

vendorBearer

Parameters

Query Parameters

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

status

string

Allowed values: Pending Packed Shipped Delivered Cancelled Returned PendingSourcing

changedSince

string format: date-time

Only return rows whose parent order changed strictly after this UTC instant (delta sync).

Responses

200

A page of fulfilment groups.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

items

Array<object>

Deliberately EXCLUDES the reselling partner’s identity, any customer/external reference, and every money/tax field (order total, commission, VAT, currency, discounts, tax-registration numbers) and the internal saga correlation id — none of it is the vendor’s business. You are paid via your own commercial terms with Linra, tracked entirely on the offer/cost-push side, never derived from what a partner paid.

object

groupId

string format: uuid

orderGlobalId

Linra’s own canonical order id — stable across both sides for support/correlation. Never the partner’s own external reference.

string

status

string

Allowed values: Pending Packed Shipped Delivered Cancelled Returned PendingSourcing

vendorOrderId

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

string

nullable

trackingRef

string

nullable

carrier

The carrier previously recorded for this group’s own shipment, if any — your own shipment, safe to echo back.

string

Allowed values: Aramex SaudiPost Smsa Other

carrierNameOther

Set alongside carrier == Other.

string

nullable

packedAt

string format: date-time

nullable

shippedAt

string format: date-time

nullable

deliveredAt

string format: date-time

nullable

shipRecipient

string

shipLine1

string

shipLine2

string

nullable

shipCity

string

shipRegion

string

nullable

shipPostalCode

string

nullable

shipCountry

string

shipPhone

string

lines

Array<object>

Trimmed to exactly what’s needed to pack the shipment. No money field of any kind is present.

object

lineId

string format: uuid

variantId

string format: uuid

sku

The catalog SKU for this variant, resolved regardless of the variant’s current active state.

string

quantity

integer

pagination

object

page

integer

pageSize

integer

totalCount

integer

totalPages

integer

Example

{
  "state": "SUCCESS",
  "payload": {
    "items": [
      {
        "status": "Pending",
        "carrier": "Aramex"
      }
    ]
  }
}

403

Your token doesn’t carry the capability this endpoint requires.

application/json

object

state

required

string

payload

details

object

Examples

missingCapability

{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

429

Too many requests. Retry after the Retry-After header (seconds).

application/json

object

state

required

string

payload

details

object

Example

{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Retry-After

integer

Seconds to wait before retrying.