Get cart

Cart

GET/api/v1/scent/cart/{customerRef}

Returns the caller’s cart for the required customerRef path segment — an opaque, partner-namespaced reference for whichever of your own end customers this cart belongs to (API Docs Review effort, Phase F, D29: every cart endpoint carries customerRef in the path — it is no longer an optional query parameter). Pure read — LAZY-CREATE (Phase F, D28): when no cart row exists yet for this customerRef, returns 200 with an empty representation (id: null, status: "None", pricedAt: null, zeroed totals) rather than a 404 or a created row; the row is born on the first POST .../items call. A line whose variant has since become unavailable or unpriceable is KEPT in the response (pricing: null, availability reflecting the real state) rather than silently dropped (Phase F, D32) — totals still reflect only the priced lines.

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.

Response

idstring (uuid)

Null when there is no persisted cart row yet (a lazy-create GET/preview never creates one).

customerRefstring

statusstring (enum)

None is a RESPONSE-ONLY value for the 200-empty (no cart row) representation.

baseCurrencystring

Hoisted from each line’s own currency (the Scent catalog is SAR-only).

itemsarray of object

totals.chargedWithVatnumber (decimal)

Sum of every line’s goods-sale total including VAT, PLUS the order-level shipping fee — what checkout would actually charge.

totals.commissionWithVatnumber (decimal)

Sum of every CREDITABLE (Retail-mode) line’s commission including VAT — 0 for an all-Wholesale cart, never null.

totals.netAfterCommissionnumber (decimal)

chargedWithVat minus commissionWithVat.

totals.shippingobject

totals.displayobject

Populated only for a supported non-SAR X-Partner-Currency.

pricedAtstring (date-time)

The server UTC time of THIS read; null for the 200-empty representation.

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 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

curl --request GET \
  --url https://api-omni.linra.net/api/v1/scent/cart/value \
  --header 'Authorization: Bearer $TOKEN'

JavaScript

const res = await fetch('https://api-omni.linra.net/api/v1/scent/cart/value', {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});
const { payload } = await res.json();

C#

var response = await httpClient.GetAsync("https://api-omni.linra.net/api/v1/scent/cart/value");

var envelope = await response.Content.ReadFromJsonAsync<ApiResponse<CartResponse>>();

Response

{
  "state": "SUCCESS",
  "payload": {
    "id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
    "customerRef": "string",
    "status": "None",
    "baseCurrency": "SAR",
    "items": [
      {
        "variantId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
        "sku": "string",
        "sizeMl": 0,
        "quantity": 0,
        "pricing": {
          "currency": "SAR",
          "unitPrice": 0,
          "line": {
            "subtotal": 0,
            "goodsVatAmount": 0,
            "totalWithVat": 0,
            "commission": {
              "amount": null,
              "vatAmount": null,
              "netAfterCommission": null,
              "rate": null
            }
          },
          "rrp": 0,
          "display": {
            "unitPrice": 0,
            "line": {
              "subtotal": null,
              "goodsVatAmount": null,
              "totalWithVat": null,
              "commission": null
            },
            "rrp": 0
          }
        },
        "availability": {
          "state": "Available",
          "availableQuantity": 0,
          "insufficientForQuantity": true
        },
        "marketing": {
          "currentPrice": 0,
          "compareAtPrice": 0,
          "discountPercent": 0,
          "badges": [
            "LIMITED"
          ],
          "currentPriceDisplay": 0,
          "compareAtPriceDisplay": 0
        }
      }
    ],
    "totals": {
      "chargedWithVat": 0,
      "commissionWithVat": 0,
      "netAfterCommission": 0,
      "shipping": {
        "amount": 0,
        "vatAmount": 0,
        "amountWithVat": 0,
        "freeThreshold": 0,
        "isFree": true
      },
      "display": {
        "currency": "string",
        "rate": 0,
        "chargedWithVat": 0,
        "commissionWithVat": 0,
        "netAfterCommission": 0,
        "shipping": {
          "amount": 0,
          "vatAmount": 0,
          "amountWithVat": 0,
          "freeThreshold": 0
        }
      }
    },
    "pricedAt": "2026-08-22T09:14:03Z"
  },
  "details": null
}