Tags

Organise and categorise supply chain resources using tags. Tags can be applied to locations during ingestion and managed afterwards — listed, renamed across all tagged entities, or deleted entirely.

The namespace:value convention

Tags support a namespace:value shape (e.g. part_number:12345, region:emea) so related tags can be grouped and filtered by their namespace. The namespace (the part before the first colon) is always stored as lowercase snake_case; the value (everything after) is preserved verbatim. A tag with no colon simply has no namespace. This is what the ingestion per-row namespace:{Column} tag templates emit and what the namespace-rename endpoint operates on.

Use cases

  • Categorisation — group locations by commodity, supplier, region, or any custom taxonomy
  • Filtering — use tags to filter locations and metrics in other API endpoints
  • Bulk management — rename a tag, or an entire namespace, in one operation

Endpoints

MethodPathDescription
GET/tagsList all tags
PATCH/tags/:nameRename a single tag across all tagged entities
PATCH/tags/namespaces/:namespaceBulk-rename a namespace (old:* → new:*), merging on collision
DELETE/tags/:nameDelete a tag and remove it from all entities

Required scope: tags:read for listing, tags:write for renaming and deleting