List Branches

GET {{baseUrl}}/branches?page=<integer>&is_default=<boolean>

This endpoint allows you to list all branches related to your store directly from this endpoint.

Scope: branches.read- Branches Read Only

Request Params

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","status":"active","location":{"lat":"\u003cstring\u003e","lng":"\u003cstring\u003e"},"street":"\u003cstring\u003e","address_description":"\u003cstring\u003e","additional_number":"\u003cstring\u003e","building_number":"\u003cstring\u003e","local":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","contacts":{"phone":"\u003cstring\u003e","whatsapp":"\u003cstring\u003e","telephone":"\u003cstring\u003e"},"preparation_time":"\u003cstring\u003e","is_open":"\u003cboolean\u003e","closest_time":"\u003cnull\u003e","working_hours":[{"name":"\u003cstring\u003e","times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]},{"name":"\u003cstring\u003e","times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]}],"is_cod_available":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e","type":"warehouse","cod_cost":"\u003cstring\u003e","country":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","name_en":"\u003cstring\u003e","code":"\u003cstring\u003e","mobile_code":"\u003cstring\u003e"},"city":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","name_en":"\u003cstring\u003e"}},{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","status":"inactive","location":{"lat":"\u003cstring\u003e","lng":"\u003cstring\u003e"},"street":"\u003cstring\u003e","address_description":"\u003cstring\u003e","additional_number":"\u003cstring\u003e","building_number":"\u003cstring\u003e","local":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","contacts":{"phone":"\u003cstring\u003e","whatsapp":"\u003cstring\u003e","telephone":"\u003cstring\u003e"},"preparation_time":"\u003cstring\u003e","is_open":"\u003cboolean\u003e","closest_time":"\u003cnull\u003e","working_hours":[{"name":"\u003cstring\u003e","times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]},{"name":"\u003cstring\u003e","times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]}],"is_cod_available":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e","type":"branch","cod_cost":"\u003cstring\u003e","country":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","name_en":"\u003cstring\u003e","code":"\u003cstring\u003e","mobile_code":"\u003cstring\u003e"},"city":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","name_en":"\u003cstring\u003e"}}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}