List variants

List variants.

Catalog

GET/api/v1/scent/variants

Returns a paged list of the variants (sizes/SKUs) in your assortment. Filter by id, scent, note, accord or end-user price range. include=pricing adds what you pay per unit (with VAT and, for a Retail-mode price, your commission); include=availability adds the 3-state availability; tax is also accepted (VAT figures are part of the pricing group). This is the call to price a variant before you add it to a cart. Passing changedSince switches to delta-sync mode — only variants changed strictly after that UTC instant, ordered oldest-changed-first instead of the default order.

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.

includestring

Comma-separated extra data. Allowed tokens: pricing (fills pricing), availability (adds availability), tax (accepted; VAT figures come with pricing). Any other token returns 400 VALIDATION_UNKNOWN_INCLUDE.

idarray of string (uuid)

Repeatable — filter to one or more ids (e.g. ?id=a&id=b). An id that does not exist simply matches nothing.

scentIdarray of string (uuid)

Repeatable — filter to one or more scents (e.g. ?scentId=a&scentId=b).

notearray of string

Repeatable — match rows whose scent carries at least one of these fragrance notes, any layer (e.g. ?note=Oud&note=Amber), case-insensitive.

accordarray of string

Repeatable — match rows whose scent carries at least one of these accords (e.g. ?accord=Woody&accord=Floral), case-insensitive.

minPricenumber (decimal)

Minimum end-user (consumer) price, inclusive — matched against marketing.currentPrice, not the price you pay.

maxPricenumber (decimal)

Maximum end-user (consumer) price, inclusive — matched against marketing.currentPrice, not the price you pay.

changedSincestring (date-time)

Only return rows changed strictly after this UTC instant. See the Catalog delta sync guide. Read as UTC when it carries no offset; a date-only value means 00:00Z. An unparseable value, or a from/to pair with from after to, returns 400 VALIDATION_INVALID_DATE.

activeOnlyboolean

Return inactive rows too when false. Must be true or false.

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/variants \
  --header 'Authorization: Bearer $TOKEN'

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

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

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

Response

{
  "state": "SUCCESS",
  "payload": {
    "items": [
      {
        "id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
        "scentId": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
        "sku": "string",
        "barcode": "string",
        "sizeMl": 0,
        "isSample": true,
        "pricing": {
          "currency": "SAR",
          "unitPrice": 0,
          "goodsVatAmount": 0,
          "totalWithVat": 0,
          "rrp": 0,
          "commission": {
            "amount": 0,
            "vatAmount": 0,
            "netAfterCommission": 0
          },
          "display": {
            "displayCurrency": "string",
            "rate": 0,
            "unitPriceDisplay": 0,
            "goodsVatAmountDisplay": 0,
            "totalWithVatDisplay": 0,
            "rrpDisplay": 0,
            "commissionAmountDisplay": 0,
            "commissionVatAmountDisplay": 0,
            "netAfterCommissionDisplay": 0
          }
        },
        "availability": {
          "state": "Available",
          "availableQuantity": 0
        },
        "marketing": {
          "currentPrice": 0,
          "compareAtPrice": 0,
          "discountPercent": 0,
          "badges": [
            "LIMITED"
          ],
          "currentPriceDisplay": 0,
          "compareAtPriceDisplay": 0
        }
      }
    ],
    "pagination": {
      "page": 0,
      "pageSize": 0,
      "totalCount": 0,
      "totalPages": 0,
      "hasPrevious": true,
      "hasNext": true
    }
  },
  "details": null
}