List

Request Body

Constant

Use the constants below according to the field names and rules for each request

Constant	Value
`type`	`COUPON` `OFFER` `PROMOTION` `FAST_OFFER`

Info
PROMOTION and FAST_OFFER are under development

Coupon Flow

Sample Case :

Restaurant create a coupon for product A (10% off)

Customers get a coupon code provided by the restaurant

Customers buys product A according to the coupon

Customers get discount

Offers Flow

Sample Case :

Restaurant create an offer for product A for a week (10% off)

Customers buys product A according to the offer

CUstomers get discount

Validation

Field	Type	Rule	Description
`page`	`integer`	`nullable` `min:1`	Read more on the `Pagination` page
`per_page`	`integer`	`nullable` `min:1`	Read more on the `Pagination` page
`search`	`string`	`nullable`
`sort`	`string`	`nullable`	Read more on the `Sorting` page
`includes`	`array`	`nullable`	Read more on the `Includables` page
`filter.market_id`	`string`	`nullable`	Id from `Market` model
`filter.branch_id`	`string`	`nullable`	Id from `Branch` model
`filter.types`	`array`	`nullable`	Array of `type`
`filter.expired_at`	`integer`	`nullable`	Milliseconds time

The rules on the fields will change depending on conditions, including the following

Field	Rule	Condition
`filter.market_id`	`required`	User authentication role `SUBSCRIBER`
`filter.branch_id`	`required`	User authentication role `SUBSCRIBER` & has `branch_id`

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

page

integer

optional

Example:

per_page

integer

optional

Example:

string

optional

sort

string

optional

includes

array[string]

optional

Example:

[""]

filter[market_id]

string

optional

Example:

b5d70a92-5d2e-4f89-8e52-1827cfbd01f4

filter[branch_id]

string

optional

filter[types]

array[string]

optional

filter[expired_at]

integer

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

meta

object

required

code

integer

required

status

string

required

message

string

required

data

object

required

current_page

integer

required

data

array [object {15}]

required

first_page_url

string

required

from

integer

required

last_page

integer

required

last_page_url

string

required

links

array [object {3}]

required

next_page_url

string | null

optional

path

string

required

per_page

integer

required

prev_page_url

string | null

optional

integer

required

total

integer

required

Example

{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": "3e50cfeb-3c45-484a-8174-dcb010f092e1",
        "market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
        "branch_id": null,
        "type": "OFFER",
        "max": null,
        "code": null,
        "value": 20,
        "value_type": "PERCENT",
        "expired_at": 1720713600000,
        "created_at": 1720692585796,
        "updated_at": 1720692585796,
        "deleted_at": null,
        "target": "ORDER",
        "max_amount": null,
        "is_fast_offer": false
      },
      {
        "id": "df750d37-9925-4e00-9934-a7ca5fcb76a3",
        "market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
        "branch_id": null,
        "type": "COUPON",
        "max": null,
        "code": "m8",
        "value": 15,
        "value_type": "PERCENT",
        "expired_at": null,
        "created_at": 1713400666562,
        "updated_at": 1713400666562,
        "deleted_at": null,
        "target": "ORDER",
        "max_amount": null,
        "is_fast_offer": false
      },
      {
        "id": "42d1fe04-2e45-42f5-83d2-acb7087be9dd",
        "market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
        "branch_id": null,
        "type": "COUPON",
        "max": null,
        "code": "S24",
        "value": 10,
        "value_type": "PERCENT",
        "expired_at": 1713560400000,
        "created_at": 1713384568645,
        "updated_at": 1713384568645,
        "deleted_at": null,
        "target": "ORDER",
        "max_amount": null,
        "is_fast_offer": false
      }
    ],
    "first_page_url": "https://app.flavours.sa/api/v2/discounts?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.flavours.sa/api/v2/discounts?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://app.flavours.sa/api/v2/discounts?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "https://app.flavours.sa/api/v2/discounts",
    "per_page": 20,
    "prev_page_url": null,
    "to": 3,
    "total": 3
  }
}

Request Body#

Constant#

Coupon Flow#

Offers Flow#

Validation#

Request

Request samples

Responses

Request Body

Constant

Coupon Flow

Offers Flow

Validation