Routes List

This endpoint allows you to fetch all shipping routes configured for the store.
Each route includes its type (e.g., normal, auto, branded, default), status, priority, and combination strategy.
These routes control how shipping options appear to customers at checkout.

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

Bodyapplication/json

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 2087831307,
            "name": "Branded Route",
            "type": "branded",
            "status": true,
            "priority": 1,
            "strategy": "default",
            "combinable": true
        },
        {
            "id": 580171786,
            "name": "Selected Route",
            "type": "default",
            "status": true,
            "priority": 2,
            "strategy": "ratio",
            "combinable": false
        },
        {
            "id": 298476048,
            "name": "Auto assign route",
            "type": "auto",
            "status": true,
            "priority": 3,
            "strategy": "quota",
            "combinable": false
        }
    ],
    "pagination": {
        "count": 3,
        "total": 3,
        "perPage": 15,
        "currentPage": 1,
        "totalPages": 1,
        "links": {}
    }
}

🟠401Unauthorized

🟠404Record Not Found

Request

Request Code Samples

Responses