Order Confirmation Webhook

 Response Parameters

ParameterDescriptionTypeLength
orderConfirmation Order confirmation details object  
publicID Publid ID of the order uniqueidentifier  
etaDate Estimated date that the order needs to be dispatched by Format yyy-MM-dd date  
repCode General purpose use field, discuss usage with the integration team string 50
orderType Order type list of available types can be found here string 50
repName General purpose use field, discuss usage with the integration team string 50
freightCharge Freight charge amount for the order decimal  
taxAmount Tax amount charge for the order decimal  
pallets Number of pallets required for the order integer  
weight Total weight for the order decimal  
volume Total volume of the order decimal  
invoiceNetAmount Invoiced amount charged for the order decimal  
vipEmailAddress VIP email notification email address string 500
customStockStatusCode Customer stock status string 50
urgent Indicates that the order is Urgent bool  
dutyFree Indicates that the order is Duty Free bool  
timeslotRequired Indicated if a booking timeslot is required bool  
booking Booking details object  
bookingFromDate Booking from date used for booking with Mainfreight Transport Format yyyy-MM-dd HH:mm:ss dateTime  
bookingToDate Booking to date used for booking with Mainfreight Transport Format yyyy-MM-dd HH:mm:ss dateTime  
bookingReference Booking reference value string 20
bookingComment Booking comment value string 50
miscCharge Miscellaneous charge amount for ordered product decimal  
requiredDate Required date that order needs to be dispatched by Format yyyy-MM-dd date  
ServiceProvider The service provider that will transport the order object  
name The name of the service provider, e.g. Mainfreight string 50
callRequired Indicates that a call is required to confirm the booking time bool  
routeType The order route type string 50
hirePallets The number of hire pallets used int  
externalReferences External references, list of available of external reference types can be found here object  
externalSystem External system object  
code External system code string 50
references List of references object  
reference Reference line object  
referenceType External reference types, list of available types can be found here string 50
value Line External References Type, list of available of types can be found here string 50
orderDate The date of order creation. Format yyyy-MM-dd HH:mm:ss datetime  
dateDispatched Date that order is dispatched Format yyyy-MM-dd date  
orderLineTotal Total number of items integer  
packagesSent Total numer of packages integer  
packTypeSent Pack Type sent string 50
consignments List of consignments for the order object  
consignment Consignment details object  
consignmentNumber Consignment number string 50
consignmentDate Date of consignment date  
weight Total consigment Weight decimal  
volume Total consigment Volume decimal  
volumeUnit Volume unit of measure string 50
weightUnit Weight unit of measure string 50
chargeCode Customer charge account string 50
senderCode Sender change account string 50
consignmentLines List of consignment lines object  
consignmentLine Line detail for consignment object  
labelNumber Label number string 50
items Number of items int  
weight Weight of items decimal  
volume Volume of items decimal  
description Description of items string 50
hireEquipment Hire equipment details object  
hireEquipmentLine Hire equipment line object  
hireCompany Hire company object  
partyType Hire company code string 50
displayName Hire company name string 50
fromAccount Hire from account object  
type Hire from account type string  
accountNumber Hire from account number string  
toAccount Hire to account object  
type Hire to account type string  
accountNumber Hire to account number string  
hireType Hire type details object  
code Hire type code string  
description Hire type description string  
equipmentType Hire equipment type details object  
code Hire equipment type code string  
description Hire equipment type description string  
warehouse The warehouse involved in the order object  
code Warehouse code for this order string 50
receiverGroup General purpose field to group Receivers that have the same business rules, e.g. Documentation object  
code Receiver group code string  
customer Customer involved in the Order object  
code Shorthand code to identify the customer string 50
soldTo Sold to details object  
address1 Hire company address string 50
address2 Hire company address string 50
country Country for the party the goods were sold to address string 50
name The name of the party the goods were sold to. string 50
phone The phone number of the party the goods were sold to string 50
place City/Place for the party the goods were sold to address string 50
postCode PostCode/Zip for the party the goods were sold to address string 50
code Shorthand code to identify the party the goods were sold to. string 50
state State for the party the goods were sold to address string 50
suburb Suburb for the party the goods were sold to address string 50
receiver Receiver contact details object  
address1 Street address string 50
address2 Additional street address details string 50
country Country for the Receiver address string 50
name The name of the Receiver string 50
phone The phone number of the receiver string 50
place City/Place for the Receiver address string 50
postCode PostCode/Zip for the Receiver address string 50
code Shorthand code to identify the receiver string 50
state State for the Receiver address string 50
suburb Suburb for the Receiver address string 50
transferWarehouse Transfer warehouse details object  
code Shorthand code to identify the transfer warehouse string 50
charge Charge account details object  
code Charge Code string 50
consigneeDeliveryLocation Consignee delivery location code string 50
sender Sender contact details object  
code Sender code string 50
name The name of the sender string 50
address1 Street address string 50
address2 Additional street address details string 50
suburb Suburb for the sender address string 50
postCode PostCode/Zip for the sender address string 50
place City/Place for the sender address string 50
state State for the sender address string 50
country Country for the sender address string 50
phone The phone number of the sender string 50
contact Contact name for the party the goods were sold to object  
code Shorthand code to identify the sold to contact string 50
orderReference Your unique order reference identifying the Order string 50
customerOrderReference Your customer reference for the order string 50
receiverReference Receiver reference string 50
carrierReference Carrier reference string 50
crossDocReference Cross dock reference string 50
pickNumber Mainfreight pick number int  
consignmentNumber Consignment number string 50
deliveryInstructions Delivery instructions for the order string 500
comment1 Comment1 used to display additional information in packing slip string 50
comment2 Comment2 used to display additional information in packing slip string 50
comment3 Comment3 used to display additional information in packing slip string 50
orderConfirmationLines List of confirmation lines object  
orderConfirmationLine Confirmation line details array  
lineNo Line number int  
units Line units int  
backOrderUnits Units on back order int  
unitsSent Units sent int  
retailPrice Retail price decimal  
discountPrice Dicsount price decimal  
costPrice Cost price decimal  
extendedPrice Extended price decimal  
miscChargeAmount Miscellaneous charge description decimal  
miscChargeDisplayName Miscellaneous charge description string 50
receiverStockCode Receiver stock code string 50
receiverStockDisplayName Receiver stock name string 50
packType Pack type string 50
weight Line weight decimal  
volume Line volume decimal  
contingencyPrice Contingency price decimal  
freightClass Freight class string 50
kitsetCode Kistset code string 50
product Product detail object  
code Product code string 50
displayName Product name string 50
alternativeDisplayName Product alternative name string 50
packTypes List of product pack types object  
packType Pack type details array  
barCode Barcode string 50
type Pack type code(Carton, Inner, Each) string 50
notes Pack line note object  
note List of notes array  
noteType Type of note(DeliveryInstructions, Comment1, Comment2, Comment3) string 50
value Note value(Instructions, EDIComment1, EDIComment2, EDIComment3) string 50
externalReferences External references, list of available of external reference types can be found here object  
externalSystem External system object  
code External syste code string 50
references List of references object  
reference Reference line object  
referenceType External reference types, list of available types can be found here string 50
value Line External References Type, list of available of types can be found here string 50
destinations Need to be investigated further    
weightCaptured Weigh captured decimal  
packaging Packaing details object  
externalSystem External System string 50
reference Reference string 50
packs Packs on the confirmation object  
pack Pack details array  
ssccNumber SSCC Number string 50
licensePlateNumber Lincense plate number string 50
destination Destination object  
code Destination code string 50
consignmentNumber Consignment number string 50
weight Pack weight decimal  
volume Pack volume decimal  
packLines List of pack lines object  
packLine Pack line details array  
actualUnits Pack line actual units int  
actualUnitsOfMeasure Pack line actual units unit of measure string 50
requestedUnits Pack line requested units int  
requestedUnitsOfMeasure Pack line requested units unit of measure string 50
product Product object  
code Product code string 50
attributes Attributes of the product object  
attribute Attribute detail object  
attributeType Type of the attribute string 50
value Attribute value string 50
grade1 Line grade1 string 50
grade2 Line grade2 string 50
grade3 Line grade3 string 50
expiryDate Line expiry date date  
packingDate Line packing date date  
underBond Line under bond string 5
outboundSerial Outbound serial number string 100

 

Code Sample

JSON example

Coming soon...

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.

Copyright © 2024