Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Products::Collection

List Collections

List Collections

get/workspaces/{workspace_id}/products/collections

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

idstring

A comma-separated list of collection IDs to filter by.

visible_in_storetrue | false

Filter collections by visibility in the online store.

archivedtrue | false

Filter collections by archived state.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "id": "1,2,3",
  "visible_in_store": true,
  "archived": true
}

Response

OK

idinteger

Numeric ID of the collection

public_idstring nullable

Public ID is a string version of the numeric ID

workspace_idinteger

ID reference to the workspace to which the collection belongs

namestring

Name of the products collection

descriptionstring nullable

Description of the collection

collection_typestring nullable

Type of the collection (manual or automatic)

{"stackTrail":"components:schemas:ProductsCollectionAttributes:properties:product_ids","oasType":"schema","type":"unknown","description":"Array of product IDs in the collection. Updating with invalid or non-workspace product IDs will result in an error. If IDs from existing products in the collection are left out, they will be removed from the collection. You can also remove all the products from a collection by providing an empty array."}
sort_method'manually' | 'name_asc' | 'name_desc' | 'price_desc' | 'price_asc' | 'added_at_desc' | 'added_at_asc' | 'created_at_desc' | 'created_at_asc' nullable

Method used to sort the products in the collection

archivedboolean nullable

Whether the collection is archived

image_idstring nullable

Collection image

visible_in_storeboolean nullable

Whether the collection is visible in the online store

current_pathstring nullable

Current path of the collection

seo_titlestring nullable

Title of the collection for SEO purposes

seo_descriptionstring nullable

Description of the collection for SEO purposes

seo_indexablestring nullable

Whether the collection is indexable by search engines

social_image_idstring nullable

Image for social sharing

created_atstring nullable

Date and time the collection was created

updated_atstring nullable

Date and time the collection was last updated

Example response

[
  {
    "id": 1,
    "public_id": "bkDhwu",
    "workspace_id": 42000,
    "name": "Example Collection",
    "description": "Example Description",
    "collection_type": "manual",
    "product_ids": [],
    "sort_method": "manually",
    "archived": false,
    "image_id": null,
    "visible_in_store": true,
    "current_path": null,
    "seo_title": "Example SEO Title",
    "seo_description": "Example SEO Description",
    "seo_indexable": null,
    "social_image_id": null,
    "created_at": null,
    "updated_at": null
  }
]