Ariel API Docs Help

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

submitted

Order

submitted

Sample Message

{ "originationSystem": "ursula", "messageType": "OrderCreated", "messageDate": "2025-08-27T19:06:17.462292291Z", "traceId": "a0fc1b85-8bb4-41c9-a33e-961e35cb64c8", "payload": { "createdDate": "2025-08-27T15:25:38.514Z", "modifiedDate": "2025-08-27T19:06:15.682Z", "entityId": "aedd6baa-a00e-4add-8beb-d660b1a5f720", "jobName": "Bones: Season 1", "jobKey": "AOR-3170", "jobType": "dub", "vendor": { "vendorName": "Dubbing Brothers", "vendorCode": "DBFR" }, "container": { "containerId": "b779ad52-f1eb-4366-98ed-4df4c9bb0efc", "containerName": "Bones: Season 1", "radarProductId": 197699, "type": "season" }, "status": "submitted", "orders": [ { "orderId": "a51908ec-c864-473e-8af8-925db0443ddb", "orderNumber": 13457, "containers": [ { "containerId": "0d7a06e3-9bfb-43c7-a4b7-aef6ecd90bf9", "containerName": "Pilot", "eidrL1": "10.5240/E87F-7B47-0F55-A892-E17C-4", "radarProductId": 197700, "sequenceNumber": "1", "type": "episode" }, { "containerId": "8d5d8b2d-f579-4cc7-bafb-ad871325abad", "containerName": "Man in the Fallout Shelter, The", "eidrL1": "10.5240/5035-EAF7-9252-9812-DFFA-Y", "radarProductId": 220197, "sequenceNumber": "9", "type": "episode" } ], "language": { "languageName": "Catalan", "languageCode": "ca" }, "territory": { "territoryName": "Spain" }, "dubbingTechnique": "lip sync", "status": "submitted", "dubbingStudio": { "studioId": "83361967-44bc-426e-ac21-080e585440f3", "studioName": "Dubbing Brothers", "studioCode": "DBFR" } } ] } }

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

submitted

Order

submitted

Sample Message

{ "originationSystem": "ursula", "messageType": "OrderUpdated", "messageDate": "2025-09-09T23:06:54.949065Z", "traceId": "53e42784-b660-4b6e-b5d7-2857b054ff88", "payload": { "createdDate": "2025-08-27T15:25:38.514Z", "modifiedDate": "2025-09-09T22:35:39.056Z", "entityId": "aedd6baa-a00e-4add-8beb-d660b1a5f720", "jobName": "Bones: Season 1", "jobKey": "AOR-3170", "jobType": "dub", "vendor": { "vendorName": "Dubbing Brothers", "vendorCode": "DBFR" }, "container": { "containerId": "b779ad52-f1eb-4366-98ed-4df4c9bb0efc", "containerName": "Bones: Season 1", "radarProductId": 197699, "type": "season" }, "status": "submitted", "orders": [ { "orderId": "0f040d74-00fb-4a80-9273-d9b05d1d5b0b", "orderNumber": 18158, "containers": [ { "containerId": "0d7a06e3-9bfb-43c7-a4b7-aef6ecd90bf9", "containerName": "Pilot", "eidrL1": "10.5240/E87F-7B47-0F55-A892-E17C-4", "radarProductId": 197700, "sequenceNumber": "1", "type": "episode" } ], "language": { "languageName": "Catalan", "languageCode": "ca" }, "territory": { "territoryName": "Spain" }, "dubbingTechnique": "lip sync", "status": "submitted", "dubbingStudio": { "studioId": "83361967-44bc-426e-ac21-080e585440f3", "studioName": "Dubbing Brothers", "studioCode": "DBFR" } } ] } }

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

submitted, complete

Order

completed

Sample Message

{ "originationSystem": "ursula", "messageType": "OrderCompleted", "messageDate": "2025-09-09T23:29:29.900050Z", "traceId": "3730a142-32d6-4c7d-a8a9-1fa04be494af", "payload": { "createdDate": "2025-08-27T15:25:38.514Z", "modifiedDate": "2025-09-09T23:23:26.909Z", "entityId": "aedd6baa-a00e-4add-8beb-d660b1a5f720", "jobName": "Bones: Season 1", "jobKey": "AOR-3170", "jobType": "dub", "vendor": { "vendorName": "Dubbing Brothers", "vendorCode": "DBFR" }, "container": { "containerId": "b779ad52-f1eb-4366-98ed-4df4c9bb0efc", "containerName": "Bones: Season 1", "radarProductId": 197699, "type": "season" }, "status": "submitted", "orders": [ { "orderId": "0f040d74-00fb-4a80-9273-d9b05d1d5b0b", "orderNumber": 18158, "containers": [ { "containerId": "0d7a06e3-9bfb-43c7-a4b7-aef6ecd90bf9", "containerName": "Pilot", "eidrL1": "10.5240/E87F-7B47-0F55-A892-E17C-4", "radarProductId": 197700, "sequenceNumber": "1", "type": "episode" } ], "language": { "languageName": "Catalan", "languageCode": "ca" }, "territory": { "territoryName": "Spain" }, "dubbingTechnique": "lip sync", "status": "completed", "dubbingStudio": { "studioId": "83361967-44bc-426e-ac21-080e585440f3", "studioName": "Dubbing Brothers", "studioCode": "DBFR" } } ] } }

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

submitted

Order

voided

Sample Message

{ "originationSystem": "ursula", "messageType": "VoidOrder", "messageDate": "2025-09-09T23:19:06.638692Z", "traceId": "bb19e82b-e570-40dd-8710-cac0ff464e6b", "payload": { "createdDate": "2025-08-27T15:25:38.514Z", "modifiedDate": "2025-09-09T23:17:48.432Z", "entityId": "aedd6baa-a00e-4add-8beb-d660b1a5f720", "jobName": "Bones: Season 1", "jobKey": "AOR-3170", "jobType": "dub", "vendor": { "vendorName": "Dubbing Brothers", "vendorCode": "DBFR" }, "container": { "containerId": "b779ad52-f1eb-4366-98ed-4df4c9bb0efc", "containerName": "Bones: Season 1", "radarProductId": 197699, "type": "season" }, "status": "submitted", "orders": [ { "orderId": "f0e806a6-78c8-44cf-9193-77feb0107aeb", "orderNumber": 13452, "containers": [ { "containerId": "0d7a06e3-9bfb-43c7-a4b7-aef6ecd90bf9", "containerName": "Pilot", "eidrL1": "10.5240/E87F-7B47-0F55-A892-E17C-4", "radarProductId": 197700, "sequenceNumber": "1", "type": "episode" }, { "containerId": "8d5d8b2d-f579-4cc7-bafb-ad871325abad", "containerName": "Man in the Fallout Shelter, The", "eidrL1": "10.5240/5035-EAF7-9252-9812-DFFA-Y", "radarProductId": 220197, "sequenceNumber": "9", "type": "episode" } ], "language": { "languageName": "Catalan", "languageCode": "ca" }, "territory": { "territoryName": "Spain" }, "dubbingTechnique": "lip sync", "status": "voided", "dubbingStudio": { "studioId": "83361967-44bc-426e-ac21-080e585440f3", "studioName": "Dubbing Brothers", "studioCode": "DBFR" } } ] } }
15 April 2026