Get

[POST] .../v1/tag/get

Returns price tag template. Read price tag templates before previewing or printing item labels. The response returns Tag rows with id, name, optional template data and last_update; the request body is required, include_data must be explicitly provided and filters support id. The caller must have price tag select permission 126 and include_data controls whether the template data text is returned. Missing body, missing include_data, denied permission, invalid filters and lookup failures are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
include_data Boolean Required Include price tag template data in the response: true - include, false - do not include.

Filterable Fields

Field Type Description
id int Price tag template ID.

Request Example

{
  "include_data": true,
  "filters": [
    {
      "Field": "id",
      "Operator": "Equal",
      "Value": "3"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of Tag Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 3,
      "name": "Shelf label 58mm",
      "data": "\u003Chtml\u003E{{item.name}}\u003C/html\u003E",
      "last_update": 1712345600
    }
  ]
}