Skip to main content
GET
/
collections
Error
A valid request URL is required to generate request examples
[
  {
    "collection_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "handle": "<string>",
    "image_urls": [
      "<string>"
    ],
    "has_depict_configuration": true,
    "sync_back_to_shopify": true,
    "unpin_oos": true,
    "shopify_updated_at": "2023-11-07T05:31:56Z",
    "use_collection_specific_boost_bury": true,
    "main_version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "n_products": 123,
    "n_pinned_main_product_ids": 123,
    "updated_at": "2023-11-07T05:31:56Z",
    "product_images": [
      "<string>"
    ]
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

merchant_id
string
required

Response

Successful Response

collection_id
string
required
title
string
required
description
string
required
handle
string
required
image_urls
string[]
required
shopify_sort_order
enum<string>
required
Available options:
ALPHA_ASC,
ALPHA_DESC,
BEST_SELLING,
CREATED,
CREATED_DESC,
MANUAL,
PRICE_ASC,
PRICE_DESC
sort_order
enum<string>
required
Available options:
ALPHA_ASC,
ALPHA_DESC,
BEST_SELLING,
TRENDING,
CREATED,
CREATED_DESC,
PRICE_ASC,
PRICE_DESC,
STOCK_DESC,
CLICKS_DESC,
MANUAL
has_depict_configuration
boolean
required

'Depict configuration' meaning sort order, pinned products, content blocks, etc.

sync_back_to_shopify
boolean
required
unpin_oos
boolean
required
shopify_updated_at
string<date-time>
required
use_collection_specific_boost_bury
boolean
required
main_version
string<uuid> | null
required
n_products
integer
required
n_pinned_main_product_ids
integer | null
required
updated_at
string<date-time> | null

The last time the Depict configuration for this collection was updated

product_images
string[] | null