Fetch all collections

GET

api

omni

:app_id

:store_group

:market

:locale

collections

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "children": "<array>",
      "id": "<string>",
      "parent_id": "<string>",
      "title": "<string>",
      "uri": "<string>"
    }
  ],
  "page": 123,
  "total": 123,
  "total_pages": 123
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

app_id

string

required

App ID

market

string

required

Market

locale

string

required

Locale

store_group

string

required

Store group slug

Query Parameters

page

integer

Page number (default: 1)

only_active

boolean

Only active collections

per_page

integer

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

string[]

Filter by collection ID

Response

List of collections

data

object[]

Show child attributes

page

integer

total

integer

total_pages

integer

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "children": "<array>",
      "id": "<string>",
      "parent_id": "<string>",
      "title": "<string>",
      "uri": "<string>"
    }
  ],
  "page": 123,
  "total": 123,
  "total_pages": 123
}

{
  "message": "<string>"
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Query Parameters

Response