List the tags of an order

GET/v1/api/store/{team_slug}/sales_order/{hash_id}/tag

v1Operation ID v1_public_sales_order_tag_index

Returns the tags on a sales order or quote. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here. This is the current way to manage order tags; there is no v2 version.

Permission

Any member of the team.

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

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  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.

Related

• PUTTag an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach
• GETList tags/v1/api/store/{team_slug}/tag

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/V4keXwwxMQyXw7/tag' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

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