Route Details

This endpoint allows you to fetch detailed information about a specific shipping route, including

type

priority

branded configuration

assigned companies

shipping conditions

selection strategy, and

when or where it applies.

This helps you understand how the route behaves at checkout and under which criteria it becomes active.

This endpoint is accessable only for allowed applications.

Scopes

shipping.read- Shipping 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": 1670414609,
        "name": "Testing Route 1",
        "priority": 1,
        "status": true,
        "type": "branded",
        "branded": {
            "name": "Salla Delivery",
            "logo_url": "https://example.com/logos/salla.png",
            "description": "Fast delivery for premium customers",
            "combinable": true,
            "pricing": {
                "type": "rate",
                "cost": 30,
                "amount_per_unit": 2,
                "up_to_weight": 15,
                "per_unit": 1
            }
        },
        "companies": [
            {
                "id": 989286562,
                "priority": 1,
                "capacity": 80
            },
            {
                "id": 1723506348,
                "priority": 2,
                "capacity": 10
            },
            {
                "id": 665151403,
                "priority": 3,
                "capacity": 10
            }
        ],
        "condition_match": "all",
        "conditions": [
            {
                "type": "cart_total",
                "operator": "between",
                "value": {
                    "max": 500,
                    "min": 200
                }
            },
            {
                "type": "cart_weight",
                "operator": "==",
                "value": 3
            },
            {
                "type": "cart_quantity",
                "operator": ">=",
                "value": 5
            },
            {
                "type": "categories",
                "operator": "in",
                "value": [
                    {
                        "id": 1975114919,
                        "name": "Perfume"
                    }
                ]
            },
            {
                "type": "areas",
                "operator": "in",
                "value": [
                    {
                        "type": "allowed",
                        "areas": [
                            {
                                "country_id": {
                                    "id": 1473353380,
                                    "name": "السعودية"
                                },
                                "cities": [
                                    {
                                        "id": 1473353380,
                                        "name": "الرياض"
                                    },
                                    {
                                        "id": 1939592358,
                                        "name": "مكة"
                                    },
                                    {
                                        "id": 349994915,
                                        "name": "خميس مشيط"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "type": "excluded",
                        "areas": [
                            {
                                "country_id": {
                                    "id": 566146469,
                                    "name": "الامارات"
                                },
                                "cities": [
                                    {
                                        "id": 2097610897,
                                        "name": "أبو ظبي"
                                    }
                                ]
                            },
                            {
                                "country_id": {
                                    "id": 1298199463,
                                    "name": "قطر"
                                },
                                "cities": [
                                    {
                                        "id": 1008553809,
                                        "name": "الخور"
                                    },
                                    {
                                        "id": 900574300,
                                        "name": "الدوحة"
                                    },
                                    {
                                        "id": 167407186,
                                        "name": "الشمال"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            {
                "type": "customer_groups",
                "operator": "in",
                "value": [
                    {
                        "id": 1237892238,
                        "name": "VIP"
                    }
                ]
            },
            {
                "type": "schedule",
                "operator": "within_range",
                "value": {
                    "days": [
                        "Sunday"
                    ],
                    "time_to": "09:00",
                    "time_from": "14:30"
                }
            },
            {
                "type": "branches",
                "operator": "in",
                "value": [
                    {
                        "id": 1937885067,
                        "name": "Main Branch"
                    },
                    {
                        "id": 1299113620,
                        "name": "Jeddah Branch"
                    }
                ]
            },
            {
                "type": "branch_count",
                "operator": ">=",
                "value": "23"
            },
            {
                "type": "specific_products_quantity",
                "operator": "in",
                "value": {
                    "quantity": 12,
                    "products": [
                        {
                            "id": 1784895147,
                            "name": "Product",
                            "thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/RAQjo5g7fpME4drSj8HD9BLTdnwkGNTdcHyJszRj.jpg"
                        }
                    ]
                }
            }
        ],
        "strategy": {
            "type": "ratio",
            "capacity_level": "route",
            "alternative_companies": []
        }
    }
}

🟠404Not Found

🟠401Unauthorized

Request

Request samples

Responses