GET
View a location or vehicle
Company space For: Manager, Stock keeper · Permission: assets_{locations|vehicles}.retrieve Part of Locations, vehicles and site sharing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

asset
string
required

Identifier of the location or vehicle (27-character KSUID).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, type, name, location_group_id, created_at, updated_at, company_ids, metadata, occupied_volume, fill_rate.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: locationGroup.

Response

200 - application/json

Resource.

id

Identifier of the asset (27-character KSUID).

type

Kind of asset: location or vehicle.

name

Name of the asset, unique in the organization.

location_group_id

Identifier of the location group of a location; null for a vehicle.

location_group
object

The group (id and name); omitted when the asset has none.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

company_ids
any[]

Identifiers of the companies of the organization the asset is shared with, sorted by link id.

metadata
object

Map of every metadata key allowed for the type, with null for keys never set. Measurement values are in the unit chosen by the matching unit key.

occupied_volume

Locations only: volume of stock held at the location, expressed in the location's volume unit; null when no volume unit is set.

fill_rate

Locations only: occupied volume as a percentage of fillable_volume, rounded to two decimals; 0 when fillable_volume is not positive, null when it is not set.