[lightMode]

List Advertisements

GET/advertisements

[updatedIn] 2 months ago

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

`marketing.read`- Marketing Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request samples

[api.label.responses]

Success(200)

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

array[object (Advertisement) {7}]

optional

number

required

Advertisement ID

title

string

required

Advertisement Title

description

string

required

Advertisement Description. 🌐 Support multi-language

type

object

required

style

object

required

expire_date

object

required

pages

array[string]

required

Which pages should the advertisement appear on

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 2142305900,
      "title": "تخفيضات على جميع التيشيرتات",
      "description": "أعلان لتصنيف التيشيرت",
      "type": {
        "id": 1032561074,
        "name": "category",
        "link": null
      },
      "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": null,
        "name": "without_url",
        "link": null
      },
      "style": {
        "icon": "sicon-bell",
        "font_color": null,
        "background_color": null
      },
      "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": []
  }
}

[updatedIn] 2 months ago