/vouchers
GET {{baseUrl}}/vouchers?fields=<string>&sort=<string>&count=<integer>&offset=<integer>&code=<string>
Returns all vouchers. By default the first 50 regular vouchers are returned, sorted by creation date
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | Comma seperated list of properties to include | |
sort | string | If not included, results are sorted by creation date | |
count | string | The maximum number of results to be returned | |
offset | string | The starting position for the returned values | |
code | string | Specify the voucher's code (E.g. 10POUND to return all vouchers with that code) |
RESPONSES
status: OK
[{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","discount":{"type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"validFrom":"\u003cstring\u003e","expiresOn":"\u003cstring\u003e","target":{"type":"\u003cstring\u003e","value":"\u003cnumber\u003e","ids":["\u003cinteger\u003e","\u003cinteger\u003e"]},"active":"\u003cboolean\u003e","uses":"\u003cinteger\u003e","used":"\u003cinteger\u003e","customerUses":"\u003cinteger\u003e","comments":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","discount":{"type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"validFrom":"\u003cstring\u003e","expiresOn":"\u003cstring\u003e","target":{"type":"\u003cstring\u003e","value":"\u003cnumber\u003e","ids":["\u003cinteger\u003e","\u003cinteger\u003e"]},"active":"\u003cboolean\u003e","uses":"\u003cinteger\u003e","used":"\u003cinteger\u003e","customerUses":"\u003cinteger\u003e","comments":"\u003cstring\u003e"}]