Skip to main content
GET
/
v1
/
orders
/
{id}
GetOrder
curl --request GET \
  --url https://api.nitrotranslate.com/v1/orders/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": 123,
  "source_language": "<string>",
  "target_language": "<string>",
  "source_text": "<string>",
  "target_text": "<string>",
  "snippet": "<string>",
  "volume": 123,
  "price": 123,
  "resource": {
    "type": "<string>",
    "data": "<string>",
    "metadata": "<string>"
  },
  "context": {
    "limit": 1
  },
  "comments": [
    {
      "id": 123,
      "time": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "attachments": [
        {
          "image": "<string>",
          "type": "<string>",
          "name": "<string>",
          "weight": 123,
          "size": "<string>"
        }
      ]
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "accepted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "translator": "<string>"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
required

Response

200 - application/json

Success

A full order record, as returned by GetOrder. Lighter listings (ListOrders, Translate) use the OrderSummary projection instead.

status
enum<string>
required

Lifecycle status: QUEUE (deletable) -> PROGRESS -> DONE. REVISION marks a completed order the customer reopened and is pending revision; once rework resumes it reports as PROGRESS again (DONE -> REVISION -> PROGRESS -> DONE).

Available options:
QUEUE,
PROGRESS,
DONE,
REVISION
id
source_language
string
target_language
string
source_text
string
target_text
string
snippet
string
volume
integer<int32>
price
number<double>
resource
resource · object

The content to be translated. data is interpreted according to its MIME type (e.g. text/plain, text/html, application/json).

context
context · object

Translation hints applied to an order. All fields are optional.

comments
Comment · object[]
created_at
string<date-time>
accepted_at
string<date-time>
completed_at
string<date-time>
translator
string | null