List scents

GET

/api/v1/scent/catalog/scents

const url = 'https://api-omni.linra.net/api/v1/scent/catalog/scents?page=1&pageSize=20&activeOnly=true';
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/scents?page=1&pageSize=20&activeOnly=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Query Parameters

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

lang

string

brandId

string format: uuid

concentration

string

audience

string

changedSince

string format: date-time

Only return rows changed strictly after this UTC instant. See the Catalog delta sync guide.

activeOnly

boolean

default: true

Responses

200

A page of scents. When changedSince is set, ordered by change time ascending instead of the default order.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

items

Array<object>

object

string format: uuid

brandId

string format: uuid

name

string

concentration

string

nullable

audience

string

nullable

description

string

nullable

isActive

boolean

createdDate

string format: date-time

lastModifiedDate

string format: date-time

nullable

pagination

object

page

integer

pageSize

integer

totalCount

integer

totalPages

integer

Example

{
  "state": "SUCCESS"
}

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.