Locations

Returns one stock location.

Requires ViewInventory. id may be the numeric id or the syncId. Sends a weak ETag.

get/api/v1/locations/{id}

Request

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

Path parameters

idstring required

Numeric id or SyncId.

Response

The location.

idinteger

Numeric id, usable in /api/v1/locations/{id} and stock writes.

syncIdstring uuid

Stable cross-device id; also the pagination cursor.

namestring

Display name, e.g. Main Warehouse.

addressstring nullable

Street address when recorded; null otherwise.

parentLocationIdinteger nullable

Id of the containing location; null for a top-level location.

locationTypestring

Name of the location's type as configured by the organization, e.g. Warehouse, Vehicle, Job Site.

isJobSiteboolean

True for a customer job site: stock there is "delivered", never counted as on hand, and cannot be adjusted or moved directly.

isTransportVehicleboolean

True for a vehicle (van, truck) that carries stock.

isSystemLocationboolean

True for the organization's built-in No Location bucket, the default for stock created without a location.

statusstring

One of Active, Inactive, Maintenance, Temporary.

jobIdinteger nullable

For a job site: the job it belongs to; null otherwise.

createdAtstring date-time

UTC creation time.

updatedAtstring date-time nullable

UTC last modification time; null when never edited.

Changes

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