GET
/
integration
/
orders
/
{orderId}
curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1" \
  -H "X-Api-Key: <your-api-key>"
{
  "id": "60b8d6f1e1b9b1d8c6c0d8e1",
  "createdAt": "2024-01-15T10:30:00Z",
  "name": "Batman Returns - Episode 1",
  "sourceLanguage": "en",
  "targetLanguage": "fr",
  "type": "cc",
  "status": "completed",
  "rate": 0.15,
  "projectId": "proj_xyz789",
  "level": 2,
  "folderId": "folder_abc123",
  "vttUrl": "https://example.com/subtitles/batman_returns_fr.vtt",
  "orderDocs": [
    {
      "id": "doc_123abc",
      "name": "Batman Returns - Source Video",
      "url": "https://example.com/videos/batman_returns.mp4",
      "type": "sourceVideo",
      "size": 1073741824,
      "duration": 7200,
      "sourceLanguage": "en",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "doc_456def",
      "name": "French Subtitles",
      "url": "https://example.com/subtitles/batman_returns_fr.srt",
      "type": "subtitle",
      "size": 8192,
      "wordCount": 1250,
      "sourceLanguage": "fr",
      "createdAt": "2024-01-16T14:20:00Z",
      "updatedAt": "2024-01-16T14:20:00Z"
    }
  ],
  "finance": {
    "paymentAmount": 150.75
  }
}

Retrieve detailed information about a specific translation order using its unique identifier. This endpoint provides comprehensive order details including status, documents, and financial information.

curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1" \
  -H "X-Api-Key: <your-api-key>"

Authorizations

This endpoint requires API key authentication. Include your API key in the request header:

  • Header name: X-Api-Key
  • Header value: Your API key from the Ollang dashboard
  • Format: X-Api-Key: your-api-key-here

You can obtain your API key from your Ollang dashboard.

Path Parameters

orderId
string
required

The unique identifier of the order you want to retrieve. This should be a valid order ID that you have access to.

Response

id
string

Unique identifier of the order.

createdAt
string

Creation date and time of the order (ISO 8601 format).

name
string

Name or title of the order.

sourceLanguage
string

Source language of the content. Uses ISO 639-1 language codes (e.g., ‘en’, ‘tr’, ‘fr’).

targetLanguage
string

Target language for translation. Uses ISO 639-1 language codes (e.g., ‘en’, ‘tr’, ‘fr’).

type
string

Type of the order. Possible values: cc, subtitle, document, aiDubbing, studioDubbing, proofreading, other, revision.

status
string

Current status of the order. Possible values: pending, ongoing, completed, revision, delayed, waitingForCC, waitingForSubtitle, delivered, qualityCheck, readyToSent.

rate
number

Rate applied to the order for pricing calculation.

projectId
string

Associated project identifier that this order belongs to.

level
number

Service level required for the order (1: Basic, 2: Premium, 3: Enterprise).

folderId
string

Folder identifier where the order files are organized and stored.

vttUrl
string

URL to download the VTT subtitle file associated with the order (if available).

orderDocs
array

Array of documents associated with the order.

finance
object

Financial details related to the order.

{
  "id": "60b8d6f1e1b9b1d8c6c0d8e1",
  "createdAt": "2024-01-15T10:30:00Z",
  "name": "Batman Returns - Episode 1",
  "sourceLanguage": "en",
  "targetLanguage": "fr",
  "type": "cc",
  "status": "completed",
  "rate": 0.15,
  "projectId": "proj_xyz789",
  "level": 2,
  "folderId": "folder_abc123",
  "vttUrl": "https://example.com/subtitles/batman_returns_fr.vtt",
  "orderDocs": [
    {
      "id": "doc_123abc",
      "name": "Batman Returns - Source Video",
      "url": "https://example.com/videos/batman_returns.mp4",
      "type": "sourceVideo",
      "size": 1073741824,
      "duration": 7200,
      "sourceLanguage": "en",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "doc_456def",
      "name": "French Subtitles",
      "url": "https://example.com/subtitles/batman_returns_fr.srt",
      "type": "subtitle",
      "size": 8192,
      "wordCount": 1250,
      "sourceLanguage": "fr",
      "createdAt": "2024-01-16T14:20:00Z",
      "updatedAt": "2024-01-16T14:20:00Z"
    }
  ],
  "finance": {
    "paymentAmount": 150.75
  }
}