Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

Get branch status on SuperApp

Use this endpoint to read a branch's current visibility status on SuperApp.

The status reflects the latest known outlet state:

  • active: branch is live and accepting orders.
  • inactive: branch is temporarily not accepting orders and can be reactivated by the partner.
  • offline: branch is not accepting orders and can only be reactivated by Careem operations.

reason carries the human-readable reason when the branch is not active (otherwise null). can_reactivate is null when not applicable (active), true when the partner can self-reactivate (inactive), and false when only Careem ops can (offline).

get/branches/{branch_id}/visibility/status

Path parameters

branch_idstring required

A unique branch ID string provided by vendor or restaurant

Headers

Authorizationstring required
User-Agentstring required
Brand-Idstring required

Response

Branch status retrieved successfully

branch_idstring

The unique branch ID string provided by the vendor or restaurant.

status'active' | 'inactive' | 'offline'

The current visibility status of the branch on SuperApp.

reasonstring nullable

Human-readable reason the branch is not active. Null when the branch is active.

can_reactivateboolean nullable

Null when not applicable (active); true when the partner can self-reactivate (inactive); false when only Careem operations can reactivate (offline).

Example response

{
  "status": "inactive"
}