Tag a Shipment

Info

What are tags, and why use tags?

Tags are simple text-based flags or identifiers. Tags can be used as a simple label, such as Guaranteed_Overnight or Fragile so shipments can be easily queried later.

You can tag an existing shipment by making the request below. In particular, we want to keep track of all these letters we keep sending to Mickey.

Example

POST /v1/shipments/:shipment_id/tags/:tag_name

Let's get a list of the last letter created for Mickey using the Disney_Letters tag.

curl -iX POST https://api.shipengine.com/v1/shipments/se-2102034/tags/Disney_Letters \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__'
{
  "shipment_id": "se-2102034",
  "tag": {
    "name": "Disney_Letters"
  }
}

Warning

New Tags

If the tag doesn't exist, we will create it for you. You can also Create a Tag manually.