Salla Docs

List Branches

Production

https://api.salla.dev/admin/v2

GET

/branches

Branches

Last modified:2025-04-21 14:18:53

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

Scopes

branches.read- Branches Read Only

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.salla.dev/admin/v2/branches?page=4&is_default=true&keyword=Main Branch'

Response Example

200 - Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 1846327032,
            "name": "مركز الجمال",
            "status": "active",
            "location": {
                "lat": "30.0778",
                "lng": "31.2852"
            },
            "street": "الرحمة",
            "address_description": "123 شارع الرحمة",
            "additional_number": "6666",
            "building_number": "6666",
            "local": "omm",
            "postal_code": "66666",
            "contacts": {
                "phone": "+966508265874",
                "whatsapp": "+966508265874",
                "telephone": "012526886"
            },
            "preparation_time": "6",
            "is_open": true,
            "closest_time": "09:00",
            "working_hours": [
                {
                    "name": "السبت",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "23:55"
                        }
                    ]
                },
                {
                    "name": "الأحد",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "23:55"
                        }
                    ]
                },
                {
                    "name": "الإثنين",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "23:55"
                        }
                    ]
                },
                {
                    "name": "الثلاثاء",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "23:55"
                        }
                    ]
                },
                {
                    "name": "الأربعاء",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "23:55"
                        }
                    ]
                },
                {
                    "name": "الخميس",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "23:55"
                        }
                    ]
                },
                {
                    "name": "الجمعة",
                    "times": [
                        {
                            "from": "19:00",
                            "to": "23:55"
                        }
                    ]
                }
            ],
            "is_cod_available": true,
            "is_default": true,
            "type": "branch",
            "cod_cost": "5.00",
            "country": {
                "id": 1723506348,
                "name": "مصر",
                "name_en": "Egypt",
                "code": "EG",
                "mobile_code": "+20",
                "capital": "Cairo"
            },
            "city": {
                "id": 1355786303,
                "name": "CAIRO",
                "name_en": "CAIRO",
                "country_id": 1723506348
            }
        },
        {
            "id": 1005180409,
            "name": "فرع مول البستان",
            "status": "active",
            "location": {
                "lat": "30.0778",
                "lng": "31.2852"
            },
            "street": "اكتوبر",
            "address_description": "65  حي الزعفران",
            "additional_number": "8888",
            "building_number": "14",
            "local": "العاشر من رمضان",
            "postal_code": "564325",
            "contacts": {
                "phone": "",
                "whatsapp": "",
                "telephone": ""
            },
            "preparation_time": "6",
            "is_open": true,
            "closest_time": "09:00",
            "working_hours": [
                {
                    "name": "السبت",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "18:00"
                        }
                    ]
                },
                {
                    "name": "الأحد",
                    "times": [
                        {
                            "from": "09:00",
                            "to": "18:00"
                        }
                    ]
                },
                {
                    "name": "الأربعاء",
                    "times": [
                        {
                            "from": "06:00",
                            "to": "22:00"
                        }
                    ]
                }
            ],
            "is_cod_available": true,
            "is_default": false,
            "type": "branch",
            "cod_cost": "5.00",
            "country": {
                "id": 1723506348,
                "name": "مصر",
                "name_en": "Egypt",
                "code": "EG",
                "mobile_code": "+20"
            },
            "city": {
                "id": 1355786303,
                "name": "CAIRO",
                "name_en": "CAIRO",
                "country_id": 1723506348
            }
        }
    ],
    "pagination": {
        "count": 1,
        "total": 1,
        "perPage": 15,
        "currentPage": 1,
        "totalPages": 1,
        "links": []
    }
}

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

page

integer

optional

The Pagination page number

Example:

is_default

boolean

optional

Whether or not this branch is the default one for all operations

Example:

true

keyword

string

optional

Search using a keyword

Example:

Main Branch

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Branch) {21}]

optional

number

required

The unique identifier of a branch.

name

string

required

The label given to a specific branch. 🌐 Support multi-language

status

enum<string>

required

The status of the branch, indicating whether it is "Active" as open for business or "Inactive" as closed.

Allowed values:

activeinactive

location

object

required

Branch's location on map in both longitude and latitude

street

string

required

Branch's street name. 🌐 Support multi-language

address_description

string

required

Branch's address description. 🌐 Support multi-language

additional_number

string

required

Branch's additional (alternative) phone number.

building_number

string

required

Branch's building number.

local

string

required

Branch's local district. 🌐 Support multi-language

postal_code

string

required

Branch's postal code. Value length is 5 characters long.

contacts

object

required

Branch's contacts details.

preparation_time

string

required

The time required for the branch to get an order ready for shipping or pickup.

is_open

boolean

required

Whether or not the branch is currently open or closed

closest_time

string | null

required

The time when the branch will be closed based on the request time. Each request may have a different value.

working_hours

array [object {2}]

required

Branch working hours. Required if branch.type is "branch"

is_cod_available

boolean

required

Whether or not Cash on delivery available.

is_default

boolean

required

Whether or not this branch is the default branch for all operations.

type

enum<string>

required

Branch type, either a standard branch or warehouse

Allowed values:

branchwarehouse

cod_cost

string

required

Cash on delivery cost value

country

object (Country)

required

Detailed structure of the country model object showing its fields and data types.

city

object (City)

required

Detailed structure of the city model object showing its fields and data types.

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

🟠401Unauthorized

Modified at 2025-04-21 14:18:53

Create Branch

Branch Details