Skip to content

Serials a phone matches its camera readings against

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

The serials of the batch’s product in quarantine or empty at its yard, or last recorded at a supplier or nowhere (the cylinders check calls quarantined, empty or expected), and the business’s format for the serial when it has one. At most 5,000; truncated says more were left out. The phone keeps them, so a reading is matched without signal. A reading that matches none of them is shown to the person to confirm or type.

id
required

UUID v7

string format: uuid

Example

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

UUID v7

Serials to match against

Media typeapplication/json
object
serials
required
Array<string>
truncated
required
boolean
pattern
required
string | null

Example generated

{
"serials": [
"example"
],
"truncated": true,
"pattern": "example"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Missing scope or role, 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"
}

Not found, 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, another cylinder already has that detail, or a batch release needs confirming

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"
}
]
}