Tag an order

PUT/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach

v1Operation ID v1_public_sales_order_tag_attach

Adds an existing tag to a sales order or quote. Adding a tag it already has changes nothing.

Create new tags with the team's tag operations. The answer is the order's tags. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

Side effects

• Refreshes the order for people who have it open in the web app.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7

Request body

application/json, required.

• idstringrequired

  The tag's id, from the team's tags.

Response

200Successful response.

• dataarray of objectsrequired

  The order's tags after the change.

  Fields of each item (3)

  • color_hexstring | null

    Tag color, for example #E53935.

  • idstring
  • namestring
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  The tag or the order does not exist in this team.

  Fix

  Use a tag id from the team's tags.

Related

• PUTRemove a tag from an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/detach
• GETList tags/v1/api/store/{team_slug}/tag
• POSTCreate a tag/v1/api/store/{team_slug}/tag

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/V4keXwwxMQyXw7/tag/attach' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "id": "7qYPMmbLZR9oFg"  }'

Example response 200

Response

{
  "data": [
    {
      "color_hex": "#E53935",
      "id": "7qYPMmbLZR9oFg",
      "name": "Rush"
    }
  ],
  "status": 200,
  "success": true
}