Contributors:
eCommerce Gift Vouchers API
Create, Retrieve, Update and Delete eCommerce Gift Vouchers via the public API endpoint using "where" filtering.
GET eCommerce Gift Vouchers List
Retrieves a list of Gift Vouchers as a JSON response based on your provided query parameters.
/api/v2/admin/gift-vouchers
Parameters
Parameter
Values
Required
Where
{<where query>}Order_By
<propertyAlias>Offset
<integer>Limit
<integer>Data / Response:
N/A{
"Items": [
{
"Id": 0,
"Balance": 0,
"Name": "string",
"Amount": 0,
"Enabled": true,
"Currency": "string",
"OrderId": 0,
"Type": "string",
"Recipient": {
"Name": "string",
"Email": "string",
"Message": "string"
}
}
],
"TotalItemsCount": 0
}
POST eCommerce Gift Voucher Create
Creates a new Gift Voucher based on the provided data.
/api/v2/admin/gift-vouchers
Data / Response:
{
"Name": "string",
"Amount": 0,
"Enabled": true,
"Currency": "string",
"OrderId": 0,
"Type": "string",
"Recipient": {
"Name": "string",
"Email": "string",
"Message": "string"
}
}
{
"Id": 0,
"Balance": 0,
"Name": "string",
"Amount": 0,
"Enabled": true,
"Currency": "string",
"OrderId": 0,
"Type": "string",
"Recipient": {
"Name": "string",
"Email": "string",
"Message": "string"
}
}
GET eCommerce Gift Voucher Item
Retrieves a single Gift Voucher based on the ID passed in the endpoint URL.
/api/v2/admin/gift-vouchers/{id}
Data / Response:
N/A
{
"Id": 0,
"Balance": 0,
"Name": "string",
"Amount": 0,
"Enabled": true,
"Currency": "string",
"OrderId": 0,
"Type": "string",
"Recipient": {
"Name": "string",
"Email": "string",
"Message": "string"
}
}
PUT eCommerce Gift Voucher Update
Updates a single Gift Voucher based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/gift-vouchers/{id}
Data / Response:
{
"Name": "string",
"Amount": 0,
"Enabled": true,
"Currency": "string",
"OrderId": 0,
"Type": "string",
"Recipient": {
"Name": "string",
"Email": "string",
"Message": "string"
}
}
{
"Id": 0,
"Balance": 0,
"Name": "string",
"Amount": 0,
"Enabled": true,
"Currency": "string",
"OrderId": 0,
"Type": "string",
"Recipient": {
"Name": "string",
"Email": "string",
"Message": "string"
}
}
DELETE eCommerce Gift Voucher Delete
Deletes a single Gift Voucher based on the ID passed in the endpoint URL.
/api/v2/admin/gift-vouchers/{id}
Data / Response:
N/A
Status 204