Update Branch - Salla Merchant API

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

Scopes

branches.read_write- Branchs Read & Write

Request

Path Params

Body Params application/json

Example

{
    "name": "فرع الرئيسي ",
    "additional_number": "2356",
    "address_description": "7124 طريق الأمير سلطان بن عبدالعزيز، العليا، الرياض 12211، السعودية",
    "building_number": "1245",
    "branch_code": "BR-6789",
    "city_id": 566146469,
    "country_id": 1473353380,
    "region_id": 566146469,
    "district_id": 238193309,
    "postal_code": "23341",
    "street": "الرياضه",
    "type": "branch",
    "shippable": true,
    "pickable": true,
    "pos": true,
    "external_reference": "ASD123",
    "location": "24.6888248, 46.68632700000001",
    "users": [
        1615959792
    ],
    "short_address": "FGJU8765",
    "local": "الزمرد",
    "preparation_time": "30 دقيقة",
    "cod_cost": 20,
    "always_open": false,
    "order_while_closed": true,
    "preparation_time_range": {
        "from": {
            "value": 2,
            "unit": "minute"
        },
        "to": {
            "value": 15,
            "unit": "minute"
        }
    },
    "safety_stock": 10,
    "working_hours": {
        "saturday": {
            "enabled": "on",
            "from": [
                "07:00"
            ],
            "to": [
                "18:00"
            ]
        },
        "sunday": {
            "enabled": "on",
            "from": [
                "07:00"
            ],
            "to": [
                "18:00"
            ]
        },
        "monday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "tuesday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "wednesday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "thursday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "friday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        }
    },
    "is_cod_available": false,
    "contacts": {
        "phone": "+966555555555",
        "telephone": "+966555555555",
        "whatsapp": "+966555555555",
        "phone_country_code": "SA",
        "whatsapp_country_code": "SA"
    },
    "translations": {
        "ar": {
            "name": "فرع الرئيسي ",
            "address_description": "7124 طريق الأمير سلطان بن عبدالعزيز، العليا، الرياض 12211، السعودية",
            "street": "الرياضه"
        }
    }
}

Request Code 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": "فرع الرئيسي ",
    "additional_number": "2356",
    "address_description": "7124 طريق الأمير سلطان بن عبدالعزيز، العليا، الرياض 12211، السعودية",
    "building_number": "1245",
    "branch_code": "BR-6789",
    "city_id": 566146469,
    "country_id": 1473353380,
    "region_id": 566146469,
    "district_id": 238193309,
    "postal_code": "23341",
    "street": "الرياضه",
    "type": "branch",
    "shippable": true,
    "pickable": true,
    "pos": true,
    "external_reference": "ASD123",
    "location": "24.6888248, 46.68632700000001",
    "users": [
        1615959792
    ],
    "short_address": "FGJU8765",
    "local": "الزمرد",
    "preparation_time": "30 دقيقة",
    "cod_cost": 20,
    "always_open": false,
    "order_while_closed": true,
    "preparation_time_range": {
        "from": {
            "value": 2,
            "unit": "minute"
        },
        "to": {
            "value": 15,
            "unit": "minute"
        }
    },
    "safety_stock": 10,
    "working_hours": {
        "saturday": {
            "enabled": "on",
            "from": [
                "07:00"
            ],
            "to": [
                "18:00"
            ]
        },
        "sunday": {
            "enabled": "on",
            "from": [
                "07:00"
            ],
            "to": [
                "18:00"
            ]
        },
        "monday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "tuesday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "wednesday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "thursday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        },
        "friday": {
            "enabled": "on",
            "from": [
                "00:00"
            ],
            "to": [
                "23:00"
            ]
        }
    },
    "is_cod_available": false,
    "contacts": {
        "phone": "+966555555555",
        "telephone": "+966555555555",
        "whatsapp": "+966555555555",
        "phone_country_code": "SA",
        "whatsapp_country_code": "SA"
    },
    "translations": {
        "ar": {
            "name": "فرع الرئيسي ",
            "address_description": "7124 طريق الأمير سلطان بن عبدالعزيز، العليا، الرياض 12211، السعودية",
            "street": "الرياضه"
        }
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 999858679,
        "name": "فرع الرئيسي - الرياض",
        "status": "active",
        "is_default": true,
        "location": {
            "lat": "24.6888248",
            "lng": " 46.68632700000001"
        },
        "short_address": "JCMA3429",
        "street": "الرياضه",
        "address_description": "7124 طريق الأمير سلطان بن عبدالعزيز، العليا، الرياض 12211، السعودية",
        "additional_number": "6558",
        "fulfillment_center": {
            "id": 1473353380,
            "external_reference": "ASD123"
        },
        "building_number": "3429",
        "local": "العمل",
        "postal_code": "23341",
        "contacts": {
            "phone": "+966555555555",
            "telephone": "+966555555555",
            "whatsapp": "+966555555555"
        },
        "preparation_time": "30 دقيقة",
        "is_open": true,
        "closest_time": null,
        "users": [
            {
                "id": 1615959792,
                "name": "test user"
            }
        ],
        "working_hours": [
            {
                "name": "السبت",
                "times": [
                    {
                        "from": "07:00",
                        "to": "18:00"
                    }
                ]
            },
            {
                "name": "الأحد",
                "times": [
                    {
                        "from": "07:00",
                        "to": "18:00"
                    }
                ]
            },
            {
                "name": "الإثنين",
                "times": [
                    {
                        "from": "00:00",
                        "to": "23:00"
                    }
                ]
            },
            {
                "name": "الثلاثاء",
                "times": [
                    {
                        "from": "00:00",
                        "to": "23:00"
                    }
                ]
            },
            {
                "name": "الأربعاء",
                "times": [
                    {
                        "from": "00:00",
                        "to": "23:00"
                    }
                ]
            },
            {
                "name": "الخميس",
                "times": [
                    {
                        "from": "00:00",
                        "to": "23:00"
                    }
                ]
            },
            {
                "name": "الجمعة",
                "times": [
                    {
                        "from": "00:00",
                        "to": "23:00"
                    }
                ]
            }
        ],
        "is_cod_available": true,
        "is_stock": true,
        "type": "branch",
        "cod_cost": 20,
        "branch_code": "BR-6789",
        "region": {
            "id": 1473353380,
            "name": "منطقة الرياض",
            "code": "RD"
        },
        "pickable": true,
        "shippable": true,
        "pos": true,
        "has_delivery_zone": false,
        "always_open": false,
        "order_while_closed": true,
        "safety_stock": 10,
        "preparation_time_range": {
            "from": {
                "value": 2,
                "unit": "minute"
            },
            "to": {
                "value": 15,
                "unit": "minute"
            }
        },
        "country": {
            "id": 1473353380,
            "name": "السعودية",
            "name_en": "Saudi Arabia",
            "code": "SA",
            "mobile_code": "+966",
            "capital": null
        },
        "city": {
            "id": 1473353380,
            "name": "الرياض",
            "name_en": "Riyadh",
            "country_id": 1473353380
        },
        "district": {
            "id": 1473353380,
            "name": "العمل",
            "name_en": "Al Amal"
        }
    }
}

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized