Retail Express API 2.1

Supplier

object

Supplier model

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Id

supplier_codestring

Supplier Code

>= 0 characters<= 20 characters

namestring

Supplier Name

>= 0 characters<= 50 characters

addressobject

Supplier address model

* Additional properties are NOT allowed.
Show Child Parameters
phonestring

Supplier Phone Number

>= 0 characters<= 20 characters

faxstring

Supplier Fax Number

>= 0 characters<= 20 characters

contact_namestring

Supplier Contact Name

>= 0 characters<= 50 characters

contact_emailstring(email)

Supplier Contact Email

>= 0 characters<= 120 characters

order_emailstring(email)

Supplier Order Email

>= 0 characters<= 120 characters

admin_only_ordersboolean

Admin Only Orders Flag

deposit_requiredboolean

Deposit Required Flag

shipping_portobject
* Additional properties are NOT allowed.
Show Child Parameters
country_of_originobject
* Additional properties are NOT allowed.
Show Child Parameters
shipping_termsstring

Supplier Shipping Terms

>= 0 characters<= 50 characters

payment_termsstring

Supplier Payment Terms

>= 0 characters<= 50 characters

commentsstring

Supplier Comments

Match pattern:^[^*|":<>[\]{}`\()';@&$#!-/?]+$

>= 0 characters<= 255 characters

purchase_order_templatestring

Supplier Purchase Order Template type

po_sku1_enabledboolean

PO SKU 1 Enabled (FALSE by default)

po_sku2_enabledboolean

PO SKU 2 Enabled (TRUE by default)

is_enabledboolean

Is enabled flag

modified_onstring(date-time)

Modified On

Example

Supplier.PagingResponse

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

Supplier model

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

SupplierAddress

object

Supplier address model

* Additional properties are NOT allowed.
address_line1string

Address line 1

>= 0 characters<= 255 characters

suburbstring

Suburb

>= 0 characters<= 50 characters

statestring

State

>= 0 characters<= 50 characters

postcodestring

Post code

>= 0 characters<= 10 characters

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

SupplierInvoice

object

Suplier Invoice Model

* Additional properties are NOT allowed.
idinteger(int32)

Id

supplier_invoice_numberstring

Supplier Invoice Number

statusstring

Supplier Invoice status

notesstring

Supplier Invoice notes

international_orderboolean

Is International Order

landed_costs_calculationstring

Allowed values:ManualCurrency Conversion

currency_conversionnumber(double)

Currency multiplier

rounding_adjustmentnumber(double)

Rounding Adjustment

origin_countryobject
* Additional properties are NOT allowed.
Show Child Parameters
distribute_costs_bystring

Distribute costs by

direct_costsobject

Direct costs model

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

Supplier Invoice Purchase Order Receipt Model

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

Total buy price ex

total_taxnumber(double)

Total tax

total_buy_price_incnumber(double)

Total buy price inc

total_applied_buy_price_exnumber(double)

Total applied buy price ex

created_onstring(date-time)

Created on

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

Modified on

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

Finalised on

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

Supplier Invoiced On

Example

SupplierInvoice.PagingResponse

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

Suplier Invoice Model

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