Light Mode

List Advertisements

GET/advertisements

Last modified: 2 months ago

This endpoint allows you to list all of the advertisement posts of the store.

`marketing.read`- Marketing Read Only

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

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

$ref(#/definitions/1387912)[]

optional

#/definitions/1387912

optional

pagination

#/definitions/1307303

optional

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 2142305900,
      "title": "تخفيضات على جميع التيشيرتات",
      "description": "أعلان لتصنيف التيشيرت",
      "type": {
        "id": 1032561074,
        "name": "category",
        "link": "https://offerLink"
      },
      "style": {
        "icon": "sicon-braille-hand",
        "font_color": "#ffffff",
        "background_color": "#9d8383"
      },
      "expire_date": {
        "date": "2022-01-21 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "pages": [
        "all"
      ]
    },
    {
      "id": 235400060,
      "title": "جميع المنتجات ستتوفر مرة أخرى بعد العيد",
      "description": "توفر المنتجات",
      "type": {
        "id": 132432,
        "name": "without_url",
        "link": "https://offerLink"
      },
      "style": {
        "icon": "sicon-bell",
        "font_color": "#ffffff",
        "background_color": "#9d8383"
      },
      "expire_date": {
        "date": "2022-12-12 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "pages": [
        "cart",
        "product"
      ]
    }
  ],
  "pagination": {
    "count": 5,
    "total": 5,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

Last modified: 2 months ago