orderCreated event
The orderCreated event provides basic order information, order lines,
and order line statuses. It is published when a confirmed order is created or when a draft order is
confirmed.
Event schema
See the following
orderCreated event schema as an
example:[
{
"specversion": "1.0",
"type": "orderCreated",
"id": "orderCreated-<timestamp>-<random>",
"time": "ISO-8601 datetime",
"datacontenttype": "application/json",
"tenantid": "string",
"data": {
"orderHeaderKey": "string",
"orderNo": "string",
"enterpriseCode": "string",
"documentType": "string",
"sellerOrganizationCode": "string",
"orderDate": "ISO-8601 datetime",
"entryType": "string",
"status": "string",
"paymentStatus": "string",
"shipToKey": "string",
"shipNode": "string",
"carrierServiceCode": "string",
"modifyts": "ISO-8601 datetime",
"priceInfo": {
"totalAmount": "decimal",
"currency": "string"
},
"orderLines": [
{
"orderLineKey": "string",
"orderHeaderKey": "string",
"primeLineNo": "string",
"subLineNo": "string",
"orderedQty": "decimal",
"status": "string",
"deliveryMethod": "string",
"reqShipDate": "ISO-8601 datetime",
"reqDeliveryDate": "ISO-8601 datetime",
"carrierServiceCode": "string",
"modifyts": "ISO-8601 datetime",
"item": {
"itemID": "string",
"itemDesc": "string",
"itemShortDesc": "string",
"productClass": "string",
"productLine": "string",
"unitOfMeasure": "string",
"unitCost": "decimal",
"upcCode": "string",
"supplierItem": "string",
"supplierItemDesc": "string",
"taxProductCode": "string",
"scheduleBCode": "string"
},
"personInfoShipTo": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string"
},
"customAttributes": [
{
"<attributeName>": "value",
"dataType": "TEXT|INTEGER|DECIMAL|DATE|BOOLEAN"
}
],
"schedules": [
{
"orderLineScheduleKey": "string",
"orderHeaderKey": "string",
"orderLineKey": "string",
"scheduleNo": "string",
"quantity": "decimal",
"shipNode": "string",
"receivingNode": "string",
"procureFromNode": "string",
"mergeNode": "string",
"expectedShipmentDate": "ISO-8601 datetime",
"expectedDeliveryDate": "ISO-8601 datetime",
"shipByDate": "ISO-8601 datetime",
"productAvailabilityDate": "ISO-8601 datetime",
"batchNo": "string",
"lotNumber": "string",
"revisionNo": "string",
"tagNumber": "string",
"modifyts": "ISO-8601 datetime"
}
],
"orderStatuses": [
{
"orderReleaseStatusKey": "string",
"orderHeaderKey": "string",
"orderLineKey": "string",
"orderLineScheduleKey": "string",
"orderReleaseKey": "string",
"status": "string",
"statusDescription": "string",
"statusDate": "ISO-8601 datetime",
"statusQty": "decimal",
"totalQuantity": "decimal",
"statusReason": "string",
"pipelineKey": "string",
"shipNode": "string",
"receivingNode": "string",
"modifyts": "ISO-8601 datetime",
"details": {
"shipNode": "string",
"receivingNode": "string",
"expectedShipmentDate": "ISO-8601 datetime",
"expectedDeliveryDate": "ISO-8601 datetime",
"shipByDate": "ISO-8601 datetime",
"overrideItemID": "string",
"overrideProductClass": "string",
"overrideUnitOfMeasure": "string",
"tagNumber": "string",
"modifyts": "ISO-8601 datetime"
}
}
],
"orderDates": [
{
"orderHeaderKey": "string",
"orderLineKey": "string",
"orderReleaseKey": "string",
"dateTypeId": "string",
"requestedDate": "ISO-8601 datetime",
"expectedDate": "ISO-8601 datetime",
"committedDate": "ISO-8601 datetime",
"actualDate": "ISO-8601 datetime"
}
],
"linePriceInfo": {
"unitPrice": "decimal",
"listPrice": "decimal",
"retailPrice": "decimal",
"lineTotal": "decimal",
"invoicedLineTotal": "decimal",
"pricingUOM": "string",
"repricingQty": "decimal",
"taxableFlag": "Y|N"
},
"lineOverallTotals": {
"lineTotal": "decimal",
"lineTotalWithoutTax": "decimal",
"unitPrice": "decimal",
"tax": "decimal",
"charges": "decimal",
"discount": "decimal",
"shippingCharges": "decimal",
"shippingDiscount": "decimal",
"shippingTotal": "decimal"
}
}
]
}
}
]