Skip to main content
GET
/
api
/
v1
/
omni
/
:app_id
/
:store_group
/
:market
/
:locale
/
products
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "attributes": {},
      "brands": {
        "name": "<string>",
        "series": {
          "name": "<string>",
          "slug": "<string>"
        },
        "slug": "<string>"
      },
      "categories": [
        {
          "attributes": {},
          "full_path_name": [
            "<string>"
          ],
          "id": "<string>",
          "name": "<string>",
          "order": 123,
          "parent_id": "<string>",
          "redirects": {},
          "sort_order": 123,
          "status": "<string>",
          "sub_categories": [
            {
              "attributes": {},
              "full_path_name": [
                "<string>"
              ],
              "id": "<string>",
              "name": "<string>",
              "parent_id": "<string>",
              "redirects": {},
              "sort_order": 123,
              "status": "<string>",
              "sub_categories": "<array>",
              "uri": "<string>"
            }
          ],
          "uri": "<string>"
        }
      ],
      "collections": [
        {
          "children": [
            {
              "children": "<array>",
              "id": "<string>",
              "parent_id": "<string>",
              "title": "<string>",
              "uri": "<string>"
            }
          ],
          "id": "<string>",
          "order": 123,
          "parent_id": "<string>",
          "title": "<string>",
          "uri": "<string>"
        }
      ],
      "created_at": "<string>",
      "custom_fields": {},
      "description": "<string>",
      "files": [
        {
          "attributes": {},
          "title": "<string>",
          "type": "<string>",
          "url": "<string>"
        }
      ],
      "html_description": "<string>",
      "html_short_description": "<string>",
      "id": "<string>",
      "images": [
        {
          "alt": "<string>",
          "attributes": {},
          "blurhash": "<string>",
          "sort": 123,
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "is_active": true,
      "meta_description": "<string>",
      "meta_title": "<string>",
      "product_name": "<string>",
      "product_number": "<string>",
      "rank": 123,
      "redirects": {},
      "related_products": [
        {
          "attributes": {},
          "id": "<string>",
          "image": "<string>",
          "product_name": "<string>",
          "product_number": "<string>",
          "slug": "<string>",
          "type": "<string>"
        }
      ],
      "short_description": "<string>",
      "slug": "<string>",
      "slug_translations": {},
      "status": "<string>",
      "tags": [
        {
          "attributes": {},
          "created_at": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "order": 123,
          "status": "<string>",
          "updated_at": "<string>"
        }
      ],
      "third_party_links": [
        {
          "id": "<string>",
          "title": "<string>",
          "type": "<string>",
          "url": "<string>"
        }
      ],
      "updated_at": "<string>",
      "variants": [
        {
          "attributes": {},
          "description": "<string>",
          "dimensions": {
            "capacity_milliliter": 123,
            "depth": 123,
            "diameter": 123,
            "height": 123,
            "length": 123,
            "weight": 123,
            "width": 123
          },
          "id": "<string>",
          "image_url": "<string>",
          "images": [
            {
              "alt": "<string>",
              "attributes": {},
              "blurhash": "<string>",
              "sort": 123,
              "title": "<string>",
              "url": "<string>"
            }
          ],
          "inventories": [
            {
              "inventory_date": "<string>",
              "quantity": 123,
              "warehouse": {
                "address": {
                  "city": "<string>",
                  "country": "<string>",
                  "postal_code": "<string>",
                  "region": "<string>",
                  "street_address": "<string>"
                },
                "description": "<string>",
                "id": "<string>",
                "name": "<string>"
              }
            }
          ],
          "is_active": true,
          "packaging_dimensions": {
            "capacity_milliliter": 123,
            "depth": 123,
            "diameter": 123,
            "height": 123,
            "length": 123,
            "weight": 123,
            "width": 123
          },
          "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>"
            }
          ],
          "shipping_attributes": [
            "<string>"
          ],
          "tags": [
            {
              "attributes": {},
              "created_at": "<string>",
              "filterable": true,
              "id": "<string>",
              "key": "<string>",
              "name": "<string>",
              "status": "<string>",
              "updated_at": "<string>"
            }
          ],
          "validate_stock": true,
          "variant_name": "<string>",
          "variant_number": "<string>",
          "videos": [
            {
              "attributes": {},
              "description": "<string>",
              "title": "<string>",
              "url": "<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

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

​
only_active
boolean

Filter only active products

​
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 created_at_desc, created_at_asc, name_asc, name_desc, category_order_asc, category_order_desc, collection_order_asc, collection_order_desc, tag_order_asc, tag_order_desc, price_asc, price_desc

​
sku
string[]

Filter by SKUs

​
variant_name
string[]

Filter by Variant Names

​
collection
string[]

Filter on collections slugs

​
tag
string[]

Filter by tags key. e.g black-friday

​
slug
string[]

Filter by product slugs

​
brand
string[]

Filter by brand slug

​
serie
string[]

Filter by serie slug

​
category
string[]

Filter by category slug

​
smart_list
string[]

Filter by smart list slug

​
static_list
string[]

Filter by static list slug

​
not_in_sku
string[]

Exclude products with these SKUs

​
not_in_category
string[]

Exclude products in these categories (by slug)

​
not_in_collection
string[]

Exclude products in these collections (by uri)

​
not_in_tag
string[]

Exclude products with these tags (by key)

​
not_in_brand
string[]

Exclude products with these brands (by slug)

​
not_in_serie
string[]

Exclude products with these series (by slug)

​
price_gte
number

Filter by minimum price (inclusive)

​
price_lte
number

Filter by maximum price (inclusive)

​
attributes
string[]

Filter by attributes (format: template_key/value_key, e.g., color/blue). Product must match all specified attributes.

​
category_id
string[]

Filter by category IDs (UUIDs). Product must be in at least one of the specified category IDs.

​
not_in_category_id
string[]

Exclude products in these category IDs (UUIDs).

​
search
string

Full text search on products

​
include_child_category_products
boolean

Include products from child categories when filtering by category or category_id

Response

OK

​
data
object[]
​
page
integer
​
total
integer
​
total_pages
integer