Order MCS webhooks

Order webhooks provide real-time notifications for your order status and shipment updates. Use these events to track order progress throughout the fulfillment lifecycle and maintain up-to-date order information in your systems.

Order status update

The ORDER_STATUS_UPDATE event provides updates when an order status changes during the fulfillment lifecycle. This event is sent when an order moves to one of these statuses: Acknowledged, Shipped, or Canceled.

Common use cases include:

Tracking order progress.
Synchronizing order status across systems.
Triggering operational workflows.

Sample webhook payload

The following example shows the payload structure returned when an order status update occurs.

{ "payload": { "partnerId": "string", "originSystemOrderId": "string", "orderChannelId": "string", "lineItemStatus": [ { "sellerLineId": "string", "itemDetail": { "sku": "string" }, "itemStatus": [ { "qty": 0, "status": "string", "statusDetail": "string", "reasonCode": "string", "reasonDetail": "string", "errors": [ { "code": "string", "field": "string", "description": "string", "info": "string", "severity": "string", "category": "string", "causes": [ { "code": "string", "field": "string", "description": "string", "type": "string" } ] } ] } ] } ], "shipmentDetails": [ { "actualShipmentDate": "string", "shipmentMethod": "string", "shipmentNo": "string" } ] }
}

Field descriptions

Field	Description
`eventType`	Type of webhook event that triggered the notification.
`eventTime`	Timestamp indicating when the event occurred.
`eventId`	Unique identifier for the webhook event.
`partnerId`	Unique identifier of the partner associated with the order.
`originSystemOrderId`	Customer order identifier.
`orderChannelId`	Identifier of the sales channel associated with the order.
`lineItemStatus`	Status details for each order line.
`sellerLineId`	Unique identifier of the order line.
`itemDetail`	Details about the item associated with the order line.
`sku`	Stock Keeping Unit (SKU) of the item.
`itemStatus`	Status information for items within the order line.
`qty`	Quantity associated with the item status.
`status`	Current status of the item.
`statusDetail`	Additional information about the item status.
`reasonCode`	Code indicating the reason for the status.
`reasonDetail`	Additional details about the reason for the status.
`errors`	List of errors associated with the order line or status update.
`code`	Error code.
`field`	Field associated with the error.
`description`	Description of the error.
`info`	Additional information about the error.
`severity`	Severity level of the error.
`category`	Category of the error.
`causes`	List of underlying causes associated with the error.
`shipmentDetails`	Shipment information associated with the order.
`actualShipmentDate`	Date when the shipment was sent or is scheduled to be sent.
`shipmentMethod`	Shipment method used to fulfill the order.
`shipmentNo`	Unique identifier of the shipment.

Order shipment update

The ORDER_SHIPMENT_UPDATE event provides updates when shipment information becomes available or changes for an order. Use this event to track shipment progress and capture carrier and tracking details in your systems.

This event is sent when shipment details are updated, including:

Tracking number assignment
Carrier information updates
Shipment status updates

Common use cases include:

Updating shipment tracking information in your order management system.
Triggering customer shipment notifications.
Monitoring shipment progress and delivery activity.

Sample webhook payload

The following example shows the payload structure returned when shipment information is updated.

{ "payload": { "partnerId": "string", "originSystemOrderId": "string", "orderChannelId": "string", "shipmentDetails": [ { "actualShipmentDate": "string", "shipmentMethod": "string", "shipmentNo": "string", "trackingNumber": "string", "carrier": "string", "shipmentItems": [ { "sellerLineId": "string", "itemDetail": { "sku": "string" }, "qty": 0 } ] } ], "orderType": "string", "purchaseOrderNo": "string", "returnReason": "string", "salesOrderLineNo": integer, "lineNo": integer, "measurementValue": integer, "unitOfMeasure": "string", "salesOrderLineId": integer, "faultCategory": "string", "legacySellerId": "string", "legacyItemId": "string", "offerId": "string", "partnerName": "string", "eventName": "string", "returnOrderNo": "string", "rcType": "string", "isZPL": boolean, "receivingNode": "string" }
}

Field descriptions

Field	Description
`trackingNumber`	Tracking number associated with the shipment.
`carrier`	Carrier responsible for delivering the shipment.
`shipmentItems`	List of items included in the shipment.
`orderType`	Type of order associated with the event.
`purchaseOrderNo`	Purchase order identifier.
`returnReason`	Reason associated with the return request.
`salesOrderLineNo`	Sales order line number associated with the item.
`lineNo`	Line number associated with the order or return.
`measurementValue`	Quantity value associated with the item.
`salesOrderLineId`	Unique identifier of the sales order line.
`faultCategory`	Category indicating responsibility for the return or issue.
`legacySellerId`	Legacy seller identifier associated with the offer.
`legacyItemId`	Legacy item identifier associated with the offer.
`offerId`	Unique identifier of the offer associated with the item.
`partnerName`	Name of the partner associated with the event.
`eventName`	Name of the return event.
`returnOrderNo`	Return order identifier.
`rcType`	Type of return line group.
`isZPL`	Indicates whether the return label is provided in ZPL format.
`receivingNode`	Identifier of the node designated to receive the return shipment.

Order status update

Sample webhook payload

Field descriptions

Order shipment update

Sample webhook payload

Field descriptions

Related links