Influencer Vouchers

Get Influencer Voucher

get /sites/{siteid}/influencervouchers/{influencercode}
PARAMETERS
siteid
integer
path
REQUIRED
influencercode
integer
path
REQUIRED
RETURNS

Returns and item of type influencervoucher

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/influencervouchers/PREPARE4SUMMER.json
RESPONSE JSON
{
"influencercode": "PREPARE4SUMMER",
"influencername": "Taylor Smith",
"voucherpassword": "Lzs5MvMr",
"vouchercode": null,
"vouchername": null,
"vouchercomment": null,
"redeemable": true
}
HTTP Status Code Summary
200Returns and item of type influencervoucher
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Add Influencer Voucher Transaction

post /sites/{siteid}/influencervouchers/{influencercode}/transactions
PARAMETERS
siteid
integer
path
REQUIRED
influencercode
integer
path
REQUIRED
RETURNS

Returns an item of type influencervouchertransactionresponse

posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/influencervouchers/PREPARE4SUMMER/transactions.json
{
"moneyordertotal": "100.00",
"moneyinfluencertotal": "80.00",
"moneyinfluencerdiscount": "20.00",
"currencycode": "USD"
}
RESPONSE JSON
{
"transactionid": "4"
}
HTTP Status Code Summary
200Returns an item of type influencervouchertransactionresponse
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Delete Influencer Voucher Transaction

delete /sites/{siteid}/influencervouchers/{influencercode}/transactions/{transactionid}
PARAMETERS
siteid
integer
path
REQUIRED
influencercode
integer
path
REQUIRED
transactionid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/influencervouchers/PREPARE4SUMMER/transactions/4.json
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Objects

influencervoucher
object

The influencer voucher object.

PROPERTIES
influencercode
string

The unique influencer code. Can only contain [0-9a-zA-Z&_-.]

influencername
string

The name of the influencer for this code.

voucherpassword
string

The password used for unlocking voucher.

vouchercode
string

Override voucher code used for this influencer code or null to leave voucher code.

vouchername
string

Override voucher name used for this influencer code or null to leave voucher name.

vouchercomment
string

Override voucher description used for this influencer code or null to leave voucher comment.

redeemable
boolean
READ ONLY

Whether the influencer voucher is redeemable

influencervouchertransaction
object

The influencer voucher transaction object.

PROPERTIES
moneyordertotal
REQUIRED

The total amount of sales for this transaction.

moneyinfluencertotal
REQUIRED

The amount of sold items where the influencer voucher applied for this transaction.

moneyinfluencerdiscount
REQUIRED

The amount of discount the influencer voucher gave for this transaction.

currencycode
string
REQUIRED

Currency for the transaction. (ISO 4217, alpha-3 uppercased)

merchant_reference
string

Optional merchant/store reference for this transaction.

staff_reference
string

Optional staff reference for this transaction.

influencervouchertransactionresponse
object

The influencer voucher transaction response object.

PROPERTIES
transactionid
string
READ ONLY

The unique id of this transaction.

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$