Create Special Offer - Salla Merchants APIs

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Body Params application/json

allOf {2}

optional

object

optional

Other Offer Types

name

string

required

The title or label used to identify a specific promotional or discounted offer. 🌐 Support multi-language

message

string

optional

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

applied_channel

enum<string>

required

The specific platforms, channels, or methods through which a promotional or special offer is made available or applied.

Allowed values:

browserbrowser_and_application

offer_type

enum<string>

required

The category or nature of a particular promotional or discount offer, such as buy-x get-y.

Allowed values:

buy_x_get_ypercentagefixed_amountdiscounts_table

applied_to

enum<string>

required

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.

Allowed values:

orderproductcategorypaymentMethod

start_date

string <date-time>

optional

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.

expiry_date

string <date-time>

optional

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.

min_purchase_amount

number

optional

The total minimum order amount to be purchased for this offer to be activated

min_items_count

number

optional

The minimum order items count to activate this offer.

buy

object

optional

Specifics on items required for offer eligibility.

get

object

optional

Specifics of the offer.

object

optional

Discount Table Offer Type

name

string

required

The title or label used to identify a specific promotional or discounted offer. 🌐 Support multi-language

applied_channel

enum<string>

required

The specific platforms, channels, or methods through which a promotional or special offer is made available or applied.

Allowed values:

browserbrowser_and_application

offer_type

enum<string>

required

The category or nature of a particular promotional or discount offer, such as buy-x get-y.

Allowed value:

discounts_table

applied_to

enum<string>

required

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.

Allowed values:

orderproductcategory

start_date

string <date-time>

optional

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.

expiry_date

string <date-time>

required

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.

status

enum<string>

optional

Special Offer's status, either active or inactive

Allowed values:

activeinactive

applied_with_coupon

boolean

optional

Whether or not the offer should be applied with a valid coupon

buy

object

optional

discounts_table

array [object {2}]

optional

Tiered discount in the special offer. Required if offer_type is discounts_table

Example

{
  "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

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.salla.dev/admin/v2/specialoffers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
        ]
    }
}'

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.

id

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.

Examples

Example Example | `offer_type = buy_x_get_y`Example | `offer_type = fixed_amount`Example | `offer_type = percentage`offer_type = discounts_table

{
  "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": "Eid Alfitr Offer",
            "sub_title": "Special Promotion"
          },
          "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": "677156713",
          "gtin": "76893972",
          "favorite": "Product is Favourit"
        }
      ]
    },
    "get": {
      "type": "product",
      "discount_type": "percentage",
      "quantity": "1",
      "products": []
    }
  }
}

🟠401Unauthorized