Collections

Collection limits

GET read_products

Fetch Collection limits and per-field constraints.

Returns the per-field maximum lengths, list limits, rule limits, and request caps that apply to Collection endpoints. This endpoint is for external integrations; Tringify admin clients use the admin contract endpoint.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/collections/limits \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/limits", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections/limits",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "fields": {
      "description": {
        "max_length": 5000
      },
      "name": {
        "max_length": 100
      },
      "rule_tag": {
        "max_length": 100
      },
      "rule_title": {
        "max_length": 200
      },
      "seo_description": {
        "max_length": 160
      },
      "seo_title": {
        "max_length": 70
      },
      "slug": {
        "max_length": 100
      }
    },
    "request_caps": {
      "bulk_delete_max_count": 200,
      "bulk_update_max_count": 200,
      "list_max_limit": 200,
      "max_per_store": 2000,
      "max_rules": 50,
      "search_max_length": 200,
      "search_max_limit": 50,
      "slug_retry_max": 100
    },
    "resource_type": "collection"
  },
  "success": true
}

List collections

GET read_products

List collections for the store.

Returns paginated collections. Pagination, sorting, search, and status validation are enforced by the storefront service.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size. Example: `20`
`search`	`string`	Search collections by name or slug. Example: `summer-sale`
`status`	`string`	Filter by active or inactive. Example: `active`
`sort_by`	`string`	Sort field from the Collection list contract. Allowed values `nameproduct_countcreated_atupdated_at` Example: `name`
`sort_direction`	`string`	Sort direction from the Collection list contract. Allowed values `ascdesc` Example: `asc`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/collections?limit=20&page=1&search=summer-sale&sort_by=name&sort_direction=asc&status=active \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections?limit=20&page=1&search=summer-sale&sort_by=name&sort_direction=asc&status=active", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections?limit=20&page=1&search=summer-sale&sort_by=name&sort_direction=asc&status=active",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "collections": [
      {
        "created_at": "2026-06-09T12:00:00Z",
        "description": "Seasonal products for summer campaigns.",
        "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "image_cdn_url": "",
        "image_id": "f_8f2a1c2b9d4e",
        "image_url": "",
        "is_active": true,
        "match_type": "all",
        "materialized_at": "2026-06-09T12:00:00Z",
        "name": "Summer Sale",
        "product_count": 42,
        "rules": [
          {
            "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
            "field": "tag",
            "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
            "include_subcategories": false,
            "operator": "equals",
            "value": "7",
            "value_label": "Summer Sale"
          }
        ],
        "seo_description": "Shop products in the Summer Sale collection.",
        "seo_title": "Summer Sale",
        "slug": "summer-sale",
        "store_id": "str_9f8a1c2b",
        "storefront_url": "https://store.example.com/collections/summer-sale",
        "template_handle": "default_collection",
        "updated_at": "2026-06-09T12:00:00Z"
      }
    ],
    "has_more": false,
    "has_previous": false,
    "limit": 20,
    "page": 1,
    "total": 1,
    "total_all": 1,
    "total_pages": 1
  },
  "success": true
}

Search collections

GET read_products

Search collections for picker-style suggestions.

Returns lightweight collection suggestions by query. This endpoint is intended for pickers and simple selection UIs.

Query parameters

Name	Type	Description
`q`	`string`	Search query. Example: `summer`
`limit`	`integer`	Suggestion count. Example: `10`
`offset`	`integer`	Number of suggestions to skip. Example: `0`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/collections/search?limit=10&offset=0&q=summer \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/search?limit=10&offset=0&q=summer", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections/search?limit=10&offset=0&q=summer",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "has_more": false,
    "options": [
      {
        "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "name": "Summer Sale",
        "product_count": 42,
        "slug": "summer-sale"
      }
    ],
    "total": 1
  },
  "success": true
}

Get a collection

GET read_products

Fetch one collection by id.

Returns the collection if it belongs to the token's store.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "collection": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Seasonal products for summer campaigns.",
      "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "image_cdn_url": "",
      "image_id": "f_8f2a1c2b9d4e",
      "image_url": "",
      "is_active": true,
      "match_type": "all",
      "materialized_at": "2026-06-09T12:00:00Z",
      "name": "Summer Sale",
      "product_count": 42,
      "rules": [
        {
          "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
          "field": "tag",
          "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
          "include_subcategories": false,
          "operator": "equals",
          "value": "7",
          "value_label": "Summer Sale"
        }
      ],
      "seo_description": "Shop products in the Summer Sale collection.",
      "seo_title": "Summer Sale",
      "slug": "summer-sale",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/collections/summer-sale",
      "template_handle": "default_collection",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Create a collection

POST write_products

Create a collection.

Creates a collection. name is required; optional text fields, image assignment, template assignment, match type, active state, and rules follow the Collection resource contract. If image_id is non-empty, it must point to an upload image in the same store and the token must also have read_files.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name` required	`string`	Collection name. Example: `Summer Sale`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `summer-sale`
`description`	`string`	Optional plain-text description. Example: `Seasonal products for summer campaigns.`
`seo_title`	`string`	Optional SEO title. Example: `Summer Sale`
`seo_description`	`string`	Optional SEO description. Example: `Shop products in the Summer Sale collection.`
`image_id`	`string`	Optional upload image file id. Non-empty values require `read_files` access to the referenced file. Example: `f_8f2a1c2b9d4e`
`template_handle`	`string`	Template assignment. On create, omitting this field or sending an empty string assigns `default_collection`. Use `default_collection` for the default Collection template, or pass an alternate Collection template handle configured for the store. On update, omit `template_handle` to leave the assignment unchanged, use `default_collection` to reset it to default, and do not send an empty string. Example: `default_collection`
`match_type`	`string`	`all` requires every rule to match; `any` requires at least one rule. Example: `all`
`is_active`	`boolean`	Whether the collection is visible on the storefront. Example: `true`
`rules`	`array<object>`	Automatic collection rules. Each rule has field, operator, optional value, and include_subcategories. Example: `[{"field":"tag","operator":"equals","value":"7"}]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 COLLECTION_NAME_REQUIRED
Name is empty after normalization.
400 COLLECTION_NAME_TOO_LONG
Name exceeds the Collection contract max length.
400 COLLECTION_NAME_INVALID_CHARS
Name contains unsupported control characters.
400 COLLECTION_DESCRIPTION_TOO_LONG
Description exceeds the Collection contract max length.
400 COLLECTION_SEO_TITLE_TOO_LONG
SEO title exceeds the Collection contract max length.
400 COLLECTION_SEO_DESCRIPTION_TOO_LONG
SEO description exceeds the Collection contract max length.
400 COLLECTION_SLUG_REQUIRED
A provided update slug is empty after normalization.
400 COLLECTION_SLUG_TOO_LONG
Slug exceeds the Collection contract max length.
400 COLLECTION_SLUG_INVALID_FORMAT
Slug is not valid for Collection URLs.
400 COLLECTION_SLUG_GENERATION_FAILED
A slug could not be generated from the supplied name.
400 COLLECTION_MATCH_TYPE_INVALID
Match type is not valid.
400 COLLECTION_RULES_LIMIT_REACHED
Rule count exceeds the Collection rule cap.
400 COLLECTION_LIMIT_REACHED
Store collection cap has been reached.
400 TEMPLATE_HANDLE_INVALID
Template handle is not valid for Collection templates.
400 TEMPLATE_HANDLE_NOT_FOUND
Template handle does not exist on the store's primary active theme for Collection.
403 STORE_ADMIN_TOKEN_RUNTIME_FORBIDDEN
A non-empty image_id requires read_files scope in addition to write_products.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.
409 COLLECTION_SLUG_DUPLICATE
Slug already exists in this store.

curl -X POST https://api-store.tringify.com/api/2025-01/collections \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Seasonal products for summer campaigns.",
  "image_id": "f_8f2a1c2b9d4e",
  "is_active": true,
  "match_type": "all",
  "name": "Summer Sale",
  "rules": [
    {
      "field": "tag",
      "operator": "equals",
      "value": "7"
    }
  ],
  "seo_description": "Shop products in the Summer Sale collection.",
  "seo_title": "Summer Sale",
  "slug": "summer-sale",
  "template_handle": "default_collection"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "Seasonal products for summer campaigns.",
    "image_id": "f_8f2a1c2b9d4e",
    "is_active": true,
    "match_type": "all",
    "name": "Summer Sale",
    "rules": [
      {
        "field": "tag",
        "operator": "equals",
        "value": "7"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/collections",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "description": "Seasonal products for summer campaigns.",
        "image_id": "f_8f2a1c2b9d4e",
        "is_active": True,
        "match_type": "all",
        "name": "Summer Sale",
        "rules": [{
            "field": "tag",
            "operator": "equals",
            "value": "7",
        }],
        "seo_description": "Shop products in the Summer Sale collection.",
        "seo_title": "Summer Sale",
        "slug": "summer-sale",
        "template_handle": "default_collection",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "collection": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Seasonal products for summer campaigns.",
      "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "image_cdn_url": "",
      "image_id": "f_8f2a1c2b9d4e",
      "image_url": "",
      "is_active": true,
      "match_type": "all",
      "materialized_at": "2026-06-09T12:00:00Z",
      "name": "Summer Sale",
      "product_count": 42,
      "rules": [
        {
          "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
          "field": "tag",
          "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
          "include_subcategories": false,
          "operator": "equals",
          "value": "7",
          "value_label": "Summer Sale"
        }
      ],
      "seo_description": "Shop products in the Summer Sale collection.",
      "seo_title": "Summer Sale",
      "slug": "summer-sale",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/collections/summer-sale",
      "template_handle": "default_collection",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Update a collection

PUT write_products

Update a collection.

Updates provided Collection fields. Omitted fields are left unchanged. Sending an empty image_id clears the image; sending a non-empty image_id requires read_files and the referenced file must be an upload image in the same store. Sending create_redirect can create a slug redirect when the slug changes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name`	`string`	Collection name. Example: `Summer Sale`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `summer-sale`
`description`	`string`	Optional plain-text description. Example: `Seasonal products for summer campaigns.`
`seo_title`	`string`	Optional SEO title. Example: `Summer Sale`
`seo_description`	`string`	Optional SEO description. Example: `Shop products in the Summer Sale collection.`
`image_id`	`string`	Optional upload image file id. Non-empty values require `read_files` access to the referenced file. Example: `f_8f2a1c2b9d4e`
`template_handle`	`string`	Template assignment. On create, omitting this field or sending an empty string assigns `default_collection`. Use `default_collection` for the default Collection template, or pass an alternate Collection template handle configured for the store. On update, omit `template_handle` to leave the assignment unchanged, use `default_collection` to reset it to default, and do not send an empty string. Example: `default_collection`
`match_type`	`string`	`all` requires every rule to match; `any` requires at least one rule. Example: `all`
`is_active`	`boolean`	Whether the collection is visible on the storefront. Example: `true`
`rules`	`array<object>`	Automatic collection rules. Each rule has field, operator, optional value, and include_subcategories. Example: `[{"field":"tag","operator":"equals","value":"7"}]`
`create_redirect`	`boolean`	When slug changes, create a redirect from the previous slug. Example: `true`

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 TRANSLATION_SOURCE_FIELD_HAS_TRANSLATIONS
Clearing a source field is blocked while translated values exist.
400 COLLECTION_NAME_REQUIRED
Name is empty after normalization.
400 COLLECTION_NAME_TOO_LONG
Name exceeds the Collection contract max length.
400 COLLECTION_NAME_INVALID_CHARS
Name contains unsupported control characters.
400 COLLECTION_DESCRIPTION_TOO_LONG
Description exceeds the Collection contract max length.
400 COLLECTION_SEO_TITLE_TOO_LONG
SEO title exceeds the Collection contract max length.
400 COLLECTION_SEO_DESCRIPTION_TOO_LONG
SEO description exceeds the Collection contract max length.
400 COLLECTION_SLUG_REQUIRED
A provided update slug is empty after normalization.
400 COLLECTION_SLUG_TOO_LONG
Slug exceeds the Collection contract max length.
400 COLLECTION_SLUG_INVALID_FORMAT
Slug is not valid for Collection URLs.
400 COLLECTION_SLUG_GENERATION_FAILED
A slug could not be generated from the supplied name.
400 COLLECTION_MATCH_TYPE_INVALID
Match type is not valid.
400 COLLECTION_RULES_LIMIT_REACHED
Rule count exceeds the Collection rule cap.
400 COLLECTION_LIMIT_REACHED
Store collection cap has been reached.
400 TEMPLATE_HANDLE_INVALID
Template handle is not valid for Collection templates.
400 TEMPLATE_HANDLE_NOT_FOUND
Template handle does not exist on the store's primary active theme for Collection.
403 STORE_ADMIN_TOKEN_RUNTIME_FORBIDDEN
A non-empty image_id requires read_files scope in addition to write_products.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.
409 COLLECTION_SLUG_DUPLICATE
Slug already exists in this store.

curl -X PUT https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "create_redirect": true,
  "description": "Seasonal products for summer campaigns.",
  "image_id": "f_8f2a1c2b9d4e",
  "is_active": true,
  "match_type": "all",
  "name": "Summer Sale",
  "rules": [
    {
      "field": "tag",
      "operator": "equals",
      "value": "7"
    }
  ],
  "seo_description": "Shop products in the Summer Sale collection.",
  "seo_title": "Summer Sale",
  "slug": "summer-sale",
  "template_handle": "default_collection"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "create_redirect": true,
    "description": "Seasonal products for summer campaigns.",
    "image_id": "f_8f2a1c2b9d4e",
    "is_active": true,
    "match_type": "all",
    "name": "Summer Sale",
    "rules": [
      {
        "field": "tag",
        "operator": "equals",
        "value": "7"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "create_redirect": True,
        "description": "Seasonal products for summer campaigns.",
        "image_id": "f_8f2a1c2b9d4e",
        "is_active": True,
        "match_type": "all",
        "name": "Summer Sale",
        "rules": [{
            "field": "tag",
            "operator": "equals",
            "value": "7",
        }],
        "seo_description": "Shop products in the Summer Sale collection.",
        "seo_title": "Summer Sale",
        "slug": "summer-sale",
        "template_handle": "default_collection",
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "collection": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Seasonal products for summer campaigns.",
      "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "image_cdn_url": "",
      "image_id": "f_8f2a1c2b9d4e",
      "image_url": "",
      "is_active": true,
      "match_type": "all",
      "materialized_at": "2026-06-09T12:00:00Z",
      "name": "Summer Sale",
      "product_count": 42,
      "rules": [
        {
          "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
          "field": "tag",
          "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
          "include_subcategories": false,
          "operator": "equals",
          "value": "7",
          "value_label": "Summer Sale"
        }
      ],
      "seo_description": "Shop products in the Summer Sale collection.",
      "seo_title": "Summer Sale",
      "slug": "summer-sale",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/collections/summer-sale",
      "template_handle": "default_collection",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Delete a collection

DELETE write_products

Delete a collection.

Deletes a collection. If catalog links, discount targeting, menu items, or other dependent records require confirmation, retry with the returned confirmation token.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`confirmed`	`boolean`	On a confirmation retry, set this to true and send the returned confirmation_token. Omit it on the first request.
`confirmation_token`	`string`	Token from the CONFIRMATION_REQUIRED response. Omit it on the first request and resend the exact same id selection when using it.

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 COLLECTION_CONFIRMATION_INVALID
Confirmation token is missing, expired, or mismatched.
400 COLLECTION_BULK_DELETE_TOO_MANY
Batch exceeds the Collection bulk delete cap.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.
409 CONFIRMATION_REQUIRED
Delete requires confirmation because dependent records will be changed.

curl -X DELETE https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "deleted": true
  },
  "success": true
}

Bulk delete collections

POST write_products

Delete multiple collections.

Send collection UUIDs in collection_ids. Collections linked to a catalog cannot be deleted. If discount targeting or menu items will be removed, the API returns CONFIRMATION_REQUIRED; retry the exact same ids with confirmed: true and its confirmation_token. This operation is all-or-nothing: every requested collection must still exist and pass validation at commit time. A successful response returns the number deleted.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`collection_ids` required	`array<string>`	Collection UUIDs to delete. Example: `["5ff7d4ea-3250-4a4d-9d26-07f64d917d31", "af720cef-7f1b-40f4-a5f8-8a55ea5b0d84"]`
`confirmed`	`boolean`	On a confirmation retry, set this to true and send the returned confirmation_token. Omit it on the first request.
`confirmation_token`	`string`	Token from the CONFIRMATION_REQUIRED response. Omit it on the first request and resend the exact same id selection when using it.

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
409 COLLECTION_BULK_RACED
Delete impact changed during the transaction; retry with fresh data.
400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 COLLECTION_CONFIRMATION_INVALID
Confirmation token is missing, expired, or mismatched.
400 COLLECTION_BULK_DELETE_TOO_MANY
Batch exceeds the Collection bulk delete cap.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.
409 CONFIRMATION_REQUIRED
Delete requires confirmation because dependent records will be changed.

curl -X POST https://api-store.tringify.com/api/2025-01/collections/bulk-delete \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "collection_ids": [
    "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "af720cef-7f1b-40f4-a5f8-8a55ea5b0d84"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/bulk-delete", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "collection_ids": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "af720cef-7f1b-40f4-a5f8-8a55ea5b0d84"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/collections/bulk-delete",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "collection_ids": ["5ff7d4ea-3250-4a4d-9d26-07f64d917d31", "af720cef-7f1b-40f4-a5f8-8a55ea5b0d84"],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "deleted": 2
  },
  "success": true
}

Bulk activate collections

POST write_products

Activate or deactivate multiple collections.

Updates storefront visibility for multiple collections.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`collection_ids` required	`array<string>`	Collection ids to update. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`
`is_active` required	`boolean`	Target storefront visibility. Example: `true`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 COLLECTION_BULK_UPDATE_TOO_MANY
Batch exceeds the Collection bulk update cap.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.

curl -X POST https://api-store.tringify.com/api/2025-01/collections/bulk-activate \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "collection_ids": [
    "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
  ],
  "is_active": true
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/bulk-activate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "collection_ids": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
    ],
    "is_active": true
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/collections/bulk-activate",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "collection_ids": ["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"],
        "is_active": True,
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "updated_ids": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
    ]
  },
  "success": true
}

List collection products

GET read_products

List product ids matched by a collection.

Returns the ids of products currently in this collection.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size. Example: `20`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/products?limit=20&page=1 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/products?limit=20&page=1", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/products?limit=20&page=1",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "products": [
      7
    ],
    "total": 1
  },
  "success": true
}

List collection product details

GET read_products

List display-ready products matched by a collection.

Returns paginated product rows from the materialized collection, including title, slug, SKU, type, and image URL. Use search to filter by product title or SKU.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size. Example: `20`
`search`	`string`	Filter products by title or SKU. Example: `summer`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/products/details?limit=20&page=1&search=summer \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/products/details?limit=20&page=1&search=summer", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/products/details?limit=20&page=1&search=summer",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "products": [
      {
        "image_url": "https://cdn.example.com/files/linen-shirt.jpg",
        "product_id": 7,
        "sku": "LINEN-001",
        "slug": "linen-shirt",
        "title": "Linen Shirt",
        "type": "physical"
      }
    ],
    "total": 1
  },
  "success": true
}

List collection rules

GET read_products

List rules for a collection.

Returns automatic matching rules for this collection.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer Sale"
      }
    ]
  },
  "success": true
}

Add collection rule

POST write_products

Add a rule to a collection.

Adds one automatic matching rule, then updates which products the collection includes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`field` required	`string`	Rule field: tag, category, vendor, brand, or title. Example: `tag`
`operator` required	`string`	Rule operator allowed for the field. Example: `equals`
`value`	`string`	Rule value. Required for value-bearing operators. Example: `7`
`include_subcategories`	`boolean`	Only valid for category rules. Example: `false`

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 COLLECTION_RULES_LIMIT_REACHED
Rule count exceeds the Collection rule cap.
400 COLLECTION_RULE_FIELD_INVALID
Rule field is not valid.
400 COLLECTION_RULE_OPERATOR_INVALID
Rule operator is not valid for the selected field.
400 COLLECTION_RULE_VALUE_REQUIRED
This rule operator requires a value.
400 COLLECTION_RULE_SUBCATEGORIES_NOT_ALLOWED
include_subcategories is only valid for category rules.
400 COLLECTION_RULE_TAG_ID_INVALID
Tag value is not a valid integer id.
400 COLLECTION_RULE_CATEGORY_ID_INVALID
Category value is not a valid integer id.
400 COLLECTION_RULE_VENDOR_ID_INVALID
Vendor value is not a valid integer id.
400 COLLECTION_RULE_BRAND_ID_INVALID
Brand value is not a valid integer id.
400 COLLECTION_RULE_TITLE_TOO_LONG
Title rule value exceeds the contract max length.
400 COLLECTION_RULE_TAG_NOT_FOUND
Referenced tag does not exist in this store.
400 COLLECTION_RULE_CATEGORY_NOT_FOUND
Referenced category does not exist in this store.
400 COLLECTION_RULE_VENDOR_NOT_FOUND
Referenced vendor does not exist in this store.
400 COLLECTION_RULE_BRAND_NOT_FOUND
Referenced brand does not exist in this store.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.
409 COLLECTION_RULE_DUPLICATE
The rule already exists on this collection.

curl -X POST https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "field": "tag",
  "include_subcategories": false,
  "operator": "equals",
  "value": "7"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "field": "tag",
    "include_subcategories": false,
    "operator": "equals",
    "value": "7"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "field": "tag",
        "include_subcategories": False,
        "operator": "equals",
        "value": "7",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "rule": {
      "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "field": "tag",
      "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "include_subcategories": false,
      "operator": "equals",
      "value": "7",
      "value_label": "Summer Sale"
    }
  },
  "success": true
}

Update collection rule

PUT write_products

Update a rule on a collection.

Updates one automatic matching rule, then updates which products the collection includes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`
`rule_id` required	`uuid`	Rule id. Example: `8d8c22a3-7cf8-4d2c-a54b-45fa63693e83`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`field` required	`string`	Rule field: tag, category, vendor, brand, or title. Example: `tag`
`operator` required	`string`	Rule operator allowed for the field. Example: `equals`
`value`	`string`	Rule value. Required for value-bearing operators. Example: `7`
`include_subcategories`	`boolean`	Only valid for category rules. Example: `false`

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 COLLECTION_RULES_LIMIT_REACHED
Rule count exceeds the Collection rule cap.
400 COLLECTION_RULE_FIELD_INVALID
Rule field is not valid.
400 COLLECTION_RULE_OPERATOR_INVALID
Rule operator is not valid for the selected field.
400 COLLECTION_RULE_VALUE_REQUIRED
This rule operator requires a value.
400 COLLECTION_RULE_SUBCATEGORIES_NOT_ALLOWED
include_subcategories is only valid for category rules.
400 COLLECTION_RULE_TAG_ID_INVALID
Tag value is not a valid integer id.
400 COLLECTION_RULE_CATEGORY_ID_INVALID
Category value is not a valid integer id.
400 COLLECTION_RULE_VENDOR_ID_INVALID
Vendor value is not a valid integer id.
400 COLLECTION_RULE_BRAND_ID_INVALID
Brand value is not a valid integer id.
400 COLLECTION_RULE_TITLE_TOO_LONG
Title rule value exceeds the contract max length.
400 COLLECTION_RULE_TAG_NOT_FOUND
Referenced tag does not exist in this store.
400 COLLECTION_RULE_CATEGORY_NOT_FOUND
Referenced category does not exist in this store.
400 COLLECTION_RULE_VENDOR_NOT_FOUND
Referenced vendor does not exist in this store.
400 COLLECTION_RULE_BRAND_NOT_FOUND
Referenced brand does not exist in this store.
404 COLLECTION_NOT_FOUND
Collection does not exist in this store.
409 COLLECTION_RULE_DUPLICATE
The rule already exists on this collection.
400 STORE_API_INVALID_COLLECTION_RULE_ID
Rule id is not a valid UUID.

curl -X PUT https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules/8d8c22a3-7cf8-4d2c-a54b-45fa63693e83 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "field": "tag",
  "include_subcategories": false,
  "operator": "equals",
  "value": "7"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules/8d8c22a3-7cf8-4d2c-a54b-45fa63693e83", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "field": "tag",
    "include_subcategories": false,
    "operator": "equals",
    "value": "7"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules/8d8c22a3-7cf8-4d2c-a54b-45fa63693e83",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "field": "tag",
        "include_subcategories": False,
        "operator": "equals",
        "value": "7",
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "rule": {
      "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "field": "tag",
      "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
      "include_subcategories": false,
      "operator": "equals",
      "value": "7",
      "value_label": "Summer Sale"
    }
  },
  "success": true
}

Delete collection rule

DELETE write_products

Delete a rule from a collection.

Deletes one automatic matching rule, then updates which products the collection includes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Collection id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`
`rule_id` required	`uuid`	Rule id. Example: `8d8c22a3-7cf8-4d2c-a54b-45fa63693e83`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_COLLECTION_ID
Collection id is not a valid UUID.
400 STORE_API_INVALID_COLLECTION_RULE_ID
Rule id is not a valid UUID.
404 COLLECTION_NOT_FOUND
Collection or rule does not exist in this store.

curl -X DELETE https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules/8d8c22a3-7cf8-4d2c-a54b-45fa63693e83 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules/8d8c22a3-7cf8-4d2c-a54b-45fa63693e83", {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/collections/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/rules/8d8c22a3-7cf8-4d2c-a54b-45fa63693e83",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "deleted": true
  },
  "success": true
}

Field	Kind	Create	Update	Required	Translatable
`name`	text	Yes	Yes	create	Yes
`slug`	slug	Yes	Yes		Yes
`description`	textarea	Yes	Yes		Yes
`seo_title`	text	Yes	Yes		Yes
`seo_description`	textarea	Yes	Yes		Yes
`image_id`	image	Yes	Yes		No
`template_handle`	template	Yes	Yes		No
`match_type`	select	Yes	Yes		No
`is_active`	boolean	Yes	Yes		No
`create_redirect`	boolean	No	Yes		No
`product_count`	integer	No	No		No
`materialized_at`	datetime	No	No		No
`created_at`	datetime	No	No		No
`updated_at`	datetime	No	No		No
`storefront_url`	url	No	No	No	No

Collection created

EVENT collections/create write_products products:write

Fired when a collection is created.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Can be removed/added via the Payload builder
`collection.slug`	`string`	Can be removed/added via the Payload builder
`collection.description`	`string`	Can be removed/added via the Payload builder
`collection.image_id`	`string`	Can be removed/added via the Payload builder
`collection.image_url`	`string`	Can be removed/added via the Payload builder
`collection.image_cdn_url`	`string`	Can be removed/added via the Payload builder
`collection.seo_title`	`string`	Can be removed/added via the Payload builder
`collection.seo_description`	`string`	Can be removed/added via the Payload builder
`collection.template_handle`	`string`	Can be removed/added via the Payload builder
`collection.match_type`	`string`	Can be removed/added via the Payload builder
`collection.is_active`	`boolean`	Can be removed/added via the Payload builder
`collection.product_count`	`integer`	Can be removed/added via the Payload builder
`collection.materialized_at`	`string`	Can be removed/added via the Payload builder
`collection.created_at`	`string`	Can be removed/added via the Payload builder
`collection.updated_at`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].id`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].collection_id`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].field`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].operator`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].value`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].value_label`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].include_subcategories`	`boolean`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Seasonal products for summer campaigns.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "image_cdn_url": "",
    "image_id": "f_8f2a1c2b9d4e",
    "image_url": "",
    "is_active": true,
    "match_type": "all",
    "materialized_at": "2026-06-09T12:00:00Z",
    "name": "Summer Sale",
    "product_count": 42,
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer Sale"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection",
    "updated_at": "2026-06-09T12:00:00Z"
  }
}

Collection updated

EVENT collections/update write_products products:write

Fired when a collection is updated — including rule changes and image changes.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Can be removed/added via the Payload builder
`collection.slug`	`string`	Can be removed/added via the Payload builder
`collection.description`	`string`	Can be removed/added via the Payload builder
`collection.image_id`	`string`	Can be removed/added via the Payload builder
`collection.image_url`	`string`	Can be removed/added via the Payload builder
`collection.image_cdn_url`	`string`	Can be removed/added via the Payload builder
`collection.seo_title`	`string`	Can be removed/added via the Payload builder
`collection.seo_description`	`string`	Can be removed/added via the Payload builder
`collection.template_handle`	`string`	Can be removed/added via the Payload builder
`collection.match_type`	`string`	Can be removed/added via the Payload builder
`collection.is_active`	`boolean`	Can be removed/added via the Payload builder
`collection.product_count`	`integer`	Can be removed/added via the Payload builder
`collection.materialized_at`	`string`	Can be removed/added via the Payload builder
`collection.created_at`	`string`	Can be removed/added via the Payload builder
`collection.updated_at`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].id`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].collection_id`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].field`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].operator`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].value`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].value_label`	`string`	Can be removed/added via the Payload builder
`collection.rules[*].include_subcategories`	`boolean`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Always present

Payload shape

Sample payload

{
  "changed_fields": [],
  "collection": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Seasonal products for summer campaigns.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "image_cdn_url": "",
    "image_id": "f_8f2a1c2b9d4e",
    "image_url": "",
    "is_active": true,
    "match_type": "all",
    "materialized_at": "2026-06-09T12:00:00Z",
    "name": "Summer Sale",
    "product_count": 42,
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer Sale"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection",
    "updated_at": "2026-06-09T12:00:00Z"
  }
}

Collection deleted

EVENT collections/delete write_products products:write

Fired when a collection is deleted.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Can be removed/added via the Payload builder
`collection.slug`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Summer Sale",
    "slug": "summer-sale"
  }
}

Endpoints#

Headers

Query parameters

Headers

Query parameters

Headers

Path parameters

Headers

Errors

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Path parameters

Query parameters

Headers

Errors

Path parameters

Query parameters

Headers

Errors

Path parameters

Headers

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Errors

Fields#

Webhook events#

Payload fields

Payload fields

Payload fields