Skip to content

Trace a batch: every cylinder that carried it, and who held it

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

Every cylinder that carried value (the whole value, capitals and small letters alike), now or before, under one detail with definitionId or under any. Cylinders carrying it now come first. For each: who holds it now, and holdings, who held it while it carried the value, newest first, with dates; an open holding is where it is now. A cylinder refilled with another batch since has carriesNow false and nowCarries set, and its holders since the refill are not listed. Up to 5000 cylinders; truncated says when there were more, and the CSV export has them all.

value
required
string
>= 1 characters <= 100 characters
definitionId

UUID v7

string format: uuid

Example

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

UUID v7

The cylinders and who held them

Media typeapplication/json
object
value
required
string
summary
required
object
cylinders
required
integer
withCustomersNow
required
integer
inYardsOrVehiclesNow
required
integer
refilled
required
integer
customersBefore
required
integer
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
productId
required

UUID v7

string format: uuid
productName
required
string
state
required

Active: in use. review: something about it needs checking. faulty: out of use until repaired. lost: not where it should be. retired: no longer used.

string
Allowed values: active review faulty lost retired
serial
required
string | null
matched
required
object
definitionId
required

UUID v7

string format: uuid
name
required
string
value
required
string
carriesNow
required
boolean
carriedFrom
required
string format: date-time
carriedTo
required
string | null format: date-time
nowCarries
required
string | null
holder
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id
required

UUID v7

string | null format: uuid
name
required
string | null
holdings
required
Array<object>
object
holder
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id
required

UUID v7

string | null format: uuid
name
required
string | null
from
required
string format: date-time
to
required
string | null format: date-time
truncated
required
boolean

Example

{
"items": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"state": "active",
"matched": {
"definitionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"holder": {
"kind": "place",
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"holdings": [
{
"holder": {
"kind": "place",
"id": "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"
}
]
}