ItemUnits

Sets one custom-field value on one inventory unit.

Requires ManageInventory and an Idempotency-Key header. Same as editing the value on the unit's Inventory edit page: the unit's copy becomes customized (isCustomized) and stops following the item's value, and the unit's calculated values that read it are recomputed in the same write. Only this unit changes — to change the item and every uncustomized unit use PATCH /api/v1/items/{id}/properties. The value is checked against the property's type and options; calculated values and Cost / Unit Price are refused. {name} is the property name, URL-encoded, case-insensitive. Fires item.updated (changedFields``unitProperties). Example: PUT /api/v1/items/12/units/5012/properties/Color with { "value": "Blue" }.

put/api/v1/items/{id}/units/{unitId}/properties/{name}

Request

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

Path parameters

idinteger required

Numeric item id. Example: 12.

unitIdinteger required

Unit id from the list. Example: 5012.

namestring required

Property name on the unit, e.g. Color.

Request body

valuestring nullable

New value, at most 4000 characters, in the property's format (Number "12.5", Boolean "true"/"false", Date yyyy-MM-dd, Dropdown one option, MultiSelect comma-separated options); "" or null clears it.

Response

Saved; body is the unit as GET returns it.

idinteger

Unit id, e.g. 5012; used by PUT /api/v1/items/{id}/units/{unitId}/properties/{name}.

syncIdstring uuid

Globally unique sync id (GUID). Use it as the after pagination cursor.

namestring

The unit's display name (normally the item's name).

status'Available' | 'InTransit' | 'AtJobSite' | 'InBundle'

Where an inventory unit stands, derived from its location and transfer state.

locationIdinteger nullable

Id of the location holding the unit (see GET /api/v1/locations); null when it has none.

locationNamestring nullable

Name of that location; null when the unit has none.

createdAtstring date-time

UTC creation timestamp (ISO-8601) — when the unit entered stock.

updatedAtstring date-time nullable

UTC timestamp of the unit's last edit or move, including a change to one of its custom-field values; null when never changed.

Changes

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