List Special Offers

This endpoint allows you to list all special offers related to the store.

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

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (SpecialOffer) {11}]

optional

number

required

A unique identifier associated with a particular promotional or discount offe.

name

string

required

A descriptive label or title given to a specific promotional offer to distinguish it from others. 🌐 Support multi-language

message

string

required

A brief statement or communication that conveys the details or benefits of a specific promotional or discount offer. 🌐 Support multi-language

expiry_date

string

required

The date when a specific promotional or discount offer expires or ends.

Example:

2025-01-01

start_date

string

required

Special offer start date is the date when a specific promotional or discount offer begins or becomes active.

offer_type

enum<string>

required

The category or classification that describes a particular promotion, discount, or deal.

Allowed values:

buy_x_get_yfixed_amountpercentagediscounts_table

status

string

required

The current condition of a specific discount offer, such as whether it is active, expired, or in a pending or inactive status.

show_price_after_discount

boolean

required

The option to show the price after discount.

show_discounts_table_message

boolean

required

Whether or not to show information presented in a table format that displays various discounts.

buy

object

required

Specifics on items required for offer eligibility.

get

object

required

Specifics of the offer.

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 613755483,
            "name": "new free",
            "message": "اشتري one piece واحصل على specialoffer::special_offers.messages.get-discount- من المنتجات التالية",
            "expiry_date": null,
            "start_date": null,
            "offer_type": "",
            "status": "active",
            "show_price_after_discount": null,
            "show_discounts_table_message": false,
            "applied_to": null,
            "buy": {
                "min_amount": 0,
                "min_items": 0
            },
            "get": {
                "discount_amount": null
            }
        },
        {
            "id": 400525076,
            "name": "new offer",
            "message": "First Offer Congratulations {offer_get_qty} {offer_percent} Try our new offer {offer_buy_qty} and apply the following code: AZ https://shalfa.net/m/?",
            "expiry_date": "2024-09-01 01:00:00",
            "start_date": "2024-08-25 16:00:00",
            "offer_type": "fixed_amount",
            "status": "active",
            "show_price_after_discount": false,
            "show_discounts_table_message": false,
            "applied_to": "category",
            "buy": {
                "min_amount": 0,
                "min_items": 1,
                "categories": [
                    {
                        "id": 283675303,
                        "name": "ماركة بيوديرما",
                        "avatar": "",
                        "created_at": "2022-03-07T11:57:13.000000Z",
                        "updated_at": "2022-04-19T11:25:45.000000Z",
                        "deleted_at": null,
                        "store_id": 4934,
                        "parent_id": 2062595,
                        "products_counts": 0,
                        "show_in_menu": 1,
                        "sort_order": 1,
                        "status": "active",
                        "has_hidden_products": 0,
                        "show_in_app": 1,
                        "extra_attributes": [],
                        "custom_url": null,
                        "mahly_category_id": null,
                        "images": null
                    }
                ]
            },
            "get": {
                "discount_amount": "1.00"
            }
        },
        {
            "id": 1259945644,
            "name": "test",
            "message": "اشتري  -4 pieces واحصل على خصم 1900 SAR من التصنيفات التالية",
            "expiry_date": "2025-05-08 00:00:00",
            "start_date": null,
            "offer_type": "fixed_amount",
            "status": "inactive",
            "show_price_after_discount": null,
            "show_discounts_table_message": false,
            "applied_to": "category",
            "buy": {
                "min_amount": 0,
                "min_items": -4,
                "categories": [
                    {
                        "id": 1794053675,
                        "name": "Dress",
                        "avatar": "",
                        "created_at": "2021-09-19T08:17:57.000000Z",
                        "updated_at": "2023-12-30T11:41:48.000000Z",
                        "deleted_at": null,
                        "store_id": 4934,
                        "parent_id": 677747738,
                        "products_counts": 15,
                        "show_in_menu": 0,
                        "sort_order": 5,
                        "status": "active",
                        "has_hidden_products": 0,
                        "show_in_app": 1,
                        "extra_attributes": {
                            "metadata": {
                                "title": "حلو",
                                "description": "حلو و جميل ههاي ههاي"
                            }
                        },
                        "custom_url": "order",
                        "mahly_category_id": null,
                        "images": "https://cdn.salla.sa/jKxK/t5kk3PVtwdw3xdYP7XHkaoWQ4punxq3mL1lJ3GvS.jpg"
                    }
                ]
            },
            "get": {
                "discount_amount": "1900.00"
            }
        },
        {
            "id": 619077037,
            "name": "test 2",
            "message": "اشتري one piece واحصل على خصم 2 SAR من التصنيفات التالية",
            "expiry_date": "2022-08-24 17:45:00",
            "start_date": null,
            "offer_type": "fixed_amount",
            "status": "inactive",
            "show_price_after_discount": null,
            "show_discounts_table_message": false,
            "applied_to": "category",
            "buy": {
                "min_amount": 0,
                "min_items": 1,
                "categories": [
                    {
                        "id": 759876799,
                        "name": "Others",
                        "avatar": "",
                        "created_at": "2021-07-

🟠401Unauthorized

Request

Request samples

Responses