Create Branches Allocations

Production

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

POST

/branches/allocation

Last modified:2025-07-20 13:59:16

This endpoint allows you to define allocation rules for a branch, including assigning couriers and setting coverage areas.

This endpoint is accessable only for allowed applications.

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

Body Params application/json

Example

{
  "branch_id": 525010325,
  "rules": {
    "courier": {
      "id": 989286562
    },
    "coverage": {
      "enabled": true,
      "method": "polygon",
      "radius_meters": null,
      "coordinates": [
        {
          "lat": 24.919427692528,
          "lng": 46.7360729
        },
        {
          "lat": 24.840317240711,
          "lng": 46.138643243018
        },
        {
          "lat": 24.506501651095,
          "lng": 46.168807580176
        },
        {
          "lat": 24.407746339329,
          "lng": 46.55411184043
        },
        {
          "lat": 24.608925155159,
          "lng": 46.763634850684
        },
        {
          "lat": 24.766767432571,
          "lng": 47.065710808936
        },
        {
          "lat": 24.919427692528,
          "lng": 46.7360729
        }
      ]
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.salla.dev/admin/v2/branches/allocation' \
--header 'Content-Type: application/json' \
--data-raw '{
  "branch_id": 525010325,
  "rules": {
    "courier": {
      "id": 989286562
    },
    "coverage": {
      "enabled": true,
      "method": "polygon",
      "radius_meters": null,
      "coordinates": [
        {
          "lat": 24.919427692528,
          "lng": 46.7360729
        },
        {
          "lat": 24.840317240711,
          "lng": 46.138643243018
        },
        {
          "lat": 24.506501651095,
          "lng": 46.168807580176
        },
        {
          "lat": 24.407746339329,
          "lng": 46.55411184043
        },
        {
          "lat": 24.608925155159,
          "lng": 46.763634850684
        },
        {
          "lat": 24.766767432571,
          "lng": 47.065710808936
        },
        {
          "lat": 24.919427692528,
          "lng": 46.7360729
        }
      ]
    }
  }
}'

Responses

🟢200Success

application/json

Body

Examples

SuccessSuccessException

{
    "status": 201,
    "success": true,
    "data": {
        "id": 712950679,
        "branch_id": 525010325,
        "rules": {
            "courier": {
                "id": 989286562
            },
            "coverage": {
                "enabled": true,
                "method": "polygon",
                "radius_meters": null,
                "coordinates": [
                    {
                        "lat": 24.919427692528,
                        "lng": 46.7360729
                    },
                    {
                        "lat": 24.840317240711,
                        "lng": 46.138643243018
                    },
                    {
                        "lat": 24.506501651095,
                        "lng": 46.168807580176
                    },
                    {
                        "lat": 24.407746339329,
                        "lng": 46.55411184043
                    },
                    {
                        "lat": 24.608925155159,
                        "lng": 46.763634850684
                    },
                    {
                        "lat": 24.766767432571,
                        "lng": 47.065710808936
                    },
                    {
                        "lat": 24.919427692528,
                        "lng": 46.7360729
                    }
                ]
            }
        }
    }
}

🟠403Forbidden

🟠422Validation Error

🟠401Unauthorized

Modified at 2025-07-20 13:59:16

Branch Allocation Details

Update Branches Allocations