Record order activities
A wide range of events — order and shipment status updates, payments, and promotions — are automatically recorded for each order. Users can view them in the Order notes section of the order management view.
OrderActivity logs order activities from the order management view (CSR). Order activity recording is built on the OrderNote feature. The OrderActivityEvent enum defines events that are recorded when an Order is processed, and the IOrderActivity interface extends IOrderNote.
When you process an Order, activities are automatically recorded to the OrderNote collection. The OrderGroup's OrderNote collection contains both OrderNote and OrderActivity entries. You can add custom OrderNote entries in the order management view. These are of the Custom note type, whereas an OrderActivity is a System note that cannot be updated or deleted.
OrderActivityEvent enum
This defines the event types that are recorded for OrderActivity.
- OrderGroupCreated – Optimizely creates a purchase order.
- OrderGroupOnHold – The order is on hold.
- OrderGroupCompleted – Optimizely completes the order.
- OrderGroupInProgress – The order is in progress.
- OrderGroupCancelled – Optimizely cancels the order.
- ShipmentAwaitingInventory – The shipment is waiting for inventory.
- ShipmentCancelled – Optimizely cancels the shipment.
- ShipmentPacking – Optimizely adds the shipment to the pick list.
- ShipmentReleased – Optimizely releases the shipment.
- ShipmentShipped – Optimizely ships the shipment.
- ReturnCreated – Optimizely creates a return.
- AddingPayment – Optimizely adds a payment.
- CreatingRefund – Optimizely creates a refund for the order.
- ReturnReceiptItems – Optimizely receives the return.
- PromotionAddCoupon – Optimizely adds a coupon code.
- PromotionManualDiscount – Optimizely adds a manual discount.
- PromotionRemoveCoupon – Optimizely removes the coupon code.
- None – None.
IOrderActivity interface
IOrderActivity extends from IOrderNote.
Item | Data type | Description |
|---|---|---|
EventType | OrderActivityEvent | The event type defined in the OrderActivityEvent enum. |
Channel | string | The channel of the order activity, for example, the order management view. |
Load OrderActivity for OrderGroup
OrderGroup, OrderActivity, and OrderNote are loaded in the OrderNotes property.