LOGISTICS API ORDER 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 code Your unique order reference identifying the Order Yes
YourReference code Your customer reference for the Order  
YourReceiverReference code Your customer's receiver reference for the Order  
CarrierReference code Not required in your request. Carrier Reference is populated when finalising/despatching your order  
CrossDocReference code Cross docking reference  

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
Receiver code, displayName, address1, address2, suburb, postCode, city, state, country,phone Receiver contact details. If the WMS is configured to store your receiver details, code will be required. For any other case code, displayName, address1 and country will be required Yes
ReceiverGroup code

General purpose field to group Receivers that have the same business rules, e.g. documentation

 
SoldTo code, displayName, address1, address2, suburb, postCode, city, state, country Contact details for the party the goods were sold to. All fields can be populated with type String. If this party is used, code is required  
Contact displayName Name of the person to receive the package, e.g. Attention To  

Note Types

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

Reference TypeAdditional FieldsDescriptionRequired
Comment1 value Comment1 used to display additional information in packing slip  
Comment2 value Comment2 used to display additional information in packing slip  
Comment3 value Comment3 used to display additional information in packing slip  
DeliveryInstructions value Delivery instructions for the order
Allows up to 500 characters
 

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
 

Order Types

Reference TypeTypeDescriptionRequired
N string Normal Order Default
I string Transfer stock between internal Warehouses  
D string Order to dispose of expired stock in the system  
O string Export or Overseas Order  

Freight Classes

Freight Class ValueWeight Range Per Cubic FootDescriptionCost
50 over 50 lbs – Clean Freight Fits on standard shrink-wrapped 4X4 pallet, very durable Lowest Cost
55 35-50 pounds Bricks, cement, mortar, hardwood flooring  
60 30-35 pounds Car accessories & car parts  
65 22.5-30 pounds Car accessories & car parts, bottled beverages, books in boxes  
70 Car accessories & car parts, food items, automobile engines 15 to 22.5 pounds  
77.5 13.5 to 15 pounds Tires, bathroom fixtures  
85 12-13.5 pounds Crated machinery, cast iron stoves  
92.5 10.5-12 pounds Computers, monitors, refrigerators  
100 9-10.5 pounds Boat covers, car covers, canvas, wine cases, caskets  
110 8-9 pounds Cabinets, framed artwork, table saw  
125 7-8 pounds Small Household appliances  
150 6-7 pounds Auto sheet metal parts, bookcases  
175 5-6 pounds Clothing, couches stuffed furniture  
200 4-5 pounds Auto sheet metal parts, aircraft parts, aluminium table, packaged mattresses  
250 3-4 pounds Bamboo furniture, mattress and box spring, plasma TV  
300 2-3 pounds wood cabinets, tables, chairs setup, model boats  
400 1-2 pounds Deer antlers  
500 Less than 1 lbs – Low Density or High Value Bags of gold dust, ping pong balls Highest Cost
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.