Tags

The tag object and the allowed CRUD operations on the related resource endpoint

One or more tags (max 10 per resource) can be associated with most of the other resources to group them under predefined labels that can be used as anchors to build custom logic and processes on top of our APIs.

Taggable resources

At the moment tags are available for the following resources:

You can still tag orders that are no longer editable, just make sure to pass in your PATCH request only the tag relationship, without changing any other attribute.

Validations

The use of tags is subject to specific restrictions and validations:

  • A maximum of 10 tags is allowed for each single resource object.

  • Each tag's name must be unique within a specific organization.

  • Each tag's name can have a maximum length of 25 chars.

  • Each tag's name must be alphanumeric and can contain underscores and hyphens (i.e. the allowed list of characters is: a—z, A—Z, 0—9, _, -). Spaces are not allowed.

Tags names aren't case-sensitive. If you use uppercase letters they will be converted to lowercase, so we recommend directly choosing lowercase names.

How-to

Last updated