Create Branches Allocations

Production

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

POST

/branches/allocation

Last modified:2025-10-09 15:51:42

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

{
    "name": "Allocation Rout Name",
    "company_id": "665151403",
    "priority": 1,
    "rules": [
        {
            "type": "total_quantity",
            "operator": ">=",
            "value": "3"
        }
    ],
    "action": {
        "type": "branches",
        "strategy": "most_stock",
        "single_branch_only": true
    }
}

Request Code 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 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Allocation Rout Name",
    "company_id": "665151403",
    "priority": 1,
    "rules": [
        {
            "type": "total_quantity",
            "operator": ">=",
            "value": "3"
        }
    ],
    "action": {
        "type": "branches",
        "strategy": "most_stock",
        "single_branch_only": true
    }
}'

Responses

🟢200Success

application/json

Body

Examples

SuccessException

{
    "status": 201,
    "success": true,
    "data": {
        "id": 349994915,
        "name": "Allocation Rout Name",
        "company_id": 665151403,
        "priority": 1,
        "rules": [
            {
                "type": "total_quantity",
                "operator": ">=",
                "value": [
                    "3"
                ]
            }
        ],
        "action": {
            "type": "branches",
            "strategy": "most_stock",
            "branch_ids": [],
            "single_branch_only": true
        }
    }
}

🟠401Unauthorized

🟠403Forbidden

🟠422Validation Error

Modified at 2025-10-09 15:51:42

Branch Allocation Details

Update Branches Allocations