Order Confirmation Webhook

 Response Parameters

ParameterDescriptionTypeLength
orderConfirmation   Object  
repCode General purpose use field, discuss usage with the integration team string  
repName General purpose use field, discuss usage with the integration team string  
orderDate The date of order creation string  
requiredDate

Required date that order needs to be dispatched by
Format yyyy-MM-dd

date  
dateDispatched Date that order is dispatched
Format yyyy-MM-dd
date  
orderLineTotal ** integer  
miscCharge Miscellaneous charge amount for ordered product decimal  
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  
etaDate

Estimated date that the order needs to be dispatched by

Format yyy-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
isTimeslotRequired ** string  
bookingFromDateTime Booking from date used for booking with Mainfreight Transport Format yyyy-MM-dd HH:mm:ss dateTime  
bookingToDateTime 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 
vipEmailAddress VIP email notification email address string  500
packagesSent ** integer  
packTypeSent ** string  
orderType Order type list of available types can be found here string  
hirePallets ** int  
isUrgent ** bool  
isDutyFree ** bool  
callRequired Indicates that a call is required to confirm the booking time bool  
senderCode Sender code string  
chargeCode Charge code string  
consigneeDeliveryLocation ** string  
routeType ** string  
warehouse The warehouse involved in the Order Object  
code Shorthand code to identify the warehouse string  
contact contact name for the party the goods were sold to  Object  
displayName ** string  
receiverGroup General purpose field to group Receivers that haev the same business rules, e.g. Documentation array  
customer Customer involved in the Order array  
code Shorthand code to identify the customer string  
sender ** Object  
code Sender code string  
receiver Receiver contact details Object  
address1 Street address string  
address2 Additional street address details string  
code Shorthand code to identify the receiver string  
country Country for the Receiver address string  
name The name of the Receiver string  
phone The phone number of the receiver string  
place City/Place for the Receiver address string  
postCode PostCode/Zip for the Receiver address string  
state State for the Receiver address string  
suburb Suburb for the Receiver address string  
soldTo Contact details for the party the goods were sold to. If this party is used, code is required Object  
address1 Street address string 50
address2 Additional street address details string 50
code Shorthand code to identify the party the goods were sold to. 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
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
contact contact name for the party the goods were sold to string 50
orderReference Your unique order reference identifying the Order string 50
customerOrderReference Your customer reference for the order string 50
pickNumber ** string  
carrierReference Not required in your request. Carrier Reference is populated when finalising/despatching your order string  
consignmentNumber ** string  
asnReference ** string  
deliveryInstructions Delivery instructions for the order string  500
comment1 Comment1 used to display additional information in packing slip string  
comment2 Comment2 used to display additional information in packing slip string  
comment3 Comment3 used to display additional information in packing slip string  
externalReferences external reference's, list of available of external reference types can be found here Object  
externalSystem ** Object  
code ** string  
references ** Object  
reference ** Object  
referenceType External reference types, list of available types can be found here string  
value Line External References Type, list of available of types can be found here string  
consignments ** Object  
consignmentNumber ** string  
consignmentDate ** string  
weight ** string  
volume ** string  
volumeUnit ** string  
weightUnit ** string  
chargeCode ** string  
senderCode ** string  
consignmentLines ** Object  
consignmentLine ** Object  
labelNumber ** string  
items ** string  
description ** string  
weight ** string  
volume ** string  
hireEquipment ** Object  
hireEquipmentLine ** Object  
hireCompany ** Object  
code ** string  
displayName ** string  
address1 ** string  
address2 ** string  
suburb ** string  
postCode ** string  
place ** string  
state ** string  
country ** string  
phone ** string  
fromAccount ** Object  
type ** string  
accountNumber ** string  
toAccount ** Object  
type ** string  
accountNumber ** string  
hireType ** Object  
code ** string  
description ** string  
equipmentType ** Object  
code ** string  
description ** string  
quantity ** string  
orderConfirmationLines ** Object  

 

Code Sample

JSON example


"id": "9AF73944-F61F-4338-B5E6-F8E3164F3899",
"metadata": {
"subscriptionId": "D38ED4B4-6846-4ED1-97E5-ABC8400D6ED8",
"subscriptionTransportEventId": "C6C6207B-0E8A-4650-9E26-A0B6A1075C15",
"eventTypeCode": "WarehousingConfirmation",
"serviceTypeCode": "WarehousingUs",
"referenceTypeCode": "OutboundReference",
"eventCode": "OrderComplete"
},
"content": {
"reference": {
"publicID": "6A5760B1-097D-4273-962C-3156DE332502",
"etaDate": "1900-01-01 00:00:00",
"repCode": null,
"orderType": "N",
"repName": null,
"freightCharge": "16.06",
"taxAmount": "0.00",
"weight": "1.40",
"volume": "0.32",
"invoiceNetAmount": "0.000",
"vipEmailAddress": null,
"customStockStatusCode": null,
"urgent": "false",
"dutyFree": "false",
"timeslotRequired": "false",
"booking": {
"bookingFromDate": "1900-01-01",
"bookingToDate": "1900-01-01",
"bookingReference": null,
"bookingComment": null
},
"miscCharge": "0.00",
"requiredDate": "2020-10-23",
"serviceProvider": {
"serviceLevel": {
"description": "FEDEX SECOND DAY"
},
"description": "FEDEX",
"scacCode": "FDEG"
},
"callRequired": "false",
"routeType": null,
"orderDate": "2020-10-21 00:00:00",
"dateDispatched": "2020-10-21 00:00:00",
"orderLineTotal": "2",
"packagesSent": "1",
"packTypeSent": "CARTON",
"hireEquipment": null,
"warehouse": {
"code": "34"
},
"receiverGroup": {
"code": null
},
"customer": {
"code": "4406440"
},
"soldTo": {
"address1": null,
"address2": null,
"country": null,
"name": null,
"phone": null,
"place": null,
"postCode": null,
"code": null,
"state": null,
"suburb": null
},
"receiver": {
"address1": "1357 Fairfield Dr",
"address2": null,
"country": "United States",
"name": "John Smith",
"phone": "+1 900-123-1234",
"place": "IRVING",
"postCode": "8008",
"code": "526476",
"state": "FLORIDA",
"suburb": null
},
"transferWarehouse": {
"code": null
},
"charge": {
"code": "599048723"
},
"consigneeDeliveryLocation": null,
"sender": {
"code": "1641113",
"name": "Sender",
"address1": "1 Worcester Street",
"address2": null,
"suburb": null,
"postCode": "02141",
"place": "CAMBRIDGE",
"state": "MASSACHUSETTS",
"country": "MASSACHUSETTS",
"phone": null
},
"contact": {
"code": null
},
"orderReference": "1234",
"customerOrderReference": "6548021ZX87",
"receiverReference": null,
"carrierReference": "51088ASDXAS5",
"crossDocReference": null,
"pickNumber": "684181",
"consignmentNumber": "648244846210",
"deliveryInstructions": "Leave at the front door",
"comment1": null,
"comment2": null,
"comment3": null,
"orderConfirmationLines": {
"orderConfirmationLine": {
"lineNo": "1",
"units": "2",
"backOrderUnits": "0",
"unitsSent": "0",
"retailPrice": "0.00",
"discountPrice": "0.00",
"costPrice": "0.00",
"extendedPrice": "0.00",
"miscChargeDisplayName": null,
"receiverStockCode": null,
"receiverStockDisplayName": null,
"packType": null,
"weight": "2.800",
"volume": "1.200",
"contingencyPrice": "0.00",
"freightClass": null,
"kitsetCode": "MP2020",
"product": {
"code": "MP2020",
"description": "Box",
"alternativeDisplayName": null,
"packTypes": {
"packType": [{
"barCode": null,
"type": "Each"
}, {
"barCode": null,
"type": "Inner"
}, {
"barCode": null,
"type": "Carton"
}
]
}
},
"notes": {
"note": {
"noteType": "Note",
"value": null
}
},
"grade1": null,
"grade2": null,
"grade3": null,
"expiryDate": null,
"packingDate": null,
"underBond": null,
"outboundSerial": null
}
}
}
}
}

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.