Special Offer Details

Develop Env

https://echo.apifox.com/anything

GET

/specialoffers/{specialoffer}

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

Maintainer:Not configured

This endpoint allows you to return the complete details for a specific special offer by passing the specialoffer as a path parameter.

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 ********************

Path Params

specialoffer

integer

required

The Special Offer ID. List of Special Offers ID can be found here

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

object (SpecialOffer)

optional

Detailed structure of the special offer model object showing its fields and data types.

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.

Example

{
    "status": 200,
    "success": true,
    "data": {
        "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"
        }
    }
}

🟠404Not Found

🟠401Unauthorized

Modified at 2025-02-20 07:53:20

List Special Offers

Update Special Offer