Skip to main content
PATCH
/
api
/
v1
/
:team_slug
/
:app_slug
/
collections
Error
A valid request URL is required to generate request examples
{
  "data": {
    "slug": "<string>",
    "status": "active",
    "children": "<array>",
    "created_at": "<string>",
    "id": "<string>",
    "parent_id": "<string>",
    "redirects": [
      {
        "id": "<string>",
        "item_id": "<string>",
        "locale": "<string>",
        "new_slug": "<string>",
        "old_slug": "<string>",
        "type": "product"
      }
    ],
    "title": "<string>",
    "translations": {
      "slug": [
        {
          "id": "<string>",
          "locale": "<string>",
          "omni_channel_translations": [
            {
              "id": "<string>",
              "market_id": "<string>",
              "store_group_id": "<string>",
              "value": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "title": [
        {
          "id": "<string>",
          "locale": "<string>",
          "omni_channel_translations": [
            {
              "id": "<string>",
              "market_id": "<string>",
              "store_group_id": "<string>",
              "value": "<string>"
            }
          ],
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>",
    "uri": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Body

application/json

Collection data

​
parent_id
string

To move collection to root, send empty string

​
slug
string
​
status
enum<string>
Available options:
active,
inactive,
draft
​
title
string

Response

Collection updated successfully

​
data
object
​
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

​
success
boolean