Order Tags

Order Tag limits

GET read_orders

Get Order Tag limits.

Returns the field and request limits enforced by Order Tag endpoints. max_per_order is the most tags one order can have; assign_orders_max_count is the most order ids one tag or untag request can name.

Headers

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

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

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

Response

200

Sample response

{"success":true,"data":{"assign_orders_max_count":250,"bulk_create_max_count":50,"bulk_delete_max_count":500,"list_max_limit":500,"list_page_size":25,"max_per_order":50,"max_per_store":5000,"name_max_length":60,"page_size_options":[25,50,100,500],"search_max_length":100,"sort_columns":["name","order_count","created_at"]}}

List Order Tags

GET read_orders

List Order Tags for the store.

Returns a paginated, searchable, and sortable list. search matches anywhere in the name, ignoring capitalization, or in the slug. order_count counts the orders that have the tag; it is updated shortly after assignments change.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size, 1 to 500; defaults to 25. Example: `25`
`search`	`string`	Matches anywhere in the name or slug. Example: `gift`
`sort_by`	`string`	Sort by `name`, `order_count`, or `created_at`. Allowed values `nameorder_countcreated_at` Example: `name`
`sort_direction`	`string`	Sort direction: `asc` or `desc`. Allowed values `ascdesc` Example: `asc`

Headers

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

Errors

400 ORDER_TAG_LIST_INVALID_PAGE
Page must be a positive integer.
400 ORDER_TAG_LIST_INVALID_LIMIT
Limit is not an integer in the Order Tag range.
400 ORDER_TAG_LIST_INVALID_SORT_BY
Sort_by is not supported.
400 ORDER_TAG_LIST_INVALID_SORT_DIRECTION
Sort_direction is not supported.
400 ORDER_TAG_SEARCH_TOO_LONG
Search exceeds the maximum length.

curl 'https://api-store.tringify.com/api/2025-01/order-tags?limit=25&page=1&search=gift&sort_by=name&sort_direction=asc' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

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

Response

200

Sample response

{"success":true,"data":{"tags":[{"id":"5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70","name":"Gift wrap","slug":"gift-wrap","order_count":18,"created_at":"2026-08-01T09:30:00-04:00","updated_at":"2026-08-01T10:15:00-04:00"}],"total":1,"store_total":1,"page":1,"limit":25,"sort_by":"name","sort_direction":"asc"}}

Get an Order Tag

GET read_orders

Get one Order Tag.

Returns the Order Tag when it belongs to the token's store.

Path parameters

Name	Type	Description
`id` required	`string`	Order Tag UUID. Example: `5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70`

Headers

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

Errors

400 ORDER_TAG_REQUEST_INVALID
Id is not a valid UUID (details.field is id).
404 ORDER_TAG_NOT_FOUND
Order Tag does not exist in this store.

curl 'https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70", {
  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/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"id":"5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70","name":"Gift wrap","slug":"gift-wrap","order_count":18,"created_at":"2026-08-01T09:30:00-04:00","updated_at":"2026-08-01T10:15:00-04:00"}}

Create an Order Tag

POST write_orders

Create an Order Tag.

Creates an Order Tag. The slug is generated from the name. Sends order_tags/create.

Headers

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

Body parameters

Name	Type	Description
`name` required	`string`	Order Tag name. Example: `Gift wrap`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 ORDER_TAG_NAME_REQUIRED
Name is required.
400 ORDER_TAG_NAME_TOO_LONG
Name exceeds the configured limit.
400 ORDER_TAG_NAME_INVALID_CHARS
Name contains characters a name cannot have, such as control characters.
400 ORDER_TAG_SLUG_GENERATION_FAILED
No slug could be generated from the name.
409 ORDER_TAG_NAME_DUPLICATE
An Order Tag with this name already exists, ignoring capitalization; details.existing_id names it.
400 ORDER_TAGS_STORE_LIMIT
The store has reached its Order Tag limit.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X POST 'https://api-store.tringify.com/api/2025-01/order-tags' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Gift wrap"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "name": "Gift wrap"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/order-tags",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "name": "Gift wrap",
    },
)
data = res.json()

Response

201

Sample response

{"success":true,"data":{"id":"5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70","name":"Gift wrap","slug":"gift-wrap","order_count":18,"created_at":"2026-08-01T09:30:00-04:00","updated_at":"2026-08-01T10:15:00-04:00"}}

Bulk create Order Tags

POST write_orders

Create multiple Order Tags.

Creates tags from names. Blank names are ignored. Names that already exist, ignoring capitalization, are skipped; invalid names and names over the store limit are returned in row_errors with the same codes as Create an Order Tag, and the other names are still created. Sends order_tags/create for each tag created.

Headers

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

Body parameters

Name	Type	Description
`names` required	`array<string>`	Order Tag names to create, at most 50. Example: `["Gift wrap", "Priority"]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 ORDER_TAGS_BULK_EMPTY
Names must contain at least one item.
400 ORDER_TAGS_BULK_CREATE_MAX
The request exceeds the bulk-create cap.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X POST 'https://api-store.tringify.com/api/2025-01/order-tags/bulk-create' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "names": [
    "Gift wrap",
    "Priority"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/bulk-create", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "names": [
      "Gift wrap",
      "Priority"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/order-tags/bulk-create",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "names": ["Gift wrap", "Priority"],
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"totals":{"created":1,"skipped":0,"failed":0},"created":[{"id":"5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70","name":"Gift wrap"}],"skipped":[],"row_errors":[]}}

Rename an Order Tag

PUT write_orders

Rename an Order Tag.

Renames the tag; its slug is generated again from the new name. Sends order_tags/update, then orders/update with changed_fields tags for each order with the tag. Renaming to the current name changes nothing.

Path parameters

Name	Type	Description
`id` required	`string`	Order Tag UUID. Example: `5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70`

Headers

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

Body parameters

Name	Type	Description
`name` required	`string`	Order Tag name. Example: `Gift wrap`

Errors

400 ORDER_TAG_REQUEST_INVALID
Id is not a valid UUID (details.field is id).
404 ORDER_TAG_NOT_FOUND
Order Tag does not exist in this store.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 ORDER_TAG_NAME_REQUIRED
Name is required.
400 ORDER_TAG_NAME_TOO_LONG
Name exceeds the configured limit.
400 ORDER_TAG_NAME_INVALID_CHARS
Name contains characters a name cannot have, such as control characters.
400 ORDER_TAG_SLUG_GENERATION_FAILED
No slug could be generated from the name.
409 ORDER_TAG_NAME_DUPLICATE
An Order Tag with this name already exists, ignoring capitalization; details.existing_id names it.
409 TAG_MUTATION_RETRY
The tag changed or its new slug was taken while renaming; nothing changed. Retry the request.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Gift wrap"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "name": "Gift wrap"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "name": "Gift wrap",
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"id":"5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70","name":"Gift wrap","slug":"gift-wrap","order_count":18,"created_at":"2026-08-01T09:30:00-04:00","updated_at":"2026-08-01T10:15:00-04:00"}}

Tag orders

POST write_orders

Add the Order Tag to orders.

Adds the tag to every listed order of the token's store that does not have it. added is the number of orders tagged; already_tagged lists ids that already had the tag and not_found lists ids that are not orders of this store, so one bad id does not fail the batch. If any order would go over the tags an order can have (max_per_order from Order Tag limits), no order is changed and ORDER_TAGS_PER_ORDER_LIMIT is returned. Each order tagged sends orders/update with changed_fields tags. The message is ORDERS_BULK_TAGGED when every id was tagged, otherwise ORDERS_BULK_TAGGED_PARTIAL with the three counts. Duplicate ids count once.

Path parameters

Name	Type	Description
`id` required	`string`	Order Tag UUID. Example: `5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70`

Headers

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

Body parameters

Name	Type	Description
`order_ids` required	`array<string>`	Order UUIDs to tag, at most 250. Example: `["da9b07a6-803f-4e41-8a18-97ff831bd588"]`

Errors

400 ORDER_TAG_REQUEST_INVALID
Id is not a valid UUID (details.field is id).
404 ORDER_TAG_NOT_FOUND
Order Tag does not exist in this store.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 ORDER_TAG_NO_ORDER_IDS
order_ids is empty.
400 ORDER_TAG_REQUEST_INVALID
An order id is not a valid UUID (details.field is order_ids).
400 ORDER_TAG_ORDERS_MAX
More order ids than assign_orders_max_count from Order Tag limits.
400 ORDER_TAGS_PER_ORDER_LIMIT
A listed order already has the most tags an order can have; no order was changed.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X POST 'https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70/orders' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "order_ids": [
    "da9b07a6-803f-4e41-8a18-97ff831bd588"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70/orders", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "order_ids": [
      "da9b07a6-803f-4e41-8a18-97ff831bd588"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70/orders",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "order_ids": ["da9b07a6-803f-4e41-8a18-97ff831bd588"],
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"added":2,"already_tagged":["0b6a2f8e-3c1d-4e5f-9a7b-8c9d0e1f2a3b"],"not_found":[]},"code":"ORDERS_BULK_TAGGED_PARTIAL","message":"Orders tagged: 2, already tagged: 1, not found: 0."}

Untag orders

POST write_orders

Remove the Order Tag from orders.

Removes the tag from every listed order of the token's store that has it. removed is the number of orders untagged; not_tagged lists ids that did not have the tag and not_found lists ids that are not orders of this store. Each order untagged sends orders/update with changed_fields tags. The message is ORDERS_BULK_UNTAGGED when every id was untagged, otherwise ORDERS_BULK_UNTAGGED_PARTIAL. Duplicate ids count once.

Path parameters

Name	Type	Description
`id` required	`string`	Order Tag UUID. Example: `5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70`

Headers

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

Body parameters

Name	Type	Description
`order_ids` required	`array<string>`	Order UUIDs to untag, at most 250. Example: `["da9b07a6-803f-4e41-8a18-97ff831bd588"]`

Errors

400 ORDER_TAG_REQUEST_INVALID
Id is not a valid UUID (details.field is id).
404 ORDER_TAG_NOT_FOUND
Order Tag does not exist in this store.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 ORDER_TAG_NO_ORDER_IDS
order_ids is empty.
400 ORDER_TAG_REQUEST_INVALID
An order id is not a valid UUID (details.field is order_ids).
400 ORDER_TAG_ORDERS_MAX
More order ids than assign_orders_max_count from Order Tag limits.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X POST 'https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70/orders/remove' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "order_ids": [
    "da9b07a6-803f-4e41-8a18-97ff831bd588"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70/orders/remove", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "order_ids": [
      "da9b07a6-803f-4e41-8a18-97ff831bd588"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70/orders/remove",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "order_ids": ["da9b07a6-803f-4e41-8a18-97ff831bd588"],
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"removed":2,"not_tagged":[],"not_found":[]},"code":"ORDERS_BULK_UNTAGGED","message":"Tag removed from 2 orders."}

Delete an Order Tag

DELETE write_orders

Delete an Order Tag.

If orders have the tag, retry with the returned confirmation token. Sends order_tags/delete; the tag is then removed from its orders in the background, each sending orders/update with changed_fields tags.

Path parameters

Name	Type	Description
`id` required	`string`	Order Tag UUID. Example: `5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70`

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 ORDER_TAG_REQUEST_INVALID
Id is not a valid UUID (details.field is id).
404 ORDER_TAG_NOT_FOUND
Order Tag does not exist in this store.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
409 CONFIRMATION_REQUIRED
Orders have the tag; deletion requires confirmation. details.affected_order_count is the number of orders.
400 ORDER_TAG_CONFIRMATION_INVALID
The confirmation token is invalid or expired, or a tag changed since it was issued; obtain a fresh confirmation.
409 TAG_MUTATION_RETRY
A tag is being changed by another request; nothing was deleted. Retry the request.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X DELETE 'https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70", {
  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/order-tags/5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"deleted":true,"id":"5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70"}}

Bulk delete Order Tags

POST write_orders

Delete multiple Order Tags.

Deletes the selected store-scoped UUIDs transactionally; ids that are not UUIDs or not tags of this store are listed in failed. If orders have any of the tags, retry with the returned confirmation token and the same ids. Sends order_tags/delete for each tag deleted; the tags are then removed from their orders in the background, each sending orders/update with changed_fields tags.

Headers

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

Body parameters

Name	Type	Description
`tag_ids` required	`array<string>`	Store-scoped Order Tag UUIDs, at most 500. Example: `["5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70"]`
`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.
400 ORDER_TAGS_NONE_SPECIFIED
Tag_ids must contain at least one id.
400 ORDER_TAGS_BULK_DELETE_MAX
The request exceeds the bulk-delete cap.
409 CONFIRMATION_REQUIRED
Orders have the tag; deletion requires confirmation. details.affected_order_count is the number of orders.
400 ORDER_TAG_CONFIRMATION_INVALID
The confirmation token is invalid or expired, or a tag changed since it was issued; obtain a fresh confirmation.
409 TAG_MUTATION_RETRY
A tag is being changed by another request; nothing was deleted. Retry the request.
400 STORE_API_BODY_PROPERTY_UNKNOWN
The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).
400 STORE_API_BODY_PROPERTY_INVALID
A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

curl -X POST 'https://api-store.tringify.com/api/2025-01/order-tags/bulk-delete' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "tag_ids": [
    "5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/order-tags/bulk-delete", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "tag_ids": [
      "5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/order-tags/bulk-delete",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "tag_ids": ["5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70"],
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"deleted":["5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70"],"failed":[]}}

Field	Type	Create	Update	Required	Translatable
`name`	text	Yes	Yes	create, update	No
`slug`	slug	No	No		No
`order_count`	integer	No	No		No
`created_at`	datetime	No	No		No
`updated_at`	datetime	No	No		No

Order tag created

EVENT order_tags/create App scope: read_orders Staff permission: orders:read

Fired when an order tag is created, including a tag created by adding a new name to an order. Adding the tag to or removing it from an order sends orders/update (tags).

Payload fields

Field	Type	Description
`tag.id`	`string`	Always present
`tag.name`	`string`	Selectable in the Payload builder
`tag.slug`	`string`	Selectable in the Payload builder
`tag.order_count`	`integer`	Selectable in the Payload builder
`tag.created_at`	`string`	Selectable in the Payload builder
`tag.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "tag": {
    "created_at": "2026-08-01T09:30:00-04:00",
    "id": "5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    "name": "Gift wrap",
    "order_count": 18,
    "slug": "gift-wrap",
    "updated_at": "2026-08-01T10:15:00-04:00"
  }
}

Order tag updated

EVENT order_tags/update App scope: read_orders Staff permission: orders:read

Fired when an order tag is renamed. Each order with the tag then sends orders/update (tags).

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

name slug

Payload fields

Field	Type	Description
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.order_count`	`integer`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.order_count`	`integer`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "name",
    "slug"
  ],
  "current": {
    "created_at": "2026-08-01T09:30:00-04:00",
    "id": "5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    "name": "Gift wrap",
    "order_count": 18,
    "slug": "gift-wrap",
    "updated_at": "2026-08-01T10:15:00-04:00"
  },
  "previous": {
    "created_at": "2026-08-01T09:30:00-04:00",
    "id": "5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    "name": "Gift wrap",
    "order_count": 18,
    "slug": "gift-wrap",
    "updated_at": "2026-08-01T10:15:00-04:00"
  }
}

Order tag deleted

EVENT order_tags/delete App scope: read_orders Staff permission: orders:read

Fired when an order tag is deleted. Each order that had the tag then sends orders/update (tags) as the tag is removed from it.

Payload fields

Field	Type	Description
`tag.id`	`string`	Always present
`tag.name`	`string`	Selectable in the Payload builder
`tag.slug`	`string`	Selectable in the Payload builder
`tag.order_count`	`integer`	Selectable in the Payload builder
`tag.created_at`	`string`	Selectable in the Payload builder
`tag.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "tag": {
    "created_at": "2026-08-01T09:30:00-04:00",
    "id": "5d0c8a4e-2b7f-4e19-9c3a-6f1e2d4b8a70",
    "name": "Gift wrap",
    "order_count": 18,
    "slug": "gift-wrap",
    "updated_at": "2026-08-01T10:15:00-04:00"
  }
}

Endpoints#

Headers

Query parameters

Headers

Errors

Path parameters

Headers

Errors

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Fields#

Webhook events#

Payload fields

Possible changed_fields values

Payload fields

Payload fields

Possible `changed_fields` values