Update Branch

Production

PUT

https://api.salla.dev/admin/v2/branches/{branch}

Branches

Last modified:2025-02-02 12:23:10

This endpoint allows you to update branch details by passing the branch as a path parameter.

Scopes

branches.read_write- Branchs Read & Write

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Path Params

branch

integer

required

Unique identification number assigned to a Branch. List of Branch IDs can be found here.

Body Params application/json

name

string

optional

The distinctive title or label assigned to a specific location or division within an organization, typically used to differentiate and identify various operational units or physical establishments of that entity. 🌐 Support multi-language

status

enum<string>

optional

Branch Status, indicates whether a specific branch or location within an organization is currently active and operational or inactive and temporarily non-operational.

Allowed values:

activeinactive

city_id

number

optional

Branch City ID, a unique identifier assigned to a specific city or urban area where a branch or location of an organization is situated, often used for reference and geographical categorization purposes. List of cities can be found here.

country_id

number

optional

Branch Country ID, a unique identifier assigned to a specific country where a branch or location of an organization is situated, typically used for reference and geographical categorization within organizational databases or systems.
List of countries can be found here.

location

string

optional

Branch location on map ( longitude, latitude ), the geographical coordinates that specify the precise position of a branch or location on the Earth's surface, with longitude indicating the east-west position and latitude indicating the north-south position.

cod_cost

string

optional

The specific amount or fee associated with the payment method known as "cash on delivery," where customers pay for their orders in cash when they receive them, and this value represents any additional charge or fee related to this payment option.

is_cod_available

boolean

optional

Whether or not Cash on delivery isavailable.

type

string

optional

To distinguishes whether a specific location serves as a standard branch or a warehouse within an organization's infrastructure.

is_default

boolean

optional

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

address_description

string

optional

Branch address description,a textual explanation or details about the location and specifics of a branch within an organization, typically including information such as street address, building name, or additional identifying details. 🌐 Support multi-language

additional_number

string

optional

Additional (alternative) phone number. Value length is 4 characters long.

building_number

string

optional

Building Number. Value length is 4 characters long.

street

string

optional

Branch street. 🌐 Support multi-language

local

string

optional

Represents the area that consists of all these buildings. (Neighborhood). 🌐 Support multi-language

postal_code

string

optional

Branch postal code, the specific postal or ZIP code associated with a branch's location, aiding in the accurate sorting and delivery of mail and packages to that address. Value length is 5 characters long

contacts

object

optional

Branch contacts deatils.

phone

string

optional

Branch phone number, the designated telephone contact associated with a branch or location within an organization, facilitating communication with that specific site.

string

optional

The designated WhatsApp contact associated with a branch or location within an organization, allowing for communication through the WhatsApp messaging platform.

telephone

string

optional

Branch telephone number, the designated phone contact associated with a branch or location within an organization, providing a means of communication through traditional telephone services.

preparation_time

string

optional

The time required to get an order ready for shipping or picked up.

working_hours

object

optional

The hours where the branch is operating.

sunday

object

optional

The day of the week when the branch is open. Values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday

Example

{
  "name": "Riyadh",
  "city_id": 1473353380,
  "country_id": 1473353380,
  "location": "37.78044939,-97.8503951",
  "cod_cost": "15",
  "is_cod_available": true,
  "type": "branch",
  "is_default": "on",
  "address_description": "Dahran Old St",
  "street": "Mubarraz",
  "local": "Al-Hasa",
  "postal_code": "7111",
  "contacts": {
    "phone": "+201099999999",
    "whatsapp": "+201099999999",
    "telephone": "+201099999999"
  },
  "preparation_time": "01:30",
  "working_hours": {
    "sunday": {
      "enabled": "on",
      "from": [
        "08:00",
        "19:00"
      ],
      "to": [
        "17:00",
        "23:30"
      ]
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.salla.dev/admin/v2/branches/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Riyadh",
    "city_id": 1473353380,
    "country_id": 1473353380,
    "location": "37.78044939,-97.8503951",
    "cod_cost": "15",
    "is_cod_available": true,
    "type": "branch",
    "is_default": "on",
    "address_description": "Dahran Old St",
    "street": "Mubarraz",
    "local": "Al-Hasa",
    "postal_code": "7111",
    "contacts": {
        "phone": "+201099999999",
        "whatsapp": "+201099999999",
        "telephone": "+201099999999"
    },
    "preparation_time": "01:30",
    "working_hours": {
        "sunday": {
            "enabled": "on",
            "from": [
                "08:00",
                "19:00"
            ],
            "to": [
                "17:00",
                "23:30"
            ]
        }
    }
}'

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 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.

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

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-02-02 12:23:10

Branch Details

Delete Branch