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, 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.

Before you begin

It's important to note that:

  • The Tags API currently supports only the eCommerce Orders FQDN: wix.ecom.v1.order.
  • 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.
Did this help?

Tag Object


Properties
idstringRead-onlymaxLength 5

Tag ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the tag is updated.


createdDatestringRead-onlyformat date-time

Date and time the tag was created.


updatedDatestringRead-onlyformat date-time

Date and time the tag was last updated.


namestringmaxLength 255

Tag name.


fqdnstringmaxLength 255

FQDN of the entity that belongs to this tag.

Did this help?

GET

List Tags


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Tags
Read Tags
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/tags/v1/tags

Query Params
fqdnstringRequired

The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: wix.ecom.v1.order.

Response Object
tagsArray <Tag>

A list of tags.

Did this help?

POST

Create Tag


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Tags
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/tags/v1/tags

Body Params
tagTagRequired

The tag to be created.

Response Object
tagTag

The created tag.

Errors
400Invalid Argument

There is 1 error with this status code:

404Not Found

There is 1 error with this status code:

409Already Exists

There is 1 error with this status code:

429Resource Exhausted

There is 1 error with this status code:

500Internal

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

GET

Get Tag


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Tags
Read Tags
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/tags/v1/tags/{tagId}

Path Params
tagIdstringRequired

The ID of the tag to retrieve.

Response Object
tagTag

The requested tag.

Did this help?

DELETE

Delete Tag


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Tags
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/tags/v1/tags/{tagId}

Path Params
tagIdstringRequired

ID of the tag to delete.

Response Object
Returns an empty object.
Event TriggersThis method triggers the following events:
Did this help?

PATCH

Update Tag


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Tags
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/tags/v1/tags/{tag.id}

Path Params
tag.idstringRequired

Tag ID.

Body Params
tagTagRequired

The tag to be updated, which may be partial.

Response Object
tagTag

The updated tag.

Event TriggersThis method triggers the following events:
Did this help?

Tag Created


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.os.tags.v1.tag.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }
Did this help?

Tag Deleted


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.os.tags.v1.tag.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }
Did this help?

Tag Updated


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.os.tags.v1.tag.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }
Did this help?