Get Offer Priorities

This endpoint allows you to list the offer application limit and the priority of every active special offer in the store.

Single-market stores receive a flat offers list, a top-level offers_limit, and an empty scopes array. Multi-market stores receive one entry per active market under scopes, each carrying its own offers_limit and ordered offers, and no top-level offers key. Read is_multi_scope to tell the two shapes apart.

is_sorted returns true only when every offer in that list already has a priority assigned.

Scopes

specialoffers.read- Special Offers Read Only

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

Examples

Multi MarketSingle Market

{
    "status": 200,
    "success": true,
    "data": {
        "scopes": [
            {
                "id": 695025737,
                "name": "سوق السعودية",
                "offers_limit": 5,
                "is_sorted": true,
                "offers": [
                    {
                        "id": 872134082,
                        "name": "buy 1 get 1 testing",
                        "priority": 1,
                        "offer_type": "buy_x_get_y"
                    },
                    {
                        "id": 1574866112,
                        "name": "خصم ١٠٠٪",
                        "priority": 2,
                        "offer_type": "percentage"
                    }
                ]
            },
            {
                "id": 2068475722,
                "name": "سوق الامارات",
                "offers_limit": 1,
                "is_sorted": false,
                "offers": [
                    {
                        "id": 1574866112,
                        "name": "خصم ١٠٠٪",
                        "priority": 1,
                        "offer_type": "percentage"
                    },
                    {
                        "id": 872134082,
                        "name": "buy 1 get 1 testing",
                        "priority": 2,
                        "offer_type": "buy_x_get_y"
                    }
                ]
            }
        ],
        "is_multi_scope": true
    }
}

🟠403Forbidden

🟠401Unauthorized

Request

Request Code Samples

Responses