Get a collection by ID

GET

api

{team_slug}

{app_slug}

collections

{collection_id}

Error

A valid request URL is required to generate request examples

{
  "data": {
    "slug": "<string>",
    "children": "<array>",
    "created_at": "<string>",
    "id": "<string>",
    "parent_id": "<string>",
    "redirects": [
      {
        "id": "<string>",
        "item_id": "<string>",
        "locale": "<string>",
        "new_slug": "<string>",
        "old_slug": "<string>"
      }
    ],
    "title": "<string>",
    "translations": {
      "slug": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "title": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>",
    "uri": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

collection_id

string

required

ID of collection

Response

Collection updated successfully

data

object

Show child attributes

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success

boolean

List products in a collectionRetrieves paginated list of products in a collection. Optionally includes products from child collections using the 'children' query parameter.

Error

A valid request URL is required to generate request examples

{
  "data": {
    "slug": "<string>",
    "children": "<array>",
    "created_at": "<string>",
    "id": "<string>",
    "parent_id": "<string>",
    "redirects": [
      {
        "id": "<string>",
        "item_id": "<string>",
        "locale": "<string>",
        "new_slug": "<string>",
        "old_slug": "<string>"
      }
    ],
    "title": "<string>",
    "translations": {
      "slug": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "title": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>",
    "uri": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Path Parameters

Response