List Advertisements
GET
/advertisementsThis endpoint allows you to list all of the advertisement posts of the store.
Request
Request samples
Responses
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.
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.
Advertisement ID
Advertisement Title
Advertisement Description. 🌐 Support multi-language
Which pages should the advertisement appear on
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.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
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": []
}
}