Get a variant's current availability

GET

/api/v1/scent/catalog/variants/{id}/availability

const url = 'https://api-omni.linra.net/api/v1/scent/catalog/variants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/availability';
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.linra.net/api/v1/scent/catalog/variants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/availability \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

The variant’s availability state.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

variantId

string format: uuid

availability

A simple 2-state in-stock indicator — distinct from VariantAvailabilityState’s 3-state Available/Limited/Unavailable used on cart/quote responses (which carry line-quantity context this endpoint doesn’t have).

string

Allowed values: OutOfStock InStock

selfAvailable

boolean

vendorAvailable

boolean

Example

{
  "state": "SUCCESS",
  "payload": {
    "availability": "OutOfStock"
  }
}

429

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

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

Retry-After

integer

Seconds to wait before retrying.