Attributes

Attributes require product scopes. Reads use read_products; writes use write_products. Attributes are compound resources: the parent owns name, slug, description, sub_type, and sort_order, while options[] owns option labels, values, swatch colors, image file ids, and option sort order. sub_type is one of standard, swatch, or image; swatch options require colors, image options require upload file ids. Referencing a non-empty option file_id also requires read_files. Attribute option translations are their own Store API endpoints because options are separate translatable records.

Endpoints#

Attribute limits

GET read_products

Fetch Attribute limits, option limits, and list constraints.

Returns parent field limits, option field limits, allowed sub types, reorder caps, list caps, and sort options for Product Attribute endpoints.

Headers

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

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

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/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/attributes/limits",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "bulk_delete_max": 200,
    "description_max_length": 1000,
    "list_default_limit": 50,
    "list_max_limit": 200,
    "max_options_per_attr": 100,
    "max_per_store": 1000,
    "max_variant_attrs": 3,
    "name_max_length": 255,
    "option_color_max_length": 7,
    "option_label_max_length": 100,
    "option_value_max_length": 100,
    "page_size_options": [
      20,
      50,
      100,
      200
    ],
    "search_max_length": 200,
    "slug_max_length": 255,
    "sort_columns": [
      "name",
      "created_at",
      "updated_at"
    ],
    "sort_directions": [
      "asc",
      "desc"
    ],
    "sort_options": [
      "name",
      "created_at",
      "updated_at"
    ],
    "sort_order_max": 9999,
    "sub_types": [
      "standard",
      "swatch",
      "image"
    ]
  },
  "success": true
}

List attributes

GET read_products

List product attributes for the store.

Returns paginated product attributes with their nested options. Use sub_type to filter to standard, swatch, or image attributes; use in_use to filter attributes currently used by variants.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size. Example: `20`
`search`	`string`	Search attributes by name or slug. Example: `color`
`sub_type`	`string`	Filter by sub type: standard, swatch, or image. Example: `swatch`
`in_use`	`boolean`	Filter by whether the attribute is used by variants. Example: `true`
`sort_by`	`string`	Sort field from the Attribute list contract. Allowed values `namecreated_atupdated_at` Example: `name`
`sort_direction`	`string`	Sort direction from the Attribute 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/attributes?in_use=true&limit=20&page=1&search=color&sort_by=name&sort_direction=asc&sub_type=swatch \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes?in_use=true&limit=20&page=1&search=color&sort_by=name&sort_direction=asc&sub_type=swatch", {
  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/attributes?in_use=true&limit=20&page=1&search=color&sort_by=name&sort_direction=asc&sub_type=swatch",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "attributes": [
      {
        "created_at": "2026-06-09T12:00:00Z",
        "description": "Product color choices.",
        "id": 7,
        "in_use": true,
        "name": "Color",
        "options": [
          {
            "attribute_id": 7,
            "color": "#ef4444",
            "created_at": "2026-06-09T12:00:00Z",
            "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
            "file_id": "f_8f2a1c2b9d4e",
            "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
            "id": 7,
            "label": "Red",
            "sort_order": 10,
            "store_seq_id": 7,
            "value": "red"
          }
        ],
        "slug": "color",
        "sort_order": 10,
        "store_id": "str_9f8a1c2b",
        "store_seq_id": 7,
        "sub_type": "swatch",
        "updated_at": "2026-06-09T12:00:00Z",
        "variant_usage_count": 24
      }
    ],
    "limit": 20,
    "page": 1,
    "total": 1,
    "total_pages": 1
  },
  "success": true
}

Search attributes

GET read_products

Search attributes for picker-style suggestions.

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

Query parameters

Name	Type	Description
`q`	`string`	Search query. Example: `color`
`limit`	`integer`	Suggestion count. Example: `10`
`offset`	`integer`	Result offset. Example: `0`

Headers

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

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

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/search?limit=10&offset=0&q=color", {
  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/attributes/search?limit=10&offset=0&q=color",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "items": [
      {
        "id": 7,
        "name": "Color",
        "slug": "color"
      }
    ],
    "total": 1
  },
  "success": true
}

Get an attribute

GET read_products

Fetch one attribute by id.

Returns the attribute and its nested options if it belongs to the token's store.

Path parameters

Name	Type	Description
`id` required	`integer`	Attribute id. Example: `7`

Headers

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

Errors

400 STORE_API_INVALID_ATTRIBUTE_ID
Attribute id must be an integer.
404 ATTRIBUTE_NOT_FOUND
Attribute does not exist in this store.

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

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/7", {
  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/attributes/7",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Product color choices.",
    "id": 7,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 7,
        "color": "#ef4444",
        "created_at": "2026-06-09T12:00:00Z",
        "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
        "file_id": "f_8f2a1c2b9d4e",
        "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
        "id": 7,
        "label": "Red",
        "sort_order": 10,
        "store_seq_id": 7,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "store_id": "str_9f8a1c2b",
    "store_seq_id": 7,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00Z",
    "variant_usage_count": 24
  },
  "success": true
}

Create an attribute

POST write_products

Create an attribute with options.

Creates a product attribute. name, sub_type, and at least one option are required. slug is optional on create and is generated from the name when omitted. sub_type controls option shape: standard uses labels/values, swatch options require color, and image options require file_id. Non-empty option file_id values must point to upload files in the same store and require read_files in addition to write_products.

Headers

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

Body parameters

Name	Type	Description
`name` required	`string`	Attribute name. Example: `Color`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `color`
`description`	`string`	Optional plain-text description. Example: `Product color choices.`
`sub_type` required	`string`	One of `standard`, `swatch`, or `image`. Controls which option fields are required. Example: `swatch`
`sort_order`	`integer`	Store-wide display order. Example: `10`
`options` required	`array<object>`	Attribute options. `label` is required. `value` is optional and can be generated. `color` is required for swatch attributes. `file_id` is required for image attributes and requires `read_files`. Example: `[{"label":"Red","value":"red","color":"#ef4444","sort_order":0}]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON or does not match the expected shape.
400 ATTRIBUTE_NAME_REQUIRED
Name is empty after normalization.
400 ATTRIBUTE_NAME_TOO_LONG
Name exceeds the Attribute contract max length.
400 ATTRIBUTE_SLUG_INVALID_FORMAT
Slug is not valid for Attribute URLs.
400 ATTRIBUTE_SUB_TYPE_INVALID
Sub type is not standard, swatch, or image.
400 ATTRIBUTE_SUB_TYPE_IMMUTABLE
Sub type cannot be changed after creation.
400 ATTRIBUTE_OPTIONS_REQUIRED
At least one option is required.
400 ATTRIBUTE_OPTIONS_TOO_MANY
Option count exceeds the contract max per attribute.
400 ATTRIBUTE_OPTION_LABEL_TOO_LONG
Option label exceeds the contract max length.
400 ATTRIBUTE_OPTION_VALUE_INVALID_FORMAT
Option value is not a valid filter identifier.
400 ATTRIBUTE_OPTION_COLOR_REQUIRED
Swatch options require a color.
400 ATTRIBUTE_OPTION_COLOR_INVALID_FORMAT
Option color must be #RRGGBB.
400 ATTRIBUTE_OPTION_IMAGE_REQUIRED
Image options require a file_id.
400 ATTRIBUTE_LIMIT_REACHED
Store attribute cap has been reached.
403 STORE_ADMIN_TOKEN_RUNTIME_FORBIDDEN
A non-empty option file_id requires read_files scope in addition to write_products.
404 ATTRIBUTE_NOT_FOUND
Attribute does not exist in this store.
409 ATTRIBUTE_DUPLICATE
Name or slug already exists in this store.
409 ATTRIBUTE_OPTIONS_IN_USE
An option removed by the update is still used by variants.

curl -X POST https://api-store.tringify.com/api/2025-01/attributes \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Product color choices.",
  "name": "Color",
  "options": [
    {
      "color": "#ef4444",
      "label": "Red",
      "sort_order": 0,
      "value": "red"
    }
  ],
  "slug": "color",
  "sort_order": 10,
  "sub_type": "swatch"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "Product color choices.",
    "name": "Color",
    "options": [
      {
        "color": "#ef4444",
        "label": "Red",
        "sort_order": 0,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "sub_type": "swatch"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/attributes",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "description": "Product color choices.",
        "name": "Color",
        "options": [{
            "color": "#ef4444",
            "label": "Red",
            "sort_order": 0,
            "value": "red",
        }],
        "slug": "color",
        "sort_order": 10,
        "sub_type": "swatch",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Product color choices.",
    "id": 7,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 7,
        "color": "#ef4444",
        "created_at": "2026-06-09T12:00:00Z",
        "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
        "file_id": "f_8f2a1c2b9d4e",
        "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
        "id": 7,
        "label": "Red",
        "sort_order": 10,
        "store_seq_id": 7,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "store_id": "str_9f8a1c2b",
    "store_seq_id": 7,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00Z",
    "variant_usage_count": 24
  },
  "success": true
}

Update an attribute

PUT write_products

Update an attribute and replace its option set.

Updates provided parent fields and replaces the option array. Omitted parent fields are left unchanged, but options is a full-array replacement when sent by Store Admin clients. sub_type is immutable after create and must match the existing value when included. Existing options keep their id; id: 0 creates a new option. Removing an option used by variants is blocked. Non-empty option file_id values require read_files in addition to write_products.

Path parameters

Name	Type	Description
`id` required	`integer`	Attribute id. Example: `7`

Headers

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

Body parameters

Name	Type	Description
`name`	`string`	Attribute name. Example: `Color`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `color`
`description`	`string`	Optional plain-text description. Example: `Product color choices.`
`sub_type` required	`string`	`sub_type` is immutable after create. If sent, it must match the existing attribute. Example: `swatch`
`sort_order`	`integer`	Store-wide display order. Example: `10`
`options` required	`array<object>`	Full replacement option array. Existing options include their id; new options use `id: 0`. Removing an option in use by variants is blocked. Example: `[{"label":"Red","value":"red","color":"#ef4444","sort_order":0}]`

Errors

400 STORE_API_INVALID_ATTRIBUTE_ID
Attribute id must be an integer.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON or does not match the expected shape.
400 ATTRIBUTE_NAME_REQUIRED
Name is empty after normalization.
400 ATTRIBUTE_NAME_TOO_LONG
Name exceeds the Attribute contract max length.
400 ATTRIBUTE_SLUG_INVALID_FORMAT
Slug is not valid for Attribute URLs.
400 ATTRIBUTE_SUB_TYPE_INVALID
Sub type is not standard, swatch, or image.
400 ATTRIBUTE_SUB_TYPE_IMMUTABLE
Sub type cannot be changed after creation.
400 ATTRIBUTE_OPTIONS_REQUIRED
At least one option is required.
400 ATTRIBUTE_OPTIONS_TOO_MANY
Option count exceeds the contract max per attribute.
400 ATTRIBUTE_OPTION_LABEL_TOO_LONG
Option label exceeds the contract max length.
400 ATTRIBUTE_OPTION_VALUE_INVALID_FORMAT
Option value is not a valid filter identifier.
400 ATTRIBUTE_OPTION_COLOR_REQUIRED
Swatch options require a color.
400 ATTRIBUTE_OPTION_COLOR_INVALID_FORMAT
Option color must be #RRGGBB.
400 ATTRIBUTE_OPTION_IMAGE_REQUIRED
Image options require a file_id.
400 ATTRIBUTE_LIMIT_REACHED
Store attribute cap has been reached.
403 STORE_ADMIN_TOKEN_RUNTIME_FORBIDDEN
A non-empty option file_id requires read_files scope in addition to write_products.
404 ATTRIBUTE_NOT_FOUND
Attribute does not exist in this store.
409 ATTRIBUTE_DUPLICATE
Name or slug already exists in this store.
409 ATTRIBUTE_OPTIONS_IN_USE
An option removed by the update is still used by variants.

curl -X PUT https://api-store.tringify.com/api/2025-01/attributes/7 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Product color choices.",
  "name": "Color",
  "options": [
    {
      "color": "#ef4444",
      "label": "Red",
      "sort_order": 0,
      "value": "red"
    }
  ],
  "slug": "color",
  "sort_order": 10,
  "sub_type": "swatch"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/7", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "Product color choices.",
    "name": "Color",
    "options": [
      {
        "color": "#ef4444",
        "label": "Red",
        "sort_order": 0,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "sub_type": "swatch"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/attributes/7",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "description": "Product color choices.",
        "name": "Color",
        "options": [{
            "color": "#ef4444",
            "label": "Red",
            "sort_order": 0,
            "value": "red",
        }],
        "slug": "color",
        "sort_order": 10,
        "sub_type": "swatch",
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Product color choices.",
    "id": 7,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 7,
        "color": "#ef4444",
        "created_at": "2026-06-09T12:00:00Z",
        "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
        "file_id": "f_8f2a1c2b9d4e",
        "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
        "id": 7,
        "label": "Red",
        "sort_order": 10,
        "store_seq_id": 7,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "store_id": "str_9f8a1c2b",
    "store_seq_id": 7,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00Z",
    "variant_usage_count": 24
  },
  "success": true
}

Delete an attribute

DELETE write_products

Delete an attribute.

Deletes an attribute only when it is not used by product variants. Variant usage is a hard block; there is no confirmation-and-clear flow because clearing variant attribute data would corrupt variant identity. When deletion is allowed, its options and the translations for both the attribute and those options are deleted in the same transaction. The attribute delete webhook includes the removed option summaries.

Path parameters

Name	Type	Description
`id` required	`integer`	Attribute id. Example: `7`

Headers

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

Errors

400 STORE_API_INVALID_ATTRIBUTE_ID
Attribute id must be an integer.
404 ATTRIBUTE_NOT_FOUND
Attribute does not exist in this store.
409 ATTRIBUTE_IN_USE
Attribute is used by variants and cannot be deleted.

curl -X DELETE https://api-store.tringify.com/api/2025-01/attributes/7 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/7", {
  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/attributes/7",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "deleted": true,
    "id": 7,
    "name": "Color"
  },
  "success": true
}

Bulk delete attributes

POST write_products

Delete multiple attributes.

Send store-scoped integer attribute ids in attribute_ids. Attributes that are missing, concurrently changed, or used by variants appear in failed; the others appear in deleted. Deleting an attribute also deletes its options and both levels of translations in the same transaction. The envelope succeeds when the batch itself is valid, even when individual ids fail.

Headers

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

Body parameters

Name	Type	Description
`attribute_ids` required	`array<integer>`	Store-scoped integer attribute ids to delete. Example: `[7, 8, 9]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON or does not match the expected shape.
400 ATTRIBUTE_BULK_NO_IDS
No attribute ids were provided.
400 ATTRIBUTE_BULK_DELETE_TOO_MANY
Batch exceeds the Attribute bulk delete cap.
409 ATTRIBUTE_BULK_RACED
An attribute became in-use during deletion and was returned in failed.

curl -X POST https://api-store.tringify.com/api/2025-01/attributes/bulk-delete \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "attribute_ids": [
    7,
    8,
    9
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/bulk-delete", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "attribute_ids": [
      7,
      8,
      9
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/attributes/bulk-delete",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "attribute_ids": [7, 8, 9],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "deleted": [
      7,
      8
    ],
    "failed": [
      {
        "id": 9,
        "reason": "Attribute is used by variants and cannot be deleted."
      }
    ]
  },
  "success": true
}

Reorder attributes

POST write_products

Set the order of selected attributes.

Assigns consecutive sort positions, starting at zero, to the supplied attribute ids. Omitted attributes keep their current sort order. Every supplied id must belong to the store and the list cannot contain duplicates.

Headers

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

Body parameters

Name	Type	Description
`attribute_ids` required	`array<integer>`	Attribute ids in display order. Example: `[7,8,9]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON or does not match the expected shape.
400 ATTRIBUTE_REORDER_IDS_REQUIRED
At least one attribute id is required.
400 ATTRIBUTE_REORDER_DUPLICATE_ID
The reorder list contains duplicate attribute ids.
400 ATTRIBUTE_REORDER_UNKNOWN_IDS
One or more attribute ids do not belong to this store.

curl -X POST https://api-store.tringify.com/api/2025-01/attributes/reorder \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "attribute_ids": [
    7,
    8,
    9
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/reorder", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "attribute_ids": [
      7,
      8,
      9
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/attributes/reorder",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "attribute_ids": [7, 8, 9],
    },
)
data = res.json()

Response

200

Sample response

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

Reorder attribute options

POST write_products

Set the order of selected options within one attribute.

Assigns consecutive sort positions, starting at zero, to the supplied option ids. Omitted options keep their current sort order. Every supplied id must belong to the attribute and the list cannot contain duplicates.

Path parameters

Name	Type	Description
`id` required	`integer`	Attribute id. Example: `7`

Headers

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

Body parameters

Name	Type	Description
`option_ids` required	`array<integer>`	Option ids in display order. Example: `[41,42,43]`

Errors

400 STORE_API_INVALID_ATTRIBUTE_ID
Attribute id must be an integer.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON or does not match the expected shape.
400 ATTRIBUTE_OPTION_REORDER_IDS_REQUIRED
At least one option id is required.
400 ATTRIBUTE_OPTION_REORDER_DUPLICATE_ID
The reorder list contains duplicate option ids.
400 ATTRIBUTE_OPTION_REORDER_UNKNOWN_IDS
One or more option ids do not belong to this attribute.
404 ATTRIBUTE_NOT_FOUND
Attribute does not exist in this store.

curl -X POST https://api-store.tringify.com/api/2025-01/attributes/7/options/reorder \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "option_ids": [
    41,
    42,
    43
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/attributes/7/options/reorder", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "option_ids": [
      41,
      42,
      43
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/attributes/7/options/reorder",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "option_ids": [41, 42, 43],
    },
)
data = res.json()

Response

200

Sample response

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

Fields#

Field	Kind	Create	Update	Required	Translatable
`name`	text	Yes	Yes	create	Yes
`slug`	slug	Yes	Yes		Yes
`description`	textarea	Yes	Yes		Yes
`sub_type`	select	Yes	Yes	create, update	No
`sort_order`	integer	Yes	Yes		No
`options`	attribute_options	Yes	Yes	create, update	No
`variant_usage_count`	integer	No	No		No
`in_use`	boolean	No	No		No
`created_at`	datetime	No	No		No
`updated_at`	datetime	No	No		No

Admin CSV shape#

CSV import, update, and export are Store Admin bulk-job features, not Store API JSON endpoints. They are shown here because the same Attribute registry contract owns the field shape and permissions. Attributes use one row per option: the parent attribute columns identify the attribute, while the option columns describe the nested option on that row.

Mode	Columns	Required columns
Import	`Name`, `Slug`, `Sub Type`, `Description`, `Sort Order`, `Option Label`, `Option Value`, `Option Color`, `Option Image URL`, `Option Sort`	`Name`, `Option Label`
Update	`ID`, `Name`, `Slug`, `Sub Type`, `Description`, `Sort Order`, `Option ID`, `Option Label`, `Option Value`, `Option Color`, `Option Image URL`, `Option Sort`	`ID`
Export	`ID`, `Name`, `Slug`, `Sub Type`, `Description`, `Sort Order`, `Option ID`, `Option Label`, `Option Value`, `Option Color`, `Option Image URL`, `Option Image Site URL`, `Option Sort`

Create import example#

csv

Name,Slug,Sub Type,Description,Sort Order,Option Label,Option Value,Option Color,Option Image URL,Option Sort
Acme,acme,swatch,Acme makes durable outdoor gear.,10,Red,red,#ef4444,https://cdn.example.com/red.png,10

Name	Slug	Sub Type	Description	Sort Order	Option Label	Option Value	Option Color	Option Image URL	Option Sort
Acme	acme	swatch	Acme makes durable outdoor gear.	10	Red	red	#ef4444	https://cdn.example.com/red.png	10

Update options example#

csv

ID,Name,Slug,Sub Type,Description,Sort Order,Option ID,Option Label,Option Value,Option Color,Option Image URL,Option Sort
7,Acme,acme,swatch,Acme makes durable outdoor gear.,10,41,Red,red,#ef4444,https://cdn.example.com/red.png,10

ID	Name	Slug	Sub Type	Description	Sort Order	Option ID	Option Label	Option Value	Option Color	Option Image URL	Option Sort
7	Acme	acme	swatch	Acme makes durable outdoor gear.	10	41	Red	red	#ef4444	https://cdn.example.com/red.png	10

Webhook events#

Attribute webhook events are declared by the Attribute resource contract. The event cards below include the topic, subscription scope, store permission, payload schema, and sample payload.

Attribute created

EVENT attributes/create write_products products:write

Fired when a product attribute is created.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Can be removed/added via the Payload builder
`attribute.name`	`string`	Can be removed/added via the Payload builder
`attribute.slug`	`string`	Can be removed/added via the Payload builder
`attribute.description`	`string`	Can be removed/added via the Payload builder
`attribute.sub_type`	`string`	Can be removed/added via the Payload builder
`attribute.sort_order`	`integer`	Can be removed/added via the Payload builder
`attribute.in_use`	`boolean`	Can be removed/added via the Payload builder
`attribute.variant_usage_count`	`integer`	Can be removed/added via the Payload builder
`attribute.created_at`	`string`	Can be removed/added via the Payload builder
`attribute.updated_at`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].attribute_id`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].label`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].value`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].color`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].file_id`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].file_url`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].file_cdn_url`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].sort_order`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].created_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Product color choices.",
    "id": 7,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 7,
        "color": "#ef4444",
        "created_at": "2026-06-09T12:00:00Z",
        "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
        "file_id": "f_8f2a1c2b9d4e",
        "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
        "id": 7,
        "label": "Red",
        "sort_order": 10,
        "store_seq_id": 7,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "store_seq_id": 7,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00Z",
    "variant_usage_count": 24
  }
}

Attribute updated

EVENT attributes/update write_products products:write

Fired when a product attribute is updated.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Can be removed/added via the Payload builder
`attribute.name`	`string`	Can be removed/added via the Payload builder
`attribute.slug`	`string`	Can be removed/added via the Payload builder
`attribute.description`	`string`	Can be removed/added via the Payload builder
`attribute.sub_type`	`string`	Can be removed/added via the Payload builder
`attribute.sort_order`	`integer`	Can be removed/added via the Payload builder
`attribute.in_use`	`boolean`	Can be removed/added via the Payload builder
`attribute.variant_usage_count`	`integer`	Can be removed/added via the Payload builder
`attribute.created_at`	`string`	Can be removed/added via the Payload builder
`attribute.updated_at`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].attribute_id`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].label`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].value`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].color`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].file_id`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].file_url`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].file_cdn_url`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].sort_order`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].created_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Product color choices.",
    "id": 7,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 7,
        "color": "#ef4444",
        "created_at": "2026-06-09T12:00:00Z",
        "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
        "file_id": "f_8f2a1c2b9d4e",
        "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
        "id": 7,
        "label": "Red",
        "sort_order": 10,
        "store_seq_id": 7,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 10,
    "store_seq_id": 7,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00Z",
    "variant_usage_count": 24
  }
}

Attribute deleted

EVENT attributes/delete write_products products:write

Fired when a product attribute is deleted. Payload carries the attribute plus the options that cascaded with it.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Can be removed/added via the Payload builder
`attribute.name`	`string`	Can be removed/added via the Payload builder
`attribute.slug`	`string`	Can be removed/added via the Payload builder
`attribute.sub_type`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Can be removed/added via the Payload builder
`attribute.options[*].label`	`string`	Can be removed/added via the Payload builder
`attribute.options[*].value`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "id": 7,
    "name": "Color",
    "options": [
      {
        "id": 7,
        "label": "Red",
        "store_seq_id": 7,
        "value": "red"
      }
    ],
    "slug": "color",
    "store_seq_id": 7,
    "sub_type": "swatch"
  }
}

Attributes reordered

EVENT attributes/reorder write_products products:write

Fired when the sort order of attributes is changed. Payload carries the ordered id list.

Payload fields

Field	Type	Description
`attribute_ids`	`array`	Always present

Payload shape

Sample payload

{
  "attribute_ids": []
}

Attribute option created

EVENT attribute_options/create write_products products:write

Fired when a new option is added to an attribute.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Can be removed/added via the Payload builder
`option.attribute_id`	`integer`	Can be removed/added via the Payload builder
`option.label`	`string`	Can be removed/added via the Payload builder
`option.value`	`string`	Can be removed/added via the Payload builder
`option.color`	`string`	Can be removed/added via the Payload builder
`option.file_id`	`string`	Can be removed/added via the Payload builder
`option.file_url`	`string`	Can be removed/added via the Payload builder
`option.file_cdn_url`	`string`	Can be removed/added via the Payload builder
`option.sort_order`	`integer`	Can be removed/added via the Payload builder
`option.created_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "option": {
    "attribute_id": 7,
    "color": "#ef4444",
    "created_at": "2026-06-09T12:00:00Z",
    "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
    "file_id": "f_8f2a1c2b9d4e",
    "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
    "id": 7,
    "label": "Red",
    "sort_order": 10,
    "store_seq_id": 7,
    "value": "red"
  }
}

Attribute option updated

EVENT attribute_options/update write_products products:write

Fired when an existing attribute option is updated.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Can be removed/added via the Payload builder
`option.attribute_id`	`integer`	Can be removed/added via the Payload builder
`option.label`	`string`	Can be removed/added via the Payload builder
`option.value`	`string`	Can be removed/added via the Payload builder
`option.color`	`string`	Can be removed/added via the Payload builder
`option.file_id`	`string`	Can be removed/added via the Payload builder
`option.file_url`	`string`	Can be removed/added via the Payload builder
`option.file_cdn_url`	`string`	Can be removed/added via the Payload builder
`option.sort_order`	`integer`	Can be removed/added via the Payload builder
`option.created_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "option": {
    "attribute_id": 7,
    "color": "#ef4444",
    "created_at": "2026-06-09T12:00:00Z",
    "file_cdn_url": "https://cdn.example.com/f_8f2a1c2b9d4e.webp",
    "file_id": "f_8f2a1c2b9d4e",
    "file_url": "https://example.com/uploads/f_8f2a1c2b9d4e",
    "id": 7,
    "label": "Red",
    "sort_order": 10,
    "store_seq_id": 7,
    "value": "red"
  }
}

Attribute option deleted

EVENT attribute_options/delete write_products products:write

Fired when an attribute option is removed.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Can be removed/added via the Payload builder
`option.label`	`string`	Can be removed/added via the Payload builder
`option.value`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "option": {
    "id": 7,
    "label": "Red",
    "store_seq_id": 7,
    "value": "red"
  }
}

Attribute options reordered

EVENT attribute_options/reorder write_products products:write

Fired when the sort order of options within an attribute changes. Payload carries the attribute_id plus the ordered option_id list.

Payload fields

Field	Type	Description
`attribute_id`	`integer`	Always present
`option_ids`	`array`	Always present

Payload shape

Sample payload

{
  "attribute_id": 7,
  "option_ids": []
}