Environment: ProductionEnvironment: Production USEnvironment: Test
API Reference

List vouchers.

get
https://api.test.bluestonepim.com/voucher/vouchers
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Voucher name contains the given value

string
enum
Defaults to CONTAINS

Voucher name matching conditions (default: CONTAINS)

Allowed:
string

Voucher code equals the given value

string
enum
Defaults to CONTAINS

Voucher code matching conditions (default: CONTAINS)

Allowed:
boolean

Voucher has been redeemed

string
enum

Voucher status equals the given value

Allowed:
string
enum

Voucher type equals the given value

Allowed:
date-time

Voucher's active date in ISO 8601 date format

date-time

Voucher's start date from value in ISO 8601 date format

date-time

Voucher's start date to value in ISO 8601 date format

date-time

Voucher's expiration date from value in ISO 8601 date format

date-time

Voucher's expiration date to value in ISO 8601 date format

string
enum

Discount type equals the given value

Allowed:
number

Discount value equals the given value

boolean

Include entities

string
enum

Sort by field. (default sort by newest)

Allowed:
string
enum

Sort direction

Allowed:
int32
0 to 2147483647
Defaults to 0

Number of page. default 0

int32
1 to 1000
Defaults to 20

Size per page. default 20

Responses

500

Internal server error

Updated 5 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?