Influencer Vouchers
Get Influencer Voucher
get /sites/{siteid}/influencervouchers/{influencercode}{ "influencercode": "PREPARE4SUMMER", "influencername": "Taylor Smith", "voucherpassword": "Lzs5MvMr", "vouchercode": null, "vouchername": null, "vouchercomment": null, "redeemable": true}| HTTP Status Code Summary | |
|---|---|
| 200 | Returns and item of type influencervoucher |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Add Influencer Voucher Transaction
post /sites/{siteid}/influencervouchers/{influencercode}/transactionsReturns an item of type influencervouchertransactionresponse
{ "moneyordertotal": "100.00", "moneyinfluencertotal": "80.00", "moneyinfluencerdiscount": "20.00", "currencycode": "USD"}{ "transactionid": "4"}| HTTP Status Code Summary | |
|---|---|
| 200 | Returns an item of type influencervouchertransactionresponse |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Delete Influencer Voucher Transaction
delete /sites/{siteid}/influencervouchers/{influencercode}/transactions/{transactionid}true| HTTP Status Code Summary | |
|---|---|
| 200 | Returns true |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Objects
influencervoucherobject
The influencer voucher object.
The unique influencer code. Can only contain [0-9a-zA-Z&_-.]
The name of the influencer for this code.
The password used for unlocking voucher.
Override voucher code used for this influencer code or null to leave voucher code.
Override voucher name used for this influencer code or null to leave voucher name.
Override voucher description used for this influencer code or null to leave voucher comment.
Whether the influencer voucher is redeemable
influencervouchertransactionobject
The influencer voucher transaction object.
The total amount of sales for this transaction.
The amount of sold items where the influencer voucher applied for this transaction.
The amount of discount the influencer voucher gave for this transaction.
Currency for the transaction. (ISO 4217, alpha-3 uppercased)
Optional merchant/store reference for this transaction.
Optional staff reference for this transaction.
influencervouchertransactionresponseobject
The influencer voucher transaction response object.
The unique id of this transaction.