HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Update Order Tags

Function

Empty tags are are created when an order is created.

To add tags to the orders. This endpoint will replace all existing tags the order already have. Developers need to get existing order tags (via get orders endpoint) and merge and edit the tags before calling this API.

Order tags can be used for segmentation of orders. Refer to search order for more information.

URL

PUT /v1/orders/id/tags

Request Example

curl --location --request PUT '<<api_domain>>/v1/orders/60c31647f946470014d63d21/tags' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
 "tags": ["tags-00", "tags-01"]
}'

Request Parameters

tags Required Array
tags[] String string to label the tags for the order
- Each tag should be between 3 to 40 characters
- A maximum of 100 unique order tag can be added per merchant

Response Example

{
  "tags": ["tag1", "tag2"]
}
tags Array Array of string of tags linked to the order