Light Mode

Create Special Offer

POST/specialoffers

Last modified: 2 months ago

This endpoint allows you to create a new special offer in the store.

`specialoffers.read_write`- Special Offers Read & Write

Request

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

No schema defined

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

Success(200)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

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

#/definitions/1307299

optional

{
  "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": []
    }
  }
}

Last modified: 2 months ago