List attribute templates

GET

api

{team_slug}

{app_slug}

attributes

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "attributes": [
        {
          "created_at": "<string>",
          "description": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "template_key": "<string>",
          "template_name": "<string>",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "created_at": "<string>",
      "fields": [
        {
          "created_at": "<string>",
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "type": "<string>",
          "updated_at": "<string>"
        }
      ],
      "filterable": true,
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "resources": [
        "<string>"
      ],
      "source_app_id": "<string>",
      "source_id": "<string>",
      "translatable": true,
      "type": "<string>",
      "updated_at": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

{
  "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

Query Parameters

resources

string[]

Filter on attribute templates for different type of resources

string

Search for attribute templates

sort-order

string

Sort order. Should be one of ASC or DESC. Default DESC

sort-key

string

The key to sort on. Can be one of created_at, name and type (Default is created_at)

page

integer

Page number (default is 1)

template_key

string[]

Filter the result on template key

per-page

integer

Amount of products per page. Minimum 0 and max 100 (default is 20)

Response

Attributes templates and corresponding attributes

data

object[]

Show child attributes

success

boolean

total

integer

total_pages

integer

Create attribute templateCreates a new attribute template that defines the structure and fields for attributes. Templates specify field types (image, text, boolean, number, color) and can be associated with resources like products, categories, or tags. Reserved field keys (key, name, description) cannot be used.

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "attributes": [
        {
          "created_at": "<string>",
          "description": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "template_key": "<string>",
          "template_name": "<string>",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "created_at": "<string>",
      "fields": [
        {
          "created_at": "<string>",
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "type": "<string>",
          "updated_at": "<string>"
        }
      ],
      "filterable": true,
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "resources": [
        "<string>"
      ],
      "source_app_id": "<string>",
      "source_id": "<string>",
      "translatable": true,
      "type": "<string>",
      "updated_at": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

{
  "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

Query Parameters

Response