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 inboxshown →GET/requests/retrieve/{request_id}One request, whole POST/requests/approve/{request_id}Say yes POST/requests/decline/{request_id}Say no, with a reason POST/requests/verifyCheck a customer's code POST/requests/cancel/{request_id}Call it off POST/requests/reschedule/{request_id}Move it to another time POST/requests/reassign/{request_id}Give it to someone else

GETList requests

Requires requests:read. Newest first, by when they were submitted. A request that waits for an answer is status=submitted.

Query parameters

limitinteger · default 50 · max 200

offsetinteger · default 0

qstring · optional · max 100

Up to six letters or digits: matches the reference. Anything longer: matches the summary.

statusstring · optional

One of submitted, approved, verified, completed, unclaimed, cancelled, declined, expired.

sincedate · optional

Submitted on or after this day (UTC). For a poll: since yesterday, and skip what you have seen by id.

Returns

An array of requests, the inbox's columns only. Read one whole with GET /requests/retrieve.

Response body

A bare JSON array. Each item is one request: press Response on the sample to see one whole.

FieldTypeDescription

iduuid

referencestringSix characters, safe to say aloud and show anywhere: what a customer quotes. Never the code.

channelussd | whatsappWhere it was made.

summarystringOne line, as the business's inbox shows it. 160 characters at most.

total_centsinteger | nullThe sum of the lines and places, in cents. null where something has no fixed price.

quote_centsinteger | nullThe business's own price, where it quoted one.

pricedbooleanfalse: something asked for has no fixed price, and the business quotes.

service_atdatetime | nullWhen it is for. null for a request with no time, such as an order.

service_enddatetime | null

expires_atdatetime | nullWhile submitted: when it expires if nobody answers.

submitted_atdatetime

decided_atdatetime | null

closed_atdatetime | nullSet once the status is no longer submitted or approved.

branch_iduuid | null

menu_iduuid

customer_iduuid | nullnull once the customer's record has been erased.

codes_onbooleanWhether this request is closed by checking the customer's code.

customer_namestring | nullThe name given in the menu, else the customer's.

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

Previous← Authentication, keys and scopes NextCategories and packs →