Sign in

v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Get Storage Unit

Gets storage unit by ID.

get/storage_units/{id}

Path parameters

idstring required
Example:sgu_1E844FWM71S0E0TM

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required
namestring required

The name of the storage unit

descriptionstring nullable

Optional description of the storage unit

latitudenumber nullable

A WGS84 latitude in decimal degrees, between -90 and 90.

longitudenumber nullable

A WGS84 longitude in decimal degrees, between -180 and 180.

supplier_reference_idstring nullable

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

storage_location_idstring required

The ID of the storage location this storage unit belongs to

supplier_idstring required

The ID of the supplier this storage location belongs to

Example response

{
  "id": "sgu_1E844FWM71S0E0TM",
  "latitude": 51.5072,
  "longitude": -0.1276,
  "storage_location_id": "slc_1F3PMGVC91S0SBK3",
  "supplier_id": "spl_1CC712KFS1S0YKPS"
}