Skip to main content
GET
/
api
/
v1
/
omni
/
:app_id
/
:store_group
/
:market
/
:locale
/
variants
/
search
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "attributes": {},
      "brand": {
        "name": "<string>",
        "series": {
          "name": "<string>",
          "slug": "<string>"
        },
        "slug": "<string>"
      },
      "id": "<string>",
      "images": [
        {
          "alt": "<string>",
          "attributes": {},
          "blurhash": "<string>",
          "sort": 123,
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "prices": [
        {
          "channel_type": "B2B",
          "country_of_sale": "<string>",
          "markets": [
            {
              "base_price_amount": 123,
              "country_code": "<string>",
              "country_codes": [
                "<string>"
              ],
              "currency": "<string>",
              "id": "<string>",
              "market_id": "<string>",
              "market_slug": "<string>",
              "on_sale": true,
              "sale_end_timestamp": "<string>",
              "sale_price_amount": 123,
              "sale_start_timestamp": "<string>"
            }
          ],
          "store_group_description": "<string>",
          "store_group_id": "<string>",
          "store_group_name": "<string>",
          "store_group_slug": "<string>"
        }
      ],
      "product_id": "<string>",
      "product_name": "<string>",
      "product_number": "<string>",
      "rank": 123,
      "tags": [
        {
          "attributes": {},
          "created_at": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "status": "<string>",
          "updated_at": "<string>"
        }
      ],
      "variant_name": "<string>",
      "variant_number": "<string>",
      "videos": [
        {
          "attributes": {},
          "description": "<string>",
          "title": "<string>",
          "url": "<string>"
        }
      ]
    }
  ],
  "page": 123,
  "total": 123,
  "total_pages": 123
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and a token.

Path Parameters

app_id
string
required

App ID

store_group
string
required

Store group

locale
string
required

Alpha 2 country code. e.g se

market
string
required

The related product market

Query Parameters

page
integer

Page number (default: 1)

per_page
integer

Items per page (default: 50, max: 50)

q
string
required

Search query

only_active
boolean

Filter by active status only (default: false)

in_stock
boolean

Filter by stock availability

in_stock_in
string

Filter by stock availability in a specific warehouse (by warehouse slug)

sort
string

Sort order. One of name_asc, name_desc, rank (default: rank)

Response

OK

data
object[]
page
integer
total
integer
total_pages
integer