List currently online branches

GET

/api/method/public/online-ordering/get-online-branches

Returns the restaurant branches that are open right now and online ordering-ready. Provide latitude and longitude together to restrict results to branches that cover the coordinate via their delivery zones. Supply restaurant_brand to constrain the results to branches linked to that brand. Tokens bound to a specific branch always return that branch only.

Request

Authorization

Add parameter in header

X-Access-Token

Example:

X-Access-Token: ********************

Query Params

Responses

🟢200

application/json

Array of branch names that are online and open.

Body

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/method/public/online-ordering/get-online-branches?search_term&lat&lon&timestamp&restaurant_brand' \
--header 'X-Access-Token: <api-key>'

Response Example

200 - Success

{
    "message": [
        "BR-CAIRO-1",
        "BR-CAIRO-2"
    ]
}

Checkout

Submit POS orders