JSON API » vouchers » vouchers/batches/get

Gets the fields of a voucher batch.

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
id	Integer	ID of voucher batch to get.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The voucher batch does not exist, or you do not have permission to view it.

Data returned

Fields of voucher batch.

Example: With required parameters

http://enswitch.example.com/api/json/vouchers/batches/get/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example", ... } }

Change history

Version	Changes
3.13	Function added.