get
https://api.accelevents.com/rest/host/ticketing//couponCodes
This API is used to get all discount codes for ticketing associated with the specified event.
API is used as host side event admin and super admin can access this API.
To call this API, user will have to pass query param with API URL like recurringEventId and authentication key to authenticate user.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Here is the description of response attributes, which returns to the form of JSON.
It will return a success message if API is executed successfully.
| Attribute | Description |
|---|---|
| id | This contains the discount coupon id for ticketing. |
| code | This contains the name of discount code, e.g. CODE20, CODE50 etc. |
| amount | This contains the amount to be discounted. |
| couponUsed | This will return the number of coupons used. |
| maximumUseOfCoupon | This will return the maximum number of times a coupon can be used. |
| maximumUseOfCouponPerUser | This will return the maximum number of times a coupon can be used per user. |
| startDate | This contains the discount start date, e.g. "10/19/2021 11:24:00" |
| endDate | This contains the discount end date, e.g. "11/10/2021 16:45:00" |
| eventTicketTypeId | This contains the event ticket type id for discount. |
| discountType | This will return the discount type like PERCENTAGE or FLAT. |
| applicableTo | This will return the discount applicable to PER_TICKET or PER_ORDER. |
| recurringRelativeStartTime | This contains the coupon start time from XX hours before recurring event starts. |
| recurringRelativeEndTime | This contains the coupon end time from XX hours before recurring event ends. |
| recurringEventId | This contains the recurring event id for an in-person event. If this doesn't exist, it's otherwise null. |
Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.
| Error Code | Error Description |
|---|---|
| 200 | array of discount code. |
| 400 | The request could not be understood by the server due to malformed syntax. |
| 401 | The request could not be understood by the server due to malformed syntax. |
| 403 | Accessing the resource you were trying to reach is forbidden. |
| 404 | The resource you were trying to reach is not found. |
| 4030201 | Not Event Host. |