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:
A FQDN serves as an identifier for the primary entity of an API, such as Orders. For instance, an eCommerce order can have associated 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, call List Tags with the Orders FQDN.
It's important to note that:
wix.ecom.v1.order
.Tag ID.
Revision number, which increments by 1 each time the tag is updated.
Date and time the tag was created.
Date and time the tag was last updated.
Tag name.
FQDN of the entity that belongs to this tag.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of tags.
You can only call this method when authenticated as a Wix app or Wix user identity.
The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: wix.ecom.v1.order
.
A list of tags.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a tag.
You can only call this method when authenticated as a Wix app or Wix user identity.
The tag to be created.
The created tag.
There is 1 error with this status code:
There is 1 error with this status code:
There is 1 error with this status code:
There is 1 error with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a tag.
You can only call this method when authenticated as a Wix app or Wix user identity.
The ID of the tag to retrieve.
The requested tag.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a tag.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the tag to delete.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a tag.
You can only call this method when authenticated as a Wix app or Wix user identity.
Tag ID.
The tag to be updated, which may be partial.
The updated tag.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.os.tags.v1.tag
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.os.tags.v1.tag_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.os.tags.v1.tag
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.os.tags.v1.tag_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.os.tags.v1.tag
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.os.tags.v1.tag_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}