Retail Express API 2.1

SupplierReturnAddress

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

SupplierReturnUser

object

User Model

* Additional properties are NOT allowed.
idinteger(int32)

Id of User

user_codestring

User code.

first_namestring

First name.

surnamestring

Surname.

Example

SupplierReturns

object

Supplier Returns VM

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return identifier

include_taxboolean

Include Tax

Default:true

supplierobject

Supplier model

* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_statusobject

Supplier Return Status Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_addressobject

Supplier address model

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

Total return quantity

total_claim_amount_exnumber(double)

Total claim amount ex

total_claim_amount_taxnumber(double)

Total claim amount tax

total_claim_amount_incnumber(double)

Total claim amount inc

total_credit_received_exnumber(double)

Total credit received ex

total_credit_received_incnumber(double)

Total credit received inc

notesstring

Notes

>= 0 characters<= 8000 characters

return_authorisationstring

Return Authorisation

>= 0 characters<= 100 characters

started_onstring(date-time)

Started on

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

finalised_onstring(date-time)

Finalised on

credit_notesarray[object]

Credit Note model

* Additional properties are NOT allowed.
Show Child Parameters
created_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
Example

SupplierReturns.PagingResponse

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

Supplier Returns VM

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

SupplierReturnItemProduct

object

Supplier Return Item Product Model

* Additional properties are NOT allowed.
idinteger(int32)

Product Id.

supplier_skustring

Supplier SKU.

manufacturer_skustring

Manufacture SKU

supplier_sku2string

Supplier SKU 2.

short_descriptionstring

Product description.

sizeobject
* Additional properties are NOT allowed.
Show Child Parameters
colourobject
* Additional properties are NOT allowed.
Show Child Parameters
Example