PUT orders/{orderKey}/tags

Apply a tag to a single order by order number or GUID. If the tag does not already exist on your account it will be created. Applying a tag the order already has makes no further change.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderKey The order number or GUID of the order to tag string Required

Body Parameters

The model containing the tag to apply

AddOrderTagModel
NameDescriptionTypeAdditional information
TagValue string None.

Request Formats

application/json, text/json

Sample: 
{
  "TagValue": "Age Verified"
}

application/xml, text/xml

Sample: 
<AddOrderTagModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TagValue>Age Verified</TagValue>
</AddOrderTagModel>

Response Information

Resource Description

Apply a tag to a single order by order number or GUID. If the tag does not already exist on your account it will be created. Applying a tag the order already has makes no further change.

OrderTagResponse
NameDescriptionTypeAdditional information
OrderTagId integer None.
TagId integer None.
TagValue string None.

Response Formats

application/json, text/json

Sample: 
{
  "OrderTagId": 1,
  "TagId": 2,
  "TagValue": "sample string 3"
}

application/xml, text/xml

Sample: 
<OrderTagResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderTagId>1</OrderTagId>
  <TagId>2</TagId>
  <TagValue>sample string 3</TagValue>
</OrderTagResponse>