Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
productions

Get Order

Retrieves full details for a Productions order.

Quote and pricing information may not be available immediately; if you wish to see the quote before submission, you may need to poll the order details until it is ready.

get/v1/productions/orders/{order_id}

Path parameters

order_idstring required

The ID of the order.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

order_idstring required
namestring required

The display name of the order.

state'open' | 'submitted' | 'paid' | 'accepted' | 'rejected' | 'done' | 'cancelling' | 'cancelled' | 'expired' required
total_amount_usdnumber nullable

The total price for all items in USD. Excluded from response until quotes are available.

sandboxboolean

Whether this is a sandbox order that auto-progresses without producer intervention.

created_atstring date-time required

The timestamp when the order was created.

submitted_atstring date-time nullable

The timestamp when the order was submitted, if applicable.

paid_atstring date-time nullable

The timestamp when payment was received, if applicable.

accepted_atstring date-time nullable

The timestamp when the order was accepted for production, if applicable.

completed_atstring date-time nullable

The timestamp when the order was completed, if applicable.

cancel_reasonstring nullable

The reason the order was cancelled, if applicable.

Example response

{
  "created_at": "2025-03-15T10:00:00Z",
  "items": [
    {
      "item": {
        "captions_sdh": false,
        "destination_languages": [
          "hi",
          "fr-FR",
          "de"
        ],
        "include_captions": true,
        "include_source_captions": false,
        "instructions": "Voices don't need to match the originals, prioritize native-sounding voices",
        "kind": "dub",
        "media_id": "prodmedia_01jgb2zd68f8f9tfvbb968wb8z",
        "source_language": "en"
      },
      "item_id": "proditem_01jgd3qhejfs7rm6swknz2ytjb",
      "quote": {
        "amount_usd": 11
      }
    }
  ],
  "name": "Spanish Dubs",
  "order_id": "prodorder_01jgatk6h0fwxrtbjade61yqhx",
  "sandbox": false,
  "state": "open",
  "total_amount_usd": 11
}