JSON API » vouchers » vouchers/batches/create

Creates a new 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
name	String	Name.	Yes
value	Decimal	Value of each voucher created.	Yes
currency	String	Currency value is in.	No	System currency.
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
locked	Integer	1 if entire batch is locked, 0 if not.	No	0
number	Integer	Number of vouchers to add to batch.	No	1
serial_length	Integer	Length of serial number.	No	System default.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created voucher batch.

Example: With required parameters

http://enswitch.example.com/api/json/vouchers/batches/create/?auth_username=user;auth_password=password;name=example;value=10.00

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

Change history

Version	Changes
3.13	Function added.