UpdateVoucher
| Endpoint URL |
https://www.yournetosite.com.au/do/WS/NetoAPI |
| Method |
POST |
| XML Headers |
| NETOAPI_ACTION |
UpdateVoucher |
| NETOAPI_USERNAME |
Your Neto Username (generate this in your Neto control panel) |
| NETOAPI_KEY |
Your Neto API Secure Key (generate this in your Neto control panel) |
|
| JSON Headers |
| NETOAPI_ACTION |
UpdateVoucher |
| NETOAPI_USERNAME |
Your Neto Username (generate this in your Neto control panel) |
| NETOAPI_KEY |
Your Neto API Secure Key (generate this in your Neto control panel) |
| Accept |
application/json |
|
| Description |
|
| XSD Schema |
UpdateVoucher XSD | UpdateVoucher Response XSD
|
UpdateVoucher Post
You must specify at least one filter and one OutputSelector in your UpdateVoucher request. These will determine the results returned.
XML POST
<?xml version="1.0" encoding="utf-8"?>
<UpdateVoucher>
<Voucher>
<Email>(String)</Email>
<IsRedeemed>(Boolean)</IsRedeemed>
<Owner>(String)</Owner>
<VoucherID>(Integer)</VoucherID>
</Voucher>
</UpdateVoucher>
JSON POST
{
"Voucher": [ {
"Email":"String",
"IsRedeemed":"Boolean",
"Owner":"String",
"VoucherID":"Integer"
} ]
}
<Voucher>
| Element Name |
Required |
Field Type / Options |
| Email |
Required |
String(50) |
| IsRedeemed |
Required |
Boolean(True, False) |
| Owner |
Required |
String(100) |
| VoucherID |
Required |
Integer(10) |
UpdateVoucher Responses
XML Response
<?xml version="1.0" encoding="utf-8"?>
<UpdateVoucher>
<Voucher>
<VoucherID>(Integer)</VoucherID>
<VoucherProgramID>(Integer)</VoucherProgramID>
<VoucherTitle>(String)</VoucherTitle>
<VoucherCode>(String)</VoucherCode>
<SecretKey>(String)</SecretKey>
<IsRedeemed>(String)</IsRedeemed>
<Owner>(String)</Owner>
<Email>(String)</Email>
<CreatedFromOrderID>(String)</CreatedFromOrderID>
<DateAdded>(DateTime)</DateAdded>
<DateUpdated>(DateTime)</DateUpdated>
<Balance>(Decimal)</Balance>
<IsSingleUse>(String)</IsSingleUse>
<VoucherProgram>(String)</VoucherProgram>
<ProgramType>(String)</ProgramType>
<ListOfCreditHistory>
<CreditHistory>
<OrderID>(String)</OrderID>
<Status>(String)</Status>
<AmountCredited>(Decimal)</AmountCredited>
<TotalAmountUsed>(Decimal)</TotalAmountUsed>
<Balance>(Decimal)</Balance>
<DateAdded>(DateTime)</DateAdded>
<ExpiryDate>(DateTime)</ExpiryDate>
</CreditHistory>
</ListOfCreditHistory> <ListOfUsageHistory>
<UsageHistory>
<OrderID>(String)</OrderID>
<PaymentID>(Integer)</PaymentID>
<Amount>(Decimal)</Amount>
<DateUsed>(DateTime)</DateUsed>
</UsageHistory>
</ListOfUsageHistory> </Voucher>
<Messages>
<Error>
<Message>(String)</Message>
<SeverityCode>(String)</SeverityCode>
<Description>(String)</Description>
</Error>
<Warning>
<Message>(String)</Message>
<SeverityCode>(String)</SeverityCode>
</Warning>
</Messages>
</UpdateVoucher>
JSON Response
{
"Voucher": [ {
"VoucherID":"Integer",
"VoucherProgramID":"Integer",
"VoucherTitle":"String",
"VoucherCode":"String",
"SecretKey":"String",
"IsRedeemed":"String",
"Owner":"String",
"Email":"String",
"CreatedFromOrderID":"String",
"DateAdded":"DateTime",
"DateUpdated":"DateTime",
"Balance":"Decimal",
"IsSingleUse":"String",
"VoucherProgram":"String",
"ProgramType":"String",
"ListOfCreditHistory": {
"CreditHistory": [ {
"OrderID":"String",
"Status":"String",
"AmountCredited":"Decimal",
"TotalAmountUsed":"Decimal",
"Balance":"Decimal",
"DateAdded":"DateTime",
"ExpiryDate":"DateTime"
} ]
} , "ListOfUsageHistory": {
"UsageHistory": [ {
"OrderID":"String",
"PaymentID":"Integer",
"Amount":"Decimal",
"DateUsed":"DateTime"
} ]
}
} ] , "Messages": {
"Error": [ {
"Message":"String",
"SeverityCode":"String",
"Description":"String"
} ] , "Warning": [ {
"Message":"String",
"SeverityCode":"String"
} ]
}
}
<Voucher>
<ListOfCreditHistory>
<CreditHistory>
<ListOfUsageHistory>
<UsageHistory>
<Messages>
<Error>
<Warning>
If you are a vendor creating an integration with Neto by Maropost, we would like to hear from you!
Contact Us