Get list of coupon promotions

Get list of coupon promotionsServer-sideAdmin

get/v2/project/{project_id}/admin/coupon

Gets the list of coupon promotions of a project.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0

Responses

200

List of coupons was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

Response samples

application/json

{"items": [{"external_id": "coupon_44056_1",
"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2020-04-25T18:16:00+05:00",
"name": {"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"is_enabled": true,
"bonus": [{"sku": "elven_sword",
"quantity": 1
},
{"sku": "elven_shield",
"quantity": 2
},
{"sku": "elven_gloves",
"quantity": 2
}
],
"redeem_user_limit": null,
"redeem_total_limit": null,
"redeem_code_limit": 1,
"total_limit_state": null
},
{"external_id": "summer2021",
"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2020-04-25T18:16:00+05:00",
"name": {"en-US": "Coupon name",
"de-DE": "Gutscheintitel"
},
"is_enabled": true,
"bonus": [{"sku": "diamonds",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"total_limit_state": {"available": 50,
"reserved": 10,
"used": 40
}
}
],
"total_promotions_count": 2,
"active_promotions_count": 2,
"inactive_promotions_count": 0
}