Skip to content

List the tracked cylinders on an order

GET
/orders/{id}/cylinders
curl --request GET \
--url https://example.com/orders/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/cylinders \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Which cylinders went out (delivered) and came back (collected) on this order, oldest first, each with its serial number and the details that change at each fill (batch number, fill date, expiry) as they were at the time. A delivery undone puts the cylinder back (undone), after the line that delivered it. Empty when nobody recorded which cylinders went out or came back on this order.

id
required

UUID v7

string format: uuid

Example

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

UUID v7

The cylinders

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
assetId
required

UUID v7

string format: uuid
productName
required
string
serial
required
string | null
side
required

Delivered: left with the customer. collected: taken back from the customer. undone: put back because the delivery was undone. moved: any other move on the order.

string
Allowed values: delivered collected undone moved
details
required
Array<object>
object
definitionId
required

UUID v7

string format: uuid
name
required
string
value
required
string
at
required
string format: date-time

Example

{
"items": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"assetId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"side": "delivered",
"details": [
{
"definitionId": "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"
}

No such order, or 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"
}