Retail Express API 2.1

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

PurchaseOrderItem

object

Purchase Order Item

* Additional properties are NOT allowed.
po_idinteger(int32)

Purchase Order entity Id

po_item_idinteger(int32)

Id of Purchase Order Item

productobject

Product Model

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

Quantity ordered

quantity_special_orderinteger(int32)

Quantity special order

quantity_back_orderinteger(int32)

Quantity back order

quantity_receivedinteger(int32)

Quantity received

quantity_received_varianceinteger(int32)

Quantity received variance

quantity_cancelledinteger(int32)

Quantity Cancelled

quantity_remaininginteger(int32)

Quantity Remaining

variance_reasonobject

Purchase Order Item Variance Reason

* Additional properties are NOT allowed.
Show Child Parameters
inventoryobject

Purchase Order Item Inventory

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

Supplier Buy Ex

total_weightnumber(double)

Total weight

total_cubicnumber(double)

Total cubic

gross_profitnumber(double)

Gross profit

mark_upnumber(double)

Mark Up

total_supplier_buy_exnumber(double)

Total supplier buy ex

is_linked_to_transferboolean

Is Linked to ITO flag

modified_onstring(date-time)

Last Modified On date

created_onstring(date-time)

Created On date

Example