Order
This section provides an overview of the Order message types, which vendors can retrieve from Amazon SQS. It notifies vendors about order information in the system.
Order Created
The order created message alerts vendors when a new job is created in the system. The messageType here will be OrderCreated.
Triggers
The order created message is triggered when a new order is created in the system through our Job Intent Receiver API.
This message can also be triggered when an order is created manually via the Ariel UI.
Possible Statuses
Level | Status Values |
|---|---|
Job |
|
Order |
|
Sample Message
Order Updated
The order updated message alerts vendors when an order has been updated. The messageType here will be OrderUpdated.
Triggers
The order updated message is triggered when an existing order is updated in the system through our Job Intent Receiver API.
This message can also be triggered when an order is updated manually via the Ariel UI.
Possible Statuses
Level | Status Values |
|---|---|
Job |
|
Order |
|
Sample Message
Order Completed
The order completed message alerts vendors when an order is completed in the system. The messageType here will be OrderCompleted.
Triggers
The order completed message is triggered when an existing order is completed in the system through a call to Complete an Order.
Possible Statuses
Level | Status Values |
|---|---|
Job |
|
Order |
|
Sample Message
Void Order
The void order message alerts vendors when an order has been voided. The messageType here will be VoidOrder.
Triggers
The void order message is triggered when an existing order is voided in the system through our Job Intent Receiver API.
This message can also be triggered when an order is voided manually via the Ariel UI.
Possible Statuses
Level | Status Values |
|---|---|
Job |
|
Order |
|