ItemUnits

Returns one inventory unit of an item with its property values.

Requires ViewInventory. Supports If-None-Match.

get/api/v1/items/{id}/units/{unitId}

Request

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

Path parameters

idinteger required

Numeric item id. Example: 12.

unitIdinteger required

Unit id from the list. Example: 5012.

Response

The unit.

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.