Trace a batch: every cylinder that carried it, and who held it
const url = 'https://example.com/asset-recall?value=example&definitionId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f';const options = { method: 'GET', headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
Responses
Section titled “Responses”The cylinders and who held them
object
object
object
UUID v7
UUID v7
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.
object
UUID v7
object
UUID v7
object
object
UUID v7
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
object
Example
{ "error": "not_found", "message": "Customer not found"}Not an owner or admin, missing scope, or the plan does not open Assets
object
Example
{ "error": "not_found", "message": "Customer not found"}Assets is not available to this business
object
Example
{ "error": "not_found", "message": "Customer not found"}Assets is switched off
object
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
object
object
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}