There are actually two different notifications included in the Order Item Modification topic – one logging any updates of an order item as expected, the other specifically triggering when an order item is cancelled. These notifications are sent for any order type (Ship-to-Home, Ship-to-Store, In-Store Pickup, etc.).
- Order Item Modification Notification – Sent when the quantity, tax, or price of an order item on an unfulfilled order are modified, either via API or the CCUI interface. This notification details the updated quantity, tax, and price of the order as well as other order and shipment information.
- Cancel Order Item Notification – Sent when an individual item is canceled from an order. This is the same as the Cancel Order Item Notification listed under the Shipment Status topic.
Order Item Modification Notification Parameters
This notification will include all of the updated information of the order item data block.
| Field | Type | Parent | Description |
| orderID | integer | The identifier of the order created. | |
| externalOrderID | string | Client-generated unique identifier for the order sent to Kibo. | |
| externalLocationID | string | The fulfiller’s identifier for the location. | |
| locationName | string | The name of the location. | |
| reasonCode | integer | The code explaining why the order is being changed. | |
| reasonDescription | string | The human-readable explanation for why the order is being changed. | |
| eventTypeID | string | Always shown as “OrderItemModificationEvent”. | |
| orderType | string | The type of the order, such as “IN_STORE_PICKUP” | |
| data | object | Information on each line-item affected by this modification. | |
| itemID | integer | data | The item’s identifier. |
| shipmentID | integer | data | The identifier for the shipment this line item belongs to. |
| partNumber | integer | data | The part number of the line-item that has been modified. |
| upc | string | data | The upc code for the line-item that has been modified. |
| sku | string | data | The sku code for the line-item that has been modified. |
| quantity | integer | data | The quantity of the line-item that has been modified. |
| actualPrice | number | data | The actual price of the line-item. |
| itemTaxAmount | number | data | The tax amount of the item. |
| itemTaxRate | number | data | The tax rate applied to the item. |
| reasonCode | integer | data | The code explaining why the order item is being changed. |
| reasonDescription | string | data | The human-readable explanation for why the order item is being changed. |
This example shows a standard Order Item Modification Notification.
{
"orderID": "0000000",
"externalOrderID": null,
"externalLocationID": "1111111",
"locationName": "Example Location",
"eventTime": "2018-11-16 19:11:10",
"reasonCode": "",
"reasonDescription": "",
"eventTypeID": "OrderItemModificationEvent",
"orderType": null,
"data": [
{
"itemID": 111222333,
"shipmentID": "333222111",
"partNumber": "LoadTestingPart1",
"upc": "LoadTestingPart1",
"sku": null,
"quantity": "1",
"actualPrice": "2.00",
"itemTaxAmount": null,
"itemTaxRate": null,
"reasonCode": null,
"reasonDescription": null
}
],
"scope": {
"mfgID": "10101",
"catalogID": "19",
"fulfillerID": "01010"
}
}