---
title: "Toggle POS integration"
method: PATCH
path: "/branches/{branch_id}/status"
tags: ["Store API endpoints"]
---

# Toggle POS integration

`PATCH /branches/{branch_id}/status`

Use this endpoint to enable or disable POS integration for a branch.

By default, this toggle is disabled when a branch is created.
This is to ensure that vendors can verify that the catalog syncs are successful before enabling the POS integration.
Once enabled, orders will be processed through the partner's POS system.
If the toggle is disabled, orders will not flow through the POS system.
Instead, they will be processed manually through the branch's tablets.
However, catalog syncs can still be made for the branch, even if the toggle is off.

## Path parameters

- `branch_id` string, required

## Headers

- `Authorization` string, required
- `User-Agent` string, required
- `Brand-Id` string, required

## Request body

- UpdateBranchRequest — The active field to make branch active or inactive.
  - `active` boolean

## Response `200`

Branch updated successfully

- Branch — Branch information
  - `id` string, required — The id of the branch
  - `name` string, required — The name of the branch.
  - `brand_id` string, required — the parent brand id of this branch
  - `state` 'UNMAPPED' | 'MAPPED', required — The state of this branch.
  - `created_at` string, required — Time RFC3339 format in UTC in which the brand has been updated
  - `updated_at` string, required — Time RFC3339 format in UTC in which the brand has been updated

## Other responses

- `400` — Bad request
- `500` — Internal server error

---

[API](https://skmtc.net/careemnow/apis/careem-pos-api.md) · [All operations](https://skmtc.net/careemnow/apis/careem-pos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/careemnow/careem-pos-api/versions/374e3e0dddca/schema)