Retail Express API 2.1

ProductSupplier

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

Product ID

supplier_codestring

Supplier Code

supplier_namestring

Supplier Name

supplier_statusboolean

Supplier Status (true - Enabled, false - Disabled)

supplier_buy_exnumber(double)

Supplier Buy Ex

>= -922337203685477.6<= 922337203685477.6

supplier_sku2string

Supplier SKU2

lead_timeinteger(int32)

Lead Time in days

is_defaultboolean

Indicates if the product supplier is a default supplier

notesstring

Notes

is_deletedboolean

Indicates if the product supplier is soft deleted

Example

ProductType

object

Product Type Model

* Additional properties are NOT allowed.
idinteger(int32)

Product type Id.

namestring

Product type description (Name)

Match pattern:^[a-zA-Z0-9\s./;:\-_+()*&^%$#@]+$

>= 0 characters<= 50 characters

modified_onstring(date-time)

Modified on

Example

ProductType.PagingResponse

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

Product Type Model

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

PurchaseOrder

object

Purchase order model

* Additional properties are NOT allowed.
idinteger(int32)

Purchase order id

external_purchase_order_idstring

External purchase order id

reference_purchase_order_idinteger(int32)

Reference purchase order id

statusobject

Purchase order status model

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

Purchase order supplier model

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

Sailed date

deposit_duestring(date-time)

Deposit due date

balance_duestring(date-time)

balance due date

supplier_commentsstring

Supplier comments

purchase_order_templatestring

Purchase order template

update_linked_transfers_on_receipt_tostring

Update linked transfers on receipt to
Avalable values are: qty_allocated or Allocate, qty_picked or Pick, qty_dispatched or Dispatch
Can be updated only when PO has status Incomplete, OnOrder, ReceivingInProgress

autoreplenishment_invoice_numberstring

Autoreplenishment invoice number

autoreplenishment_invoice_referencestring

Autoreplenishment invoice reference

original_departurestring(date-time)

Original departure

etastring(date-time)

Eta

container_numberstring

Container number

deliver_tostring

Deliver to

shipping_statusobject

Purchase order shipping status model

* Additional properties are NOT allowed.
Show Child Parameters
shipping_typeobject

Purchase order shipping type model

* Additional properties are NOT allowed.
Show Child Parameters
shipping_portobject

Purchase order shipping port model

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

Shipping terms

payment_termsstring

Payment terms

invoice_documentsstring

Invoice documents

packing_list_documentsstring

Packing list documents

packing_declaration_documentsstring

Packing declaration documents

fumes_documentsstring

Fumes documents

certificate_of_original_documentsstring

Certificate of original documents

bill_of_lading_documentsstring

Bill of lading documents

internal_commentsstring

Internal comments

supplier_invoice_numberstring

Supplier Invoice Number

depositnumber(double)

Deposit

purchase_order_itemsarray[object]

Purchase Order Item

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

Total weight

total_cubicnumber(double)

Total cubic

total_quantity_special_orderinteger(int64)

Total quantity special order

total_quantity_receivedinteger(int64)

Total quantity received

total_quantity_remaininginteger(int64)

Total quantity remaining

total_quantity_cancelledinteger(int64)

Total quantity cancelled

total_quantity_orderedinteger(int64)

Total quantity ordered

total_supplier_buy_exnumber(double)

Total supplier buy ex

total_quantity_linked_transfersinteger(int32)

Total quantity linked transfers

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

Created on

modified_onstring(date-time)

Modified on

sent_onstring(date-time)

Sent on

received_onstring(date-time)

Received on

created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

PurchaseOrder.PagingResponse

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

Purchase order model

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