Item attributes
Custom attribute specs attached to items (text, date, number, barcode).
File-type attributes are app-only and cannot be managed via the API.
Das Attr-Objekt
Abschnitt betitelt „Das Attr-Objekt“Specification of a custom attribute that items in this team may carry (e.g. “Brand”, “Expiration Date”, “Minimum Stock”).
idintegerminimum 0, maximum 2147483647erforderlich
Attribute spec id.
attr_typestringerforderlich
Value type accepted by this attribute. text accepts any string; date accepts an ISO-8601 date (YYYY-MM-DD); number accepts a JSON number; barcode accepts a barcode string. File-type attributes exist in the BoxHero app but cannot be queried or set via the Open API.
Mögliche Wertetextdatenumberbarcode
attr_namestringerforderlich
Display name of the attribute.
ranknumbererforderlich
Sort order shown in the BoxHero app. Lower values appear first; ties are broken by id. Ranks need not be contiguous.
Beispiel
{ "id": 485697, "attr_type": "text", "attr_name": "Brand", "rank": 1}Endpunkte
Abschnitt betitelt „Endpunkte“- List attribute specs
GET /v1/item-attrs - Create an attribute spec
POST /v1/item-attrs - Get an attribute spec
GET /v1/item-attrs/{attr_id} - Rename an attribute spec
PUT /v1/item-attrs/{attr_id} - Delete an attribute spec
DELETE /v1/item-attrs/{attr_id} - Reorder attribute specs
PUT /v1/item-attrs/ranks