Skip to content

Where cylinders are

GET
/asset-reports/where
curl --request GET \
--url 'https://example.com/asset-reports/where?productId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Tracked cylinders by product: in yards (and of those, in quarantine), on vehicles, with customers, with suppliers and elsewhere (between yards or not recorded). Lost and retired cylinders are left out. With at, where each was at the end of that day in London, read from its journey; quarantine is not known for a past day and is null.

at

A past day, YYYY-MM-DD: where cylinders were at the end of it, London time. Now when left out.

string format: date

A past day, YYYY-MM-DD: where cylinders were at the end of it, London time. Now when left out.

productId

Only cylinders of this product. Every tracked product when left out.

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

Only cylinders of this product. Every tracked product when left out.

Cylinders by where they are

Media typeapplication/json
object
at
required
string | null format: date
totals
required
object
place
required
integer
vehicle
required
integer
customer
required
integer
supplier
required
integer
elsewhere
required
integer
quarantine
required
integer | null
total
required
integer
products
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
counts
required
object
place
required
integer
vehicle
required
integer
customer
required
integer
supplier
required
integer
elsewhere
required
integer
quarantine
required
integer | null
total
required
integer

Example

{
"products": [
{
"productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not an owner or admin, missing scope, or the plan does not open Assets

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Assets is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Assets is switched off

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}