Retail Express API 2.1

Outlet

object

Outlet model

* Additional properties are NOT allowed.
idinteger(int32)

Outlet id

namestring

Outlet name

>= 0 characters<= 255 characters

external_referencestring

External outlet code

>= 0 characters<= 30 characters

enabledboolean

Enabled

company_namestring

Company

>= 0 characters<= 100 characters

company_registration_numberstring

Company registration number

>= 0 characters<= 50 characters

company_registration_labelstring

Company registration label

>= 0 characters<= 15 characters

billing_typeinteger(int32)

Billing type

fob_currencyobject
* Additional properties are NOT allowed.
Show Child Parameters
store_typeobject

Sore type model

* Additional properties are NOT allowed.
Show Child Parameters
addressobject

Outlet address model

* Additional properties are NOT allowed.
Show Child Parameters
phonestring

Phone

>= 0 characters<= 50 characters

faxstring

Fax

>= 0 characters<= 50 characters

emailstring

Email

>= 0 characters<= 50 characters

bank_detailsobject

Outlet bank details model

* Additional properties are NOT allowed.
Show Child Parameters
default_source_outletobject
* Additional properties are NOT allowed.
Show Child Parameters
default_fulfil_outletobject
* Additional properties are NOT allowed.
Show Child Parameters
minimum_replenishment_quantityinteger(int32)

Minimum replenishment quantity

>= 0<= 2147483647

logoobject
* Additional properties are NOT allowed.
Show Child Parameters
invoice_email_templateobject

Outlet email from template model

* Additional properties are NOT allowed.
Show Child Parameters
invoice_receipt_commentsstring

Invoice receipt comments

Match pattern:^(?!.*<[^>]+>).*

>= 0 characters<= 8000 characters

display_address_on_invoiceboolean

Display address on invoice

purchase_order_commentsstring

Purchase order comments

Match pattern:^(?!.*<[^>]+>).*

>= 0 characters<= 8000 characters

modified_onstring(date-time)

Modified on

Example

Outlet.PagingResponse

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

Outlet model

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

OutletAddress

object

Outlet address model

* Additional properties are NOT allowed.
address_line1string

Adress

>= 0 characters<= 255 characters

address_line2string

Adress2

>= 0 characters<= 100 characters

address_line3string

Adress3

>= 0 characters<= 100 characters

suburbstring

Suburb

>= 0 characters<= 100 characters

statestring

State

>= 0 characters<= 50 characters

postcodestring

Postcode

>= 0 characters<= 10 characters

countryobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

OutletBankDetails

object

Outlet bank details model

* Additional properties are NOT allowed.
bank_namestring

Bank name

>= 0 characters<= 128 characters

bsbstring

Bank bsb

>= 0 characters<= 16 characters

account_numberstring

Account number

>= 0 characters<= 32 characters

account_namestring

Account name

>= 0 characters<= 128 characters

Example

OutletEmailFromTemplate

object

Outlet email from template model

* Additional properties are NOT allowed.
idinteger(int32)

Identifier

namestring

Email from template name

Example