Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Branches
  • Welcome 👋
  • Get Started
  • Create Your First App
  • Authorization
  • Webhooks
  • Conditional Webhooks
  • Security Considerations
  • Multi-Language Support
  • Responses
  • Pagination
  • Rate Limiting
  • Versioning
  • Change Log
  • Support
  • APIs
    • Orders
      • Create Order
      • List Orders
      • Order Details
      • Create Drafted Order
      • Update Order
      • Duplicate Order
      • Order Actions
    • Order Status
      • Update Order Status
      • Create Custom Order Status
      • List Order Statuses
      • Order Status Details
      • Update Custom Order Status
      • Update Bulk Orders Statuses
      • Sort Orders Statuses
    • Order Histories
      • List Order Histories
      • Create Order History
    • Order Tags
      • Create Order Tag
      • List Order Tags
      • Delete Order Tag
    • Order Invoice
      • Create Invoice
      • List Invoices
      • Invoice Details
      • Send Order Invoice
      • Create Order Invoice
    • Order Reservations
      • List Order Reservations
    • Order Items
      • List Order Items
      • Create Order Item
      • Update Order Item
      • Delete Order Item
    • Products
      • Create Product
      • List Products
      • Product Details
      • Update Product
      • Delete Product
      • Change Product Status
      • Product Details By SKU
      • Update Product By SKU
      • Delete Product By SKU
      • Update Product Price By SKU
      • Update Bulk Product Prices
      • Import Products
      • Bulk Product Actions
    • Product Options
      • Create Product Option
      • Product Option Details
      • Update Product Option
      • Delete Product Option
    • Product Quantity
      • List Product Quantities
      • Update Bulk Quantities
      • List Quantity Change Reasons
      • List Quantity Audit
      • Update Bulk Quantities by SKU
      • Update Quantity
      • Update Quantity By SKU
    • Product Variants
      • List Product Variants
      • Product Variant Details
      • Update Product Variant
      • Update Product Variant Quantity
    • Product Tags
      • Create Product Tag
      • List Product Tags
    • Product Images
      • Attach Image by SKU
      • Attach Video by SKU
      • Attach Youtube Video
      • Attach Image
      • Update Image
      • Delete Image
    • Product Option Values
      • Create Product Option Value
      • Product Option Value Details
      • Update Product Option Value
      • Delete Product Option Value
    • Abandoned Carts
      • List Abandoned Carts
      • Abandoned Cart Details
    • Customer Groups
      • Create Customer Group
      • List Customer Groups
      • Add Customers To Group Customer
      • Update Default Customer Group
      • Update Customer Group
      • Delete Customer Group
    • Customers
      • Create Customer
      • List Customers
      • Customer Details
      • Update Customer
      • Delete Customer
      • Ban Customer
      • Un-Ban customer
      • Import Customers
    • Digitals Product
      • Attach Digital Code
      • Attach Digital File
      • Delete Digital File
    • Categories
      • Create Category
      • List Categories
      • Category Details
      • Update Category
      • Delete Category
      • Category Children
      • Categories Search
      • List Category Products
    • Exports
      • Export Orders
      • Exports Logs
      • List Export Templates
      • Create Export Template
      • Update Export Template
      • Delete Export Template
      • List Export Columns
      • Export Customers
      • Export Custom URLs
      • Export Products
    • Shipments
      • Create Shipment
      • List Shipments
      • Shipment Details
      • Shipment Tracking
      • Update Shipment Details
      • Cancel Shipment
      • Return Shipment
    • Shipping Companies
      • List Shipping Companies
      • Shipping Company Details
      • List Estimate Rates
      • Create Shipping Company
      • Update Shipping Company
      • Delete Shipping Company
      • Shipping Company Options
    • Shipping Zones
      • Create Shipping Zone
      • List Shipping Zones
      • Shipping Zone Details
      • Update Shipping Zone
      • Delete Shipping Zone
    • Shipping Rules
      • List Shipping Rules
      • Shipping Rule Details
      • Delete Shipping Rule
    • Countries
      • List Countries
      • Country Details
    • Product Option Templates
      • List Option Templates
      • Option Template Details
      • Delete Option Template
      • Update Option Template
      • Create Option Template
    • Taxes
      • Create Tax
      • List Taxes
      • Tax Details
      • Update Tax
      • Delete Tax
    • Coupons
      • Create Coupon
      • List Coupons
      • Coupon Details
      • Update Coupon
      • Delete Coupon
      • List Coupon Codes
    • Affiliates
      • List Affiliates
      • Affiliate Details
      • Create Affiliate
      • Update Affiliate
      • Delete Affiliate
    • Order Assignment
      • List Auto Assignment Rules
      • Order Assigned Employees Details
      • Update Auto Assignment Rule
      • Create Auto Assignment Rules
    • Special Offers
      • Create Special Offer
      • List Special Offers
      • Special Offer Details
      • Update Special Offer
      • Delete Special Offer
      • Change Special Offer Status
    • Transactions
      • List Transactions
      • Transaction Details
      • Update Transaction
    • Payments
      • Available Payment Methods
      • List Banks
      • Payment Bank Details
    • Settlements
      • List Instant Settlements
      • Create Instant Settlement
      • Update Instant Settlement
      • Instant Settlement Details
    • Settings
      • Settings List
      • Update Setting Slug
      • Setting Details
    • Merchant
      • User Information Details
      • Store Information
    • Brands
      • Create Brand
      • List Brands
      • Brand Details
      • Update Brand
      • Delete Brand
    • Branches
      • Create Branch
        POST
      • List Branches
        GET
      • Branch Details
        GET
      • Update Branch
        PUT
      • Delete Branch
        DELETE
    • Currencies
      • Activate Currencies
      • List Currencies
      • List Available Currencies
    • SEO
      • List SEO Settings
      • Update SEO Settings
    • Cities
      • List Cities
    • DNS Records
      • List DNS Records
      • Create DNS Record
      • Delete DNS Record
    • Languages
      • Add Language
      • List Languages
      • Update Language
    • Employees
      • List Employees
    • Advertisements
      • Create Advertisement
      • List Advertisements
      • Advertisement Details
      • Update Advertisement
      • Delete Advertisement
    • Webhooks
      • List Active Webhooks
      • List Events
      • Register Webhook
      • Deactivate Webhook
      • Update Webhook
    • Custom URLs
      • Import Custom URLs
    • Loyalty Points
      • Customer Loyalty Points
      • Update Customer Loyalty Points
    • Reviews
      • List Reviews
      • Review Details
      • Update Review
  • Webhooks - Store Events
    • Order
    • Product
    • Customer
    • Shippings
    • Shipments
    • Brand
    • Invoice
    • Category
    • Store
    • Special Offer
    • Cart
    • Miscellaneous
  1. Branches

Update Branch

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
PUT
https://api.salla.dev/admin/v2
/branches/{branch}
Branches
Last modified:2025-04-21 14:18:53
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.
whatsapp
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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.
id
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-04-21 14:18:53
Previous
Branch Details
Next
Delete Branch