Salla Docs
Create Special Offer
POST/specialoffersThis endpoint allows you to create a new special offer in the store.
Request
Other Offer Types
The title or label used to identify a specific promotional or discounted offer. 🌐 Support multi-language
A brief statement or communication that conveys the details or benefits of a specific promotional or discount offer. 🌐 Support multi-language
The specific platforms, channels, or methods through which a promotional or special offer is made available or applied.
The category or nature of a particular promotional or discount offer, such as buy-x get-y.
The specific products, services, or items to which a particular promotional or discount offer is intended or allowed to be used or applied, specifying what the offer covers within a product or service catalog.
The date on which a promotional or discount offer start, before which it is not permitted to take advantage of the offer's benefits.
Ensure to follow on the format of the date.
The date on which a promotional or discount offer expires or becomes no longer valid, after which it is not permitted to take advantage of the offer's benefits.
Ensure to follow on the format of the date.
The total minimum order amount to be purchased for this offer to be activated
The minimum order items count to activate this offer.
Specifics on items required for offer eligibility.
Specifics of the offer.
Discount Table Offer Type
The title or label used to identify a specific promotional or discounted offer. 🌐 Support multi-language
The specific platforms, channels, or methods through which a promotional or special offer is made available or applied.
The category or nature of a particular promotional or discount offer, such as buy-x get-y.
The specific products, services, or items to which a particular promotional or discount offer is intended or allowed to be used or applied, specifying what the offer covers within a product or service catalog.
The date on which a promotional or discount offer start, before which it is not permitted to take advantage of the offer's benefits.
Ensure to follow on the format of the date.
The date on which a promotional or discount offer expires or becomes no longer valid, after which it is not permitted to take advantage of the offer's benefits.
Ensure to follow on the format of the date.
Special Offer's status, either active or inactive
Whether or not the offer should be applied with a valid coupon
Tiered discount in the special offer. Required if offer_type is discounts_table
{
"name": "new offer",
"message": "Buy One Get One Free",
"applied_channel": "browser_and_application",
"offer_type": "buy_x_get_y",
"applied_to": "product",
"start_date": "2024-12-30",
"expiry_date": "2024-12-31",
"min_purchase_amount": 100,
"min_items_count": 2,
"min_items": 0,
"discounts_table": [
{
"quantity": 3,
"discount_amount": 5
},
{
"quantity": 5,
"discount_amount": 10
}
],
"buy": {
"type": "product",
"min_amount": 10,
"quantity": 1,
"products": [
401511871
]
},
"get": {
"type": "product",
"discount_type": "percentage",
"discount_amount": 5,
"quantity": 1,
"products": [
401511871
]
}
}Request samples
Responses
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.
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.
Detailed structure of the special offer model object showing its fields and data types.
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.
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
A brief statement or communication that conveys the details or benefits of a specific promotional or discount offer. 🌐 Support multi-language
Special offer end date is the date when a specific promotional or discount offer expires or ends
Special offer start date is the date when a specific promotional or discount offer begins or becomes active.
Special offer type refers to the category or classification that describes the nature or characteristics of a particular promotion, discount, or deal.
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.
The option to show the price after discount.
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.
Specifics on items required for offer eligibility.
Specifics of the offer.
{
"status": 200,
"success": true,
"data": {
"id": 1935541690,
"name": "new offer",
"message": "اشتري قطعة واحصل على قطعة واحدة خصم 5% من المنتجات التالية",
"start_date": "2024-12-08 16:00:00",
"expiry_date": "2025-12-10 16:00:00",
"offer_type": "buy_x_get_y",
"status": "inactive",
"show_price_after_discount": false,
"buy": {
"type": "product",
"quantity": 1,
"products": [
{
"id": 401511871,
"type": "food",
"promotion": {
"title": null,
"sub_title": null
},
"status": "sale",
"is_available": true,
"sku": "",
"name": "بيتزا",
"price": {
"amount": 40.25,
"currency": "SAR"
},
"sale_price": {
"amount": 0,
"currency": "SAR"
},
"currency": "SAR",
"url": "https://salla.sa/dev-wofftr4xsra5xtlv/بيتزا/p401511871",
"thumbnail": "https://cdn.salla.sa/bYQEn/hG0U3oATexBxt4j5QjMt8jcNUi12v97KFw9Q1xTA.jpg",
"has_special_price": false,
"regular_price": {
"amount": 40.25,
"currency": "SAR"
},
"calories": "500.00",
"mpn": null,
"gtin": null,
"favorite": null
}
]
},
"get": {
"type": "product",
"discount_type": "percentage",
"quantity": "1",
"products": []
}
}
}