Labels for products, customers or suppliers. Each list is for one target type, set with ref_type.
idintegerdescriptionstringnullablenamestringref_typestringWhat this tag can be attached to. Fixed when the tag is created.
PRODUCTCUSTOMERSUPPLIER/tagscatalog:readTags for one target type; ref_type is required.
ref_typestringrequiredWhich target type's tags to return.
PRODUCTCUSTOMERSUPPLIERsearchstringnullableFree-text match on the name.
namestringnullablePartial match on the name.
sortstringnullableComma-separated field:direction pairs, e.g. id:desc. Sortable: id, name. id is always added last, so paging is stable.
limitintegerRows to return. Maximum 200.
offsetintegerRows to skip. Maximum 10000: to read further, narrow the filters or page with updated_since.
data, with pagination.curl "https://public-api.nutrasoft.ca/v1/tags?limit=50" \
-H "Authorization: Bearer $NUTRASOFT_API_KEY"{
"data": [
{
"id": 123,
"description": "string",
"name": "Sample name",
"ref_type": "PRODUCT"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
},
"order": "id:asc"
}/tags/{tag_id}catalog:readtag_idintegerrequiredThe tag's id.
data.curl "https://public-api.nutrasoft.ca/v1/tags/123" \
-H "Authorization: Bearer $NUTRASOFT_API_KEY"{
"data": {
"id": 123,
"description": "string",
"name": "Sample name",
"ref_type": "PRODUCT"
}
}/tagscatalog:writeA tag's name is unique per ref_type within your account, and ref_type cannot be changed later. A duplicate is a 409.
namestringrequiredUnique within your account, per ref_type.
ref_typestringrequiredWhat this tag can be attached to. Cannot be changed later.
PRODUCTCUSTOMERSUPPLIERdescriptionstringnullabledata.curl -X POST "https://public-api.nutrasoft.ca/v1/tags" \
-H "Authorization: Bearer $NUTRASOFT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sample name",
"ref_type": "PRODUCT"
}'{
"data": {
"id": 123,
"description": "string",
"name": "Sample name",
"ref_type": "PRODUCT"
}
}/tags/{tag_id}catalog:writeOmitted fields are left unchanged. ref_type cannot be changed.
tag_idintegerrequiredThe tag's id.
descriptionstringnullablenamestringnullabledata.curl -X PATCH "https://public-api.nutrasoft.ca/v1/tags/123" \
-H "Authorization: Bearer $NUTRASOFT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "string"
}'{
"data": {
"id": 123,
"description": "string",
"name": "Sample name",
"ref_type": "PRODUCT"
}
}/tags/{tag_id}catalog:writeRefused with 409 while the tag is attached to a product, customer, supplier or HACCP plan.
tag_idintegerrequiredThe tag's id.
data.curl -X DELETE "https://public-api.nutrasoft.ca/v1/tags/123" \
-H "Authorization: Bearer $NUTRASOFT_API_KEY"{
"data": {
"id": 123,
"description": "string",
"name": "Sample name",
"ref_type": "PRODUCT"
}
}