Search
K
Retail Express API 2.1

Get specific voucher by unique id

Get specific voucher by unique id

get
https://api.retailexpress.com.au/v2.1/vouchers/{id}

Path Parameters

idinteger(int32)required

voucher id

Example:10000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Returns found voucher

Voucher

* Additional properties are NOT allowed.
idinteger | null(int32)

Voucher Id.

codestring | null

Voucher code

typeobject
* Additional properties are NOT allowed.
Show Child Parameters
initial_valuenumber | null(double)

Initial value

balancenumber | null(double)

Balance

created_onstring(date-time)

Created on

expires_onstring | null(date-time)

Modified on

orderobject
* Additional properties are NOT allowed.
Show Child Parameters
get/vouchers/{id}
 
application/json

vouchertypes

Searches Voucher Types by parameters

Searches Voucher Types by parameters

get
https://api.retailexpress.com.au/v2.1/vouchertypes

Query Parameters

order_bystring | null

Order by.

Available field name values: id, name

Available direction values: asc, desc.

Example: id asc, name desc

page_numberinteger(int32)

>= 1<= 100000

page_sizeinteger(int32)

>= 1<= 2147483647

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Paging Response with Voucher Types data

VoucherType.PagingResponse

* Additional properties are NOT allowed.
dataarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/vouchertypes
 
application/json

Gets specific Voucher Type by unique id

Gets specific Voucher Type by unique id

get
https://api.retailexpress.com.au/v2.1/vouchertypes/{id}

Path Parameters

idinteger(int32)required

Voucher Type id

Example:10000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Returns found Voucher Type

VoucherType

* Additional properties are NOT allowed.
idinteger | null(int32)

Voucher type Id.

namestring | null

Voucher type code

voucher_textstring | null

Voucher type code

valid_for_daysinteger | null(int32)

Voucher type code

get/vouchertypes/{id}
 
application/json

AccountCustomer

object

Account customer view model

* Additional properties are NOT allowed.
credit_blockedboolean

Is credit blocked

credit_limitnumber(double)

Credit limit

credit_remainingnumber(double)

Credit remaining

enabledboolean

Is enabled

payment_termsinteger(int32)

Payment terms

Example