Flavours API
Banner

Create Banner

POST
/api/v2/banners

Create a new banner with the provided data.

Authorization

default
AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

title_en*string

English title of the banner.

title_ar?|

Arabic title of the banner.

description_en*string

English description of the banner.

description_ar?|

Arabic description of the banner.

cover_img?|

URL of the cover image. Must be a valid URL.

button_url?|

URL for the call-to-action button. Must be a valid URL.

button_label_en?|

English label for the button.

button_label_ar?|

Arabic label for the button.

features*array<>

List of features associated with the banner. Must have at least 1 items.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.flavours.sa/dev/api/v2/banners" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "title_en": "How to manage your inventory",    "description_en": "A comprehensive guide to tracking stock and suppliers.",    "features": [      {        "role": "USER_SUBSCRIBER",        "feature_key": "KITCHEN"      }    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Create Success"
  },
  "data": {
    "id": "c4b2e593-f3b8-4185-94df-7d0c6705bdb6",
    "title_en": "Labore est accusantium.",
    "title_ar": "Incidunt alias ex.",
    "description_en": "Cumque ut et et dolor hic. Consequatur voluptatum possimus dolorum commodi. Sit in laboriosam ut est rerum praesentium aperiam aliquam.",
    "description_ar": "Voluptatem eligendi quae in placeat deserunt necessitatibus. Dignissimos officia asperiores quia voluptas perspiciatis est cum. Omnis praesentium voluptatibus et consequuntur quod fuga laborum.",
    "cover_img": "https://via.placeholder.com/640x480.png/009922?text=nemo",
    "button_url": "http://schmeler.com/eos-molestiae-et-doloremque-fugiat-harum",
    "button_label_en": "Learn More",
    "button_label_ar": "اعرف المزيد",
    "created_at": 1787446682497,
    "updated_at": 1787446682497,
    "features": [
      {
        "id": "767b3fa4-1f72-4800-aa32-5490fcbfb293",
        "banner_id": "c4b2e593-f3b8-4185-94df-7d0c6705bdb6",
        "role": "USER_SUBSCRIBER",
        "feature_key": "DASHBOARD",
        "feature": {
          "key": "DASHBOARD",
          "name_en": "Dashboard",
          "name_ar": "لوحة التحكم",
          "description_en": "Overview of essential data points.",
          "description_ar": "نظرة عامة على النقاط البيانية الأساسية.",
          "roles": [
            "USER_ADMIN",
            "USER_MERCHANT",
            "USER_SUBSCRIBER"
          ]
        }
      },
      {
        "id": "6aeb998e-3c06-45ff-8945-11a68882483d",
        "banner_id": "c4b2e593-f3b8-4185-94df-7d0c6705bdb6",
        "role": "USER_SUBSCRIBER",
        "feature_key": "BRANCH",
        "feature": {
          "key": "BRANCH",
          "name_en": "Branches",
          "name_ar": "الفروع",
          "description_en": "Control and update branch information.",
          "description_ar": "التحكم وتحديث معلومات الفروع.",
          "roles": [
            "USER_SUBSCRIBER"
          ]
        }
      },
      {
        "id": "3993fe74-6466-4bfb-a882-a7d5b53fd6e9",
        "banner_id": "c4b2e593-f3b8-4185-94df-7d0c6705bdb6",
        "role": "USER_SUBSCRIBER",
        "feature_key": "CUSTOMER",
        "feature": {
          "key": "CUSTOMER",
          "name_en": "Customers",
          "name_ar": "العملاء",
          "description_en": "Manage and view customer details.",
          "description_ar": "إدارة وعرض تفاصيل العملاء.",
          "roles": [
            "USER_SUBSCRIBER"
          ]
        }
      }
    ]
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 422,
    "status": "error",
    "message": "The title en field is required. (and 4 more errors)"
  },
  "data": [
    {
      "code": 0,
      "message": "The title en field is required.",
      "field": "title_en"
    },
    {
      "code": 0,
      "message": "The description en field is required.",
      "field": "description_en"
    },
    {
      "code": 0,
      "message": "The cover img must be a valid URL.",
      "field": "cover_img"
    },
    {
      "code": 0,
      "message": "The button url must be a valid URL.",
      "field": "button_url"
    },
    {
      "code": 0,
      "message": "The features field is required.",
      "field": "features"
    }
  ]
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Attendance Stats — Settlements GET

Paginated on-demand breakdown of cross-shift settlements: payments collected during this attendance window for orders created before it started, grouped by payment method (enriched with method name/logo). full=true splits each method into SUCCESS/RETURN buckets; full=false collapses to one row per method. Paginated via page/per_page.

Delete Banner DELETE

Delete a specific banner by its ID.