API: List promotion codes

listPromoCodes

A list of available promotion codes

TIP

This API call uses pagination for results.

Optional parameters

Parameter	Description
page	Which page to return (default:0)
include_batch	When set to 1 results will also include coupons related to batches, which are not listed by default

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=listPromoCodes

PHP Samples

Response

{
    "success": true,
    "coupons": [
        {
            "id": "9",
            "code": "MN634HMI7L6B",
            "status": "Active",
            "coupon_type": "cart",
            "type": "percent",
            "value": "11.000",
            "num_usage": "0",
            "notes": ""
        },
        {
            "id": "3",
            "code": "6TO0CDNM1",
            "status": "Active",
            "coupon_type": "cart",
            "type": "percent",
            "value": "3.000",
            "num_usage": "0",
            "notes": ""
        },
        {
            "id": "1",
            "code": "MN634HMI7L6B",
            "status": "Active",
            "coupon_type": "cart",
            "type": "percent",
            "value": "11.000",
            "num_usage": "0",
            "notes": ""
        }
    ],
    "call": "listPromoCodes",
    "sorter": {
        "perpage": 25,
        "totalpages": 1,
        "sorterrecords": "3",
        "sorterpage": 1
    },
    "server_time": 1611584941
}