ItemUnits

Lists an item's inventory units with their per-unit property values, one page at a time.

Requires ViewInventory. Every active unit is listed, including units in transit, at job sites and in bundles (see status). Example: GET /api/v1/items/12/units?locationId=3 returns the units held at location 3. Also available as CSV (Accept: text/csv or ?format=csv; properties is one JSON cell); paging cursor in X-Next-Cursor.

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

Request

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

Path parameters

idinteger required

Numeric item id. Example: 12.

Query parameters

locationIdinteger

Only units held at this location.

updatedSincestring date-time

Only units created or changed (including a custom-field value change) at/after this UTC instant (ISO-8601).

afterstring

SyncId of the last unit of the previous page; omit for the first page.

limitinteger

Page size, 1-200 (default 50).

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

A page of units.

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

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