LOGISTICS API INWARD REFERENCE LIST

The table below shows all possible reference type that will be available in a Logistics API Request. Required fields are in bold text.

References Types

Reference TypeAdditional FieldsDescriptionRequired
OurReference value Your unique order reference identifying the Inward Yes
InwardsReference1 value Your first reference for the Inward  
InwardsReference2 value Your second reference for the Inward  
CarrierReference value Not required in your request. Carrier Reference is populated when finalising/despatching your inward  
SupplierReference value Supplier reference  
VendorReference value Vendor reference  

Inward Line References Types

Reference TypeAdditional FieldsDescriptionRequired
ShippingNotification code shippingNotification  
PurchaseOrderNumber code purchaseOrderNumber  
PurchaseOrderLineNumber code purchaseOrderLineNumber  

Party Types

Reference TypeAdditional FieldsDescriptionRequired
Warehouse code Fixed value to define 'Warehouse Code' code value needs to be populated with type Integer Yes
Customer code Your customer code in the WMS code value needs to be populated with type String Yes
Pickup code, displayName, address1, address2, suburb, postCode, city, state, country, phone    

Note Types

All notes will have a 50 character limit unless specified otherwise.

Reference TypeAdditional FieldsDescriptionRequired
Note value Notes for the inward  

Attribute Types

Reference TypeAdditional FieldsDescriptionRequired
Grade1 value Grade 1 attribute field against products in the WMS  
Grade2 value Grade 2 attribute field against products in the WMS  
Grade3 value Grade 3 attribute field against products in the WMS  
ExpiryDate value Expiry date attribute field against products in the WMS
Date type attributes must have a format yyyy-MM-dd
 
PackingDate value Packing date attribute field against products in the WMS
Date type attributes must have a format yyyy-MM-dd
 
UnderBond value Underbond must be a boolean value  
ArrivalDate value Arrival date attribute field against products in the WMS
Date type attributes must have a format yyyy-MM-dd
 
VFD value Value For Duty  
VTI value Value Transport Insurance  
LicensePlateNumber value LicensePlateNumber  
EntryNumber value EntryNumber  
EntryLineNumber value EntryLineNumber  

Inward Types

Reference TypeTypeDescriptionRequired
G string Normal GRN Default
X string Cross Dock  
D string Damaged Goods  
O string Overseas Receipt  
R string Trade Returns  
T string Warehouse Transfer  

Stock Status Types

Reference TypeTypeDescriptionRequired
N string Normal Default
H string On Hold  
D string Damaged  
R string Restricted  
NOTE: Content in the panels below this point are not visible on the site unless used by other features e.g. gadgets, OB&E, etc.