Update Tags for an Order

This operation is used to create, update or remove tags associated with a specific order.

  • To create or update tags, provide one or more values in tagIds array.
  • To remove previously assigned tags, provide an empty array for tagIds ([]).
SecuritybearerAuth
Request
path Parameters
orderId
required
string

The orderId for the Order that needs to be updated.

Request Body schema: application/json
tagIds
required
Array of strings

List of tag identifiers to update for the Order.

Responses
200

The specified tag has been updated with the order.

401

The request could not be authorized

404

The requested resource was not found.

500

The request could not be completed due to an internal error

put/api/v1/orders/{orderId}/tags
Request samples
application/json
{
  • "tagIds": [
    ]
}
Response samples
application/json
{
  • "errorCode": "unauthorized_error",
  • "message": "Unauthorized access. Valid authentication credentials are required.",
  • "additionalInfo": "Client request lacks valid authentication credentials."
}