List Branches Allocations

This endpoint allows you to fetch a list of allocated branches with their rules, showing which shipping companies are assigned based on branch location.

This endpoint is accessable only for allowed applications.

Scopes

branches.read- Branchs Read

Add the parameter

Authorization

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

Example:

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

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 246711701,
            "branch_id": 525010325,
            "rules": {
                "courier": {
                    "id": 989286562
                },
                "coverage": {
                    "enabled": true,
                    "method": "radius",
                    "radius_meters": 4000,
                    "coordinates": []
                }
            }
        },
        {
            "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
                        }
                    ]
                }
            }
        },
        {
            "id": 73130640,
            "branch_id": 525010325,
            "rules": {
                "courier": {
                    "id": 989286562
                },
                "coverage": {
                    "enabled": true,
                    "method": "radius",
                    "radius_meters": 100,
                    "coordinates": []
                }
            }
        },
        {
            "id": 525144736,
            "branch_id": 525010325,
            "rules": {
                "courier": {
                    "id": 1009048180
                },
                "coverage": {
                    "enabled": true,
                    "method": "radius",
                    "radius_meters": 10,
                    "coordinates": []
                }
            }
        }
    ],
    "pagination": {
        "count": 4,
        "total": 4,
        "perPage": 15,
        "currentPage": 1,
        "totalPages": 1,
        "links": []
    }
}

🟠403Forbidden

🟠422Validation Error

🟠401Unauthorized

List Branches Allocations

Request

Request samples

Responses