JSON API » vouchers » vouchers/get
Gets the fields of a voucher.
Input parameters
Requires authentication and the commerce role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| serial | String | Serial number of voucher to get. | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The voucher does not exist, or you do not have permission to view it. |
Data returned
Fields of voucher.
Example: With required parameters
http://enswitch.example.com/api/json/vouchers/get/?auth_username=user;auth_password=password;serial=1234567890{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "serial":"1234567890", ... } }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |