Promotion

The Promotion feature provides information on available promotions. This feature is solely for displaying promotional offers and is not related to the processes of earning or redemption of rewards.

It is intended to give users visibility into current promotions without involving any transactional or loyalty functions.

Ensure that you are using the correct API URL to access the Promotion data.

Get All Promotions

GET/promotion

Available of the promotion in the selected client.

Headers

Name	Value
Accept	application/json

Params

Name	Type	Description
client_code	string	client identifier
page	string	page of the data
limit	string	limit of the data
status	string	status of the promotion. Default : all. all / past / running

Response

200

{
    "status_code": 200,
    "status": "success",
    "paginator": {
        "current_page": 1,
        "per_page": 10,
        "previous_page": 0,
        "next_page": 0,
        "total_items": 1,
        "total_pages": 1
    },
    "data": [
        {
            "id": 88,
            "period": {
                "start": "2024-10-01",
                "end": "2024-10-31"
            },
            "name": "Default Promotion",
            "description": "Trial<br>",
            "active": true,
            "photos": [],
            "videos": [],
            "payment": {
                "id": 433,
                "code": "001",
                "name": "Cash",
                "bank": null
            },
            "store": {
                "id": 3016,
                "code": "001",
                "name": "Default Tenant",
                "name_with_client": "Paint Pro - Default Tenant",
                "contact_name": null,
                "contact_email": null,
                "contact_phone": null,
                "note": "",
                "unit": null,
                "floor": "",
                "longitude": 0,
                "latitude": 0,
                "altitude": 0,
                "image": null,
                "active": 1
            },
            "promotion_category": {
                "id": 14,
                "code": "001",
                "name": "Default Category"
            }
        }
    ]
}

422