About the Tags API

Tags are labels attached to entities, allowing for flexible categorization and data management. For example, you can use tags to filter entities in a table view.

With the Tags API, you can:

• Retrieve detailed information about a specific tag.
• List all tags associated with a specific Fully Qualified Domain Name (FQDN).

A FQDN serves as an identifier for the primary entity of an API. To find out if an entity supports tagging, check the documentation for that specific entity or service. For example, eCommerce Orders support tags. When retrieving information about an order, such as through Get Order, the response includes any related tags. To retrieve all tags for all orders, use the Tags API to call List Tags with the Orders FQDN.

You can find an entity's FQDN in webhook response data for that entity.

Before you begin

It's important to note the following points before starting to code:

• Check the specific entity or service to determine if it supports tags.
• Each FQDN can have a maximum of 100 tags.

Terminology

• FQDN (Fully Qualified Domain Name): The unique identifier for the primary entity of an API, such as Orders.