Search
K
Retail Express API 2.1

VoucherVoucherType

object
* Additional properties are NOT allowed.
idinteger(int32)

Voucher type Id.

namestring

Voucher type code

Example

OrderVoucher

object
* Additional properties are NOT allowed.
idinteger(int32)

Voucher Id.

codestring

Voucher code

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

Initial value

balancenumber(double)

Balance

created_onstring(date-time)

Created on

expires_onstring(date-time)

Modified on

Example

Order

object

Order Model

* Additional properties are NOT allowed.
billing_addressobject

Billing address model

* Additional properties are NOT allowed.
Show Child Parameters
private_commentsstring
delivery_addressobject

Delivery Address model

* Additional properties are NOT allowed.
Show Child Parameters
ext_unique_idstring

External ID of the payment, if applicable.

freight_totalnumber(double)

Freight total

freight_typeobject
* Additional properties are NOT allowed.
Show Child Parameters
idinteger(int32)

Order Id.

customerobject
* Additional properties are NOT allowed.
Show Child Parameters
order_numberstring

The Order identifier in Retail Express.

sales_channelobject
* Additional properties are NOT allowed.
Show Child Parameters
sales_personobject
* Additional properties are NOT allowed.
Show Child Parameters
order_statusobject
* Additional properties are NOT allowed.
Show Child Parameters
order_totalnumber(double)

Order total

outletobject

Order Outlet Model

* Additional properties are NOT allowed.
Show Child Parameters
public_commentsstring

Public comments

taxableinteger(int32)read-only

Is taxable

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

fulfilled_in_full_onstring(date-time)

Fulfilled in full on

paid_in_full_onstring(date-time)

Paid in full on

order_itemsarray[object]

Order Item Model

* Additional properties are NOT allowed.
Show Child Parameters
fulfilmentsarray[object]

Fulfilment model

* Additional properties are NOT allowed.
Show Child Parameters
paymentsarray[object]

Order Payment Model

* Additional properties are NOT allowed.
Show Child Parameters
vouchersarray[object]

Vouchers.

* Additional properties are NOT allowed.
Show Child Parameters
Example

Order.PagingResponse

object
* Additional properties are NOT allowed.
dataarray[object]

Order Model

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
Example

OutletFobCurrency

object

Outlet currency model

* Additional properties are NOT allowed.
idinteger(int32)

Identifier

codestring

Currency code

namestring

Currency name

Example