Release Date
August 4, 2026
Relevant Endpoints
POST /v3/order/<order_number>/tag/<tag_id>
DELETE /v3/order/<order_number>/tag/<tag_id>
POST /v3/order/<order_number>/tag_by_name/<tag_name>
DELETE /v3/order/<order_number>/tag_by_name/<tag_name>
Breaking Changes
In order to continue standardizing our API we are updating the way tags are applied to orders. Currently, when applying or removing tags from orders you pass the <tag_id> in the URL. We are deprecating this in favor of passing the <tag_name>.
For example:
/v3/order/<order_number>/tag/<tag_id>
will become
/v3/order/<order_number>/tag/<tag_name>
To avoid any disruptions we’ve decided to do this in two phases using a temporary endpoint in the interim.
Therefore the previous example will include an intermediate step:
/v3/order/<order_number>/tag/<tag_id>
becomes (before August 4th)
/v3/order/<order_number>/tag_by_name/<tag_name>
becomes (after August 4th)
/v3/order/<order_number>/tag/<tag_name>
Phase Details
Phase 1 (Now until August 4th)
To give API users time to migrate we’ve added the following TEMPORARY endpoints:
POST /v3/order/<order_number>/tag_by_name/<tag_name>
DELETE /v3/order/<order_number>/tag_by_name/<tag_name>
These endpoints are available today and you will need to switch to them by August 4th. After August 4th you will receive 404 response codes and potentially inconsistent behavior if you continue to use the original endpoint passing tag_id.
Action item recap:
Migrate
/v3/order/<order_number>/tag/<tag_id>
to
/v3/order/<order_number>/tag_by_name/<tag_name>
Phase 2 (After August 4th)
On August 4th the original endpoint will be switched from tag_id to tag_name. At this point the /v3/order/<order_number>/tag/<tag_name> endpoint will be available for general use. The temporary tag_by_name endpoints outlined in Phase 1 will continue to function until September 8th, thus allowing one month of overlap for you to update your applications.
Action item recap:
Migrate
/v3/order/<order_number>/tag_by_name/<tag_name>
to
/v3/order/<order_number>/tag/<tag_name>