Vouchers
Last updated
Was this helpful?
Last updated
Was this helpful?
Scope: visitor and above
This endpoint is used to lock Apparel21 gift voucher.
The endpoint must accept a voucher number and a validation id.
Validation id is retrieved from the response after validating a gift voucher.
The endpoint returns a 200 status code if successful.
The Apparel21 voucher number
The validation id retrieved after validating gift voucher
If invalid, obtain a new one by making a request to validate gift voucher
Number of seconds that voucher is to be locked for (if not supplied, lock is applied for 3600 seconds = 1 hour).
To unlock voucher, post another lock request with lock seconds of zero.
Scope: visitor and above
This endpoint retrieves information about Apparel21 gift voucher as well as validate the gift voucher.
The endpoint must accept a voucher number and a pin.
To validate a gift voucher, add 'amount' field as a query parameter.
The endpoint returns gift voucher information such as voucher number, expiry date, balance, used amount and validation id.
The Apparel21 voucher number
The Apparel21 voucher pin
To validate gift voucher - Amount of the voucher that will be used – this is only used for checking that “give change” vouchers will be used in full
"validationId" property will be included in the response
Scope: maintainer and above
This endpoint allows you to create a gift voucher in Apparel21. The gift voucher is a digital voucher that can be sent to customers via email, containing a pin number that can be used for making purchases. Before using this endpoint, ensure that the necessary configurations are set up in both DotApparel and Apparel21.
Requirements:
Gift Card SKU IDX: Make sure the SKU IDX for the gift card has been set up in DotApparel. This ensures that the appropriate product is associated with the gift voucher.
Voucher Type: Ensure that the voucher type has been configured in DotApparel. This specifies the specific type of gift voucher being created.
Gift Voucher Function: Confirm with your merchant that the gift voucher function has been properly set up in Apparel21. This ensures that the system can automatically send out an email containing the digital gift voucher and pin number to the customer.
To obtain the names of all available payment gateways, you can make a GET request to the "/order/gateways" endpoint. In order to determine the appropriate gateway for this specific request, please get in touch with your merchant.
shopifyThe message that are sent to receiver
Happy birthday!If an orderNumber is provided, it will be recognised as the Customer Order Number within the Apparel21. However, if the field is left empty, the API will automatically generate a unique order number.
#1001The unit price of the gift card
100The gift voucher receiver's email address
smith.james@example.comThe gift voucher receiver's name
Smith JamesThe email field is mandatory.
john.williams@example.comMobile Phone
(04) 8375 9586The gift voucher sender's name
John WilliamsThe subject line of the email
My Gift Voucher