Subscription key.
Acquires token
Acquires token
Headers
Response
200
Response
Returns authentication result
Headers
vouchers
Searches Vouchers by parameters
Searches Vouchers by parameters
Query Parameters
Order by.
Available field name values: id, code, voucher_type, balance, created_on, expires_on, initial_value
Available direction values: asc, desc.
Example: id asc, voucher_type desc
Filter by.
Available field name values: code, voucher_type_id, initial_value, balance, created_on, expires_on, order_id, order_number, customer_id, customer_number, customer_email
In string values: ‘|’ and ‘,’ characters have to be escaped with slash, i.e. ‘\,’ ‘\|’
For operators that support multiple values (in, notin): multiple values are delimited using ‘|’ character
Available operators:
eq - Equal
neq - Not equals
lt - Less
lte - Less or equal
gt - Greater
gte - Greater or equal
in - In
notin - Not In
contains - Contains
isnull - Is Null
isnullorempty - Is Null Or Empty
isnotnull - Is Not Null
startswith - Starts with
endswith - Ends with
doesnotcontain - Does not contain
For non-nullable fields operators isnull and isnotnull are unavailable
For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable
For strings operators: lt, lte, gt, gte are unavailable
Example: created_on:gte:2021-06-03T05:48:09+10:00,order_number:in:order_number1|order_number2
Format - int32.
>= 1<= 100000
Format - int32.
>= 1<= 2147483647
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
Paging Response with Vouchers data
Voucher.PagingResponse
Show Child Parameters
Query Parameters
Headers
Gets specific Voucher by unique id
Gets specific Voucher by unique id
Path Parameters
Voucher id
Example:10000
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
Returns found Voucher
Voucher
Voucher Id.
Voucher code
Show Child Parameters
Initial value
Balance
Created on
Modified on
Order model