Branch Details

This endpoint allows you to return the complete details for a specific branch by passing the branch as a path parameter.

Scopes

branches.read- Branches Read Only

Add the parameter

Authorization

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

Example:

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

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

object (Branch)

optional

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

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 current operational condition of a location, 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.

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": null,
        "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"
        },
        "city": {
            "id": 1355786303,
            "name": "CAIRO",
            "name_en": "CAIRO",
            "country_id": 1723506348
        }
    }
}

🟠404Not Found

🟠401Unauthorized

Request

Request samples

Responses