UtilitayDevelopers
Get an API key
API reference

Requests

/requests

What a customer's walk through a menu ends in: what they asked for, when, where and for whom. Read the inbox, answer what waits, check a customer's code at the counter, and change what is booked. Every move here is the one the dashboard and the staff phone menu make, under the same rules, and the customer is told by message where the business has linked Raven.

GET/requests/listThe inboxGET/requests/retrieve/{request_id}One request, wholePOST/requests/approve/{request_id}Say yesPOST/requests/decline/{request_id}Say no, with a reasonPOST/requests/verifyCheck a customer's codeshown →POST/requests/cancel/{request_id}Call it offPOST/requests/reschedule/{request_id}Move it to another timePOST/requests/reassign/{request_id}Give it to someone else

POSTCheck a code

Requires verifications:write. Before you serve someone, check the six-digit code they were given. A right code closes the request as verified, in one step. It matches only an approved request that is due now: from 12 hours before its time until the business's grace after it, or any time before fulfil_by for a request with no time. A wrong code is an answer, not an error: 200 with outcome wrong. Wrong codes are counted per key, and after the business's limit (5 unless it changed it) the key is locked out for its lockout (30 minutes unless changed).

Body
codestring · required · digits
What the customer reads out. Codes are six digits; anything else is wrong.
branch_iduuid · optional
Match only that branch's requests: send it from a counter that serves one branch.
Returns

What the check found. When it is verified, read the summary and the identity out before you serve.

Response body

One check: press Response on the sample to see one whole.

FieldTypeDescription
outcomeverified | wrong | lockedverified: the request is closed. wrong: no open request due now has that code. locked: too many wrong codes from this key.
request_iduuid | nullSet when verified.
referencestring | null
summarystring | nullRead it out before you serve.
customer_namestring | null
identitystring | nullThe ID the menu asked for, masked: “National ID ***482”. Check it against the person.
attempts_leftinteger | nullAfter a wrong code: how many more before this key is locked out.
locked_untildatetime | nullWhen locked: when this key may try again.

Amounts are integers in cents, with no currency. On failure the body is { error, code } instead.

Previous← Authentication, keys and scopesNextCategories and packs →