# Tags
The tags are used to categorize, organize, and group entities in your Ristecho Account such as Inventory Items, Customers, etc.
# The Tag Object
# Sample
{
"id": "8cd1956b",
"name": "Tag",
"name_localized": null,
"type": 1,
"created_at": "2019-02-11 07:28:29",
"updated_at": "2019-02-11 07:28:29",
"deleted_at": null
}
# Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
id | string | Unique identifier for the tag. | |
name* | string | updatable | Name of the tag. |
name_localized | string | nullable updatable | Localized name of the tag. |
type* | integer | The Tag Type | |
created_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the object was created. |
updated_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the object was updated. |
deleted_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the object was deleted. |
# Tag Types
A tag type identifies the type of entities that can be attached to the tag.
| Type | Description |
|---|---|
1 | Customer Tag. |
2 | Branch Tag. |
3 | Inventory Item Tag. |
4 | Order Tag. |
5 | Supplier Tag. |
6 | User Tag. |
7 | Product Tag. |
# List Tags
GET /tags
# Scope
general.read
# Filters
idnamename_localizedtypeupdated_afteris_deletedcreated_onupdated_ondeleted_on
# Response
{
"data": [
{
"id": "8cd1956b",
"name": "Tag",
"name_localized": null,
"type": 1,
"created_at": "2019-02-11 07:28:29",
"updated_at": "2019-02-11 07:28:29",
"deleted_at": null
}
]
}
# Get Tag
GET /tags/{tagId}
# Scope
general.read
# Response
{
"data": {
"id": "8cd1956b",
"name": "Tag",
"name_localized": null,
"type": 1,
"created_at": "2019-02-11 07:28:29",
"updated_at": "2019-02-11 07:28:29",
"deleted_at": null
}
}
# Create Tag
POST /tags
# Scope
tags.write
# Request
{
"name": "Drinks",
"name_localized": null,
"type": 1
}
# Response
{
"data": {
"id": "8cd1956b",
"name": "Tag",
"name_localized": null,
"type": 1,
"created_at": "2019-02-11 07:28:29",
"updated_at": "2019-02-11 07:28:29",
"deleted_at": null
}
}
# Update Tag
PUT /tags/{tagId}
# Scope
admin.write
# Request
{
"name": "Drinks",
"name_localized": null
}
# Response
{
"data": {
"id": "8cd1956b",
"name": "Tag",
"name_localized": null,
"type": 1,
"created_at": "2019-02-11 07:28:29",
"updated_at": "2019-02-11 07:28:29",
"deleted_at": null
}
}
# Delete Tag
DELETE /tags/{tagId}
# Scope
admin.write
# Restore Tag
The API will respond with 200 indicating that the tag has been deleted.
PUT /tags/{tagId}/restore
# Scope
admin.restore
The API will respond with 200 indicating that the tag has been restored.
← Tables Tax Groups →