ItemProperties

Adds an item-level custom field to an item.

Requires ManageInventory and an Idempotency-Key header. Same as "Add property" in the Items page's item modal: the property belongs to this item only (isItemLevel; the Item Template never changes it) and is also added, with the same value, to every existing inventory unit that lacks it (new stock copies it automatically). The value is checked against dataType. List types start without options; set them with PATCH .../properties/{propertyId} (ManageTemplates). Example: { "name": "Warranty (years)", "dataType": "Number", "value": "2" }.

post/api/v1/items/{id}/properties

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/items/{id}/properties
  • Auth: HTTP bearer

Path parameters

idinteger required

Numeric item id.

Request body

namestring required

Property name, 1-100 characters, unique on the item (case-insensitive); Cost and Unit Price are reserved.

dataType'Text' | 'Number' | 'Date' | 'Boolean' | 'Dropdown' | 'MultiSelect'
valuestring nullable

Starting value in the type's format (see value on GET), at most 4000 characters; omit for none.

Response

Created; body is the item's properties (the new one included), propagated = inventory units it was added to. Location points at the list.

itemIdinteger

The item (template) id, e.g. 12.

propagatedinteger

Writes only (0 on GET): how many inventory units' copies of the property were changed by the write (a new value flowing to units that were not individually customized, a new item-level property added to existing units, or the copies removed with a deleted one).

Changes

No recorded changes to this operation across all 1 revision of this API.