shipmentModified event
When a Shipment is created or modified, the shipment details are published as a
shipmentModified event. The same event is raised for shipment status change as
well.
Event schema
See the following shipmentModified event schema as an example:
[
{
"specversion": "1.0",
"type": "shipmentModified",
"id": "shipmentModified-<timestamp>-<random>",
"time": "ISO-8601 datetime",
"datacontenttype": "application/json",
"tenantid": "string",
"data": {
"shipmentKey": "string",
"shipmentNo": "string",
"orderHeaderKey": "string",
"orderNo": "string",
"enterpriseCode": "string",
"documentType": "string",
"releaseNo": "string",
"status": "string",
"shipNode": "string",
"deliveryMethod": "string",
"isSingleOrder": "Y|N",
"requestedShipmentDate": "ISO-8601 datetime",
"expectedShipmentDate": "ISO-8601 datetime",
"actualShipmentDate": "ISO-8601 datetime",
"requestedDeliveryDate": "ISO-8601 datetime",
"expectedDeliveryDate": "ISO-8601 datetime",
"requestedCarrierServiceCode": "string",
"carrierServiceCode": "string",
"scac": "string",
"trackingNo": "string",
"totalWeight": "decimal",
"totalWeightUOM": "string",
"totalVolume": "decimal",
"totalVolumeUOM": "string",
"totalCharges": "decimal",
"modifyts": "ISO-8601 datetime",
"toAddress": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string"
},
"fromAddress": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string"
},
"shipmentLines": [
{
"shipmentLineKey": "string",
"shipmentKey": "string",
"orderHeaderKey": "string",
"orderLineKey": "string",
"orderNo": "string",
"releaseNo": "string",
"itemID": "string",
"itemDesc": "string",
"productClass": "string",
"unitOfMeasure": "string",
"quantity": "decimal",
"overShipQuantity": "decimal",
"shortageQty": "decimal",
"backroomPickedQty": "decimal",
"backroomPickComplete": "string",
"shipmentLineInvAttRequest": {
"batchNo": "string",
"lotNumber": "string",
"lotKeyReference": "string",
"lotAttribute1": "string",
"lotAttribute2": "string",
"lotAttribute3": "string",
"manufacturingDate": "ISO-8601 datetime",
"revisionNo": "string"
}
}
],
"containers": [
{
"shipmentContainerKey": "string",
"shipmentKey": "string",
"containerNo": "string",
"containerSeqNo": "string",
"containerType": "string",
"containerGroup": "string",
"containerScm": "string",
"trackingNo": "string",
"scac": "string",
"isHazmat": "Y|N",
"actualWeight": "decimal",
"actualWeightUOM": "string",
"appliedWeight": "decimal",
"containerGrossWeight": "decimal",
"containerGrossWeightUOM": "string",
"containerNetWeight": "decimal",
"containerNetWeightUOM": "string",
"containerLength": "decimal",
"containerLengthUOM": "string",
"containerWidth": "decimal",
"containerWidthUOM": "string",
"containerHeight": "decimal",
"containerHeightUOM": "string",
"actualFreightCharge": "decimal",
"actualNoOfReturnLabels": "integer",
"containerDetails": [
{
"containerDetailsKey": "string",
"shipmentContainerKey": "string",
"shipmentKey": "string",
"shipmentLineKey": "string",
"itemID": "string",
"productClass": "string",
"unitOfMeasure": "string",
"quantity": "decimal",
"shipmentTagSerials": [
{
"shipmentTagSerialKey": "string",
"shipmentLineKey": "string",
"containerDetailKey": "string",
"serialNo": "string",
"quantity": "decimal",
"batchNo": "string",
"lotNumber": "string",
"lotKeyReference": "string",
"lotAttribute1": "string",
"lotAttribute2": "string",
"lotAttribute3": "string",
"manufacturingDate": "ISO-8601 datetime",
"revisionNo": "string",
"shipByDate": "ISO-8601 datetime"
}
],
"shipmentLine": {
"orderNo": "string",
"documentType": "string",
"releaseNo": "string",
"primeLineNo": "string",
"subLineNo": "string",
"shipmentLineNo": "string",
"shipmentSubLineNo": "string",
"itemDesc": "string",
"isHazmat": "Y|N",
"shipmentLineInvAttRequest": {
"batchNo": "string",
"lotNumber": "string",
"lotKeyReference": "string",
"lotAttribute1": "string",
"lotAttribute2": "string",
"lotAttribute3": "string",
"manufacturingDate": "ISO-8601 datetime",
"revisionNo": "string"
}
}
}
]
}
]
}
}
]