Appearance
Branch Management
The Branch APIs allow merchants to manage multiple physical store locations, warehouses, or pickup centers. Each branch can have specific stock inventory, address information, and branch-specific price overrides.
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/branches | Retrieve all branches for the store. |
POST | /v1/branches | Create a new branch. |
GET | /v1/branches/{id} | Retrieve details of a specific branch. |
PATCH | /v1/branches/{id} | Update branch information. |
DELETE | /v1/branches/{id} | Delete a branch. |
PATCH | /v1/branches/{id}/online-branch | Designate a branch as the online fulfillment branch. |
GET | /v1/branches/{id}/price-overrides | List branch-specific price overrides. |
PUT | /v1/branches/{id}/price-overrides | Set or update a branch-specific price override. |
DELETE | /v1/branches/{id}/price-overrides | Clear a branch-specific price override. |
GET | /v2/branches/lookup | Paginated minimal branch lookup for dropdowns and filters. |
