本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

List Special Offers

Develop Env

https://echo.apifox.com/anything

GET

/specialoffers

Special Offers

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

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

Scopes

specialoffers.read- Special Offers Read Only

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Query Params

per_page

integer

optional

Products limit per page

page

integer

optional

The Pagination page number

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Special offer ID is a unique identifier associated with a particular promotional or discount offer, allowing for tracking and management of the offer within a system or database.

name

string

required

Special offer name is a descriptive label or title given to a specific promotional offer to distinguish it from others and make it easily recognizable to customers and within an organization's marketing or sales materials. 🌐 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

Special offer end date is 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

Special offer type refers to the category or classification that describes the nature or characteristics of a particular promotion, discount, or deal.

Allowed values:

buy_x_get_yfixed_amountpercentagediscounts_table

status

string

required

Special Offer Status indicates the current condition or state of a specific promotional or 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

The option to refers to show a message or information presented in a table format that displays various discounts, prices, or pricing tiers for different products, services, or items. This message may include details about discounts based on quantities purchased, membership levels, or other criteria.

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": 1000479948,
            "name": "اشتري 1 واحصل على الاخر مجانا",
            "message": "اشتري قطعة واحصل على قطعة واحدة مجاناً من التصنيفات التالية",
            "expiry_date": null,
            "start_date": null,
            "offer_type": "buy_x_get_y",
            "status": "active",
            "show_price_after_discount": null,
            "show_discounts_table_message": false,
            "buy": {
                "type": "category",
                "quantity": 1,
                "categories": [
                    {
                        "id": 1032561074,
                        "name": "الفساتين",
                        "urls": {
                            "customer": "https://salla.sa/dev-wofftr4xsra5xtlv/الفساتين/c1032561074",
                            "admin": "https://s.salla.sa/categories"
                        },
                        "items": [],
                        "parent_id": 0,
                        "status": "active",
                        "sort_order": 1,
                        "update_at": {
                            "date": "2022-04-25 19:46:26.000000",
                            "timezone_type": 3,
                            "timezone": "Asia/Riyadh"
                        }
                    }
                ]
            },
            "get": {
                "type": "category",
                "discount_type": "free-product",
                "categories": [
                    {
                        "id": 1548055,
                        "name": "الفساتين",
                        "avatar": "sicon-store2",
                        "created_at": "2021-11-01T13:46:06.000000Z",
                        "updated_at": "2022-04-25T16:46:26.000000Z",
                        "deleted_at": null,
                        "store_id": 577778,
                        "parent_id": 0,
                        "products_counts": 4,
                        "show_in_menu": 0,
                        "sort_order": 1,
                        "status": "active",
                        "has_hidden_products": 0,
                        "show_in_app": 1,
                        "extra_attributes": [],
                        "custom_url": null
                    }
                ],
                "discount_amount": "0.00"
            }
        },
        {
            "id": 1799075371,
            "name": "new offer",
            "message": "اشتري قطعة واحصل على خصم 5 ر.س من المنتجات التالية",
            "expiry_date": "2024-02-14 15:20:00",
            "start_date": null,
            "offer_type": "fixed_amount",
            "status": "active",
            "show_price_after_discount": null,
            "show_discounts_table_message": false,
            "applied_to": "product",
            "buy": {
                "min_amount": 10,
                "min_items": 0,
                "products": []
            },
            "get": {
                "discount_amount": "5.00"
            }
        },
        {
            "id": 1410023903,
            "name": "نسبة من المشتريات",
            "message": "احصل على خصم  {offer_percent}",
            "expiry_date": "2022-06-26 20:45:00",
            "start_date": "2022-06-21 09:50:00",
            "offer_type": "percentage",
            "status": "active",
            "show_price_after_discount": false,
            "show_discounts_table_message": false,
            "applied_to": "order",
            "buy": {
                "min_amount": 200,
                "min_items": 0
            },
            "get": {
                "discount_amount": "10.00"
            }
        }
    ],
    "pagination": {
        "count": 3,
        "total": 3,
        "perPage": 30,
        "currentPage": 1,
        "totalPages": 1,
        "links": []
    }
}

🟠401Unauthorized

Create Special Offer

Special Offer Details