Retail Express API 2.1

StockReceipt

object

Stock Receipt model

* Additional properties are NOT allowed.
idinteger(int32)

Stock receipt id

source_typestring

Source type Available values: ‘PO’ or ‘ITO’

source_idinteger(int32)

Source id
represents id of source - can be for either dbo.PO or dbo.tblITO

source_item_idinteger(int32)

Source item id
represents id of source item

source_receipt_item_idinteger(int32)

Source receipt item id
represents id of receipt item

productobject
* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
received_quantityinteger(int32)

Received quantity (must be > 0)

buy_price_exnumber(double)

Buy price ex (must be >= 0)

direct_costs_exnumber(double)

Direct costs ex

tax_ratenumber(double)

Tax rate

created_onstring(date-time)

Created on

Example

StockReceipt.PagingResponse

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

Stock Receipt model

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

StoreType

object

Sore type model

* Additional properties are NOT allowed.
idinteger(int32)

Identifier

namestring

Store type name

Example

String.BeforeAfter

object
* Additional properties are NOT allowed.
beforestring

Before

afterstring

After

Example

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