Retail Express API 2.1

CurrencyLimited

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

Currency Id

currency_codestring

Currency Code

currency_namestring

Currency Name

Example

Customer

object

Customer model

* Additional properties are NOT allowed.
account_customerobject

Account customer view model

* Additional properties are NOT allowed.
Show Child Parameters
acnstring

Acn

billing_addressobject

Billing address model

* Additional properties are NOT allowed.
Show Child Parameters
companystring

Company

customer_numberstring

Customer number

customer_typeobject

Customer type model

* Additional properties are NOT allowed.
Show Child Parameters
date_of_birthstring

Date of birth

date_of_birth_withheldboolean

Date of birth with held

delivery_addressesarray[object]

Delivery Address model

* Additional properties are NOT allowed.
Show Child Parameters
emailstring

Email

faxstring

Fax

first_namestring

First name

idinteger(int32)

Identifier

last_namestring

Last name

loyalty_programobject

Loyalty program model

* Additional properties are NOT allowed.
Show Child Parameters
marketingobject

Marketing view model

* Additional properties are NOT allowed.
Show Child Parameters
mobilestring

Mobile

phonestring

Phone

price_groupsarray[object]

Price group model

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

Survey Response model

* Additional properties are NOT allowed.
Show Child Parameters
websitestring

Website

home_outletobject
* Additional properties are NOT allowed.
Show Child Parameters
custom_referencestring

Custom reference

export_to_webboolean

Export to web

total_paymentsnumber(double)

Total Payments

total_transactionsinteger(int32)

Total Transactions

sales_channelsarray[object]

CustomerSalesChannel Model

* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

Example

Customer.PagingResponse

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

Customer model

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

CustomerBillingAddress

object

Billing address model

* Additional properties are NOT allowed.
countrystring

Country

country_codestring

Country Code

statestring

State

suburbstring

Suburb

address_line1string

Address line 1

address_line2string

Address line 2

postcodestring

Post code

first_namestring

First name

last_namestring

Last Name

Example

CustomerLimited

object
* Additional properties are NOT allowed.
customer_numberstring

Customer number

emailstring

Email

first_namestring

First name

idinteger(int32)

Identifier

last_namestring

Last name

custom_referencestring

Custom reference

Example