Appearance
Branches
Retrieve the branches configured under your merchant account. You need a branch's _id or code to create an order.
List branches
GET /integration/merchant/branch
Query parameters (all optional):
| Parameter | Notes |
|---|---|
page / limit | Pagination (default 1 / 10). |
search | Filter by branch name or address. |
active | true or false to filter by active state. |
Response: 200 OK
json
{
"success": true,
"data": {
"list": [
{
"_id": "665f...",
"name": "Main Branch",
"code": "MAIN",
"active": true,
"address": { /* location details */ }
}
],
"pagination": { "page": 1, "limit": 10, "total": 2 }
}
}Use the code field as branchCode when creating an order. Alternatively, use _id as branchId.
