API 1.0

Orders endpoint

Orders are containers for multiple documents that should be translated. See Lifetime and state changes of an order for an example of a typical workflow for a full lifetime of an order.

Methods

GET /orders
List orders of user.
POST /orders
Create an order.
PATCH /orders/:identifier
Update an order.
GET /orders/:identifier
Retrieve information about an specific order.
PATCH /orders/:identifier/request
Request an order.
GET /orders/:identifier/documents
List documents of an order.
POST /orders/:identifier/documents
Add a document to an order.
GET /orders/:identifier/quotes
List quotes of an order.
GET /orders/:identifier/invoices
List invoices of an order.
POST /orders/:identifier/ratings
Create a rating for an order.

Lifetime and state changes of an order

A typical lifetime of an order and the state changes during it on the right.

1. Create order
POST /orders
State: new
2. Create upload token
POST /upload_tokens
2a. Upload documents to DocumentStore
Upload the documents to the DocumentStore using the file upload endpoint of the DocumentStore API.
3. Add documents
POST /orders/:identifier/documents
4. Request order
PATCH /orders/:identifier/:request
requested
4a. Optional quote workflow
Based on your requirements Toptranslation may provide a quote that needs to be accepted before it starts processing the translations.
quoted
4b. Get quotes
GET /orders/:identifier/quotes
4c. Accept quote
PATCH /quotes/:identifier/:accept
ordered
5. Delivery of translated documents
Configured webhooks may be triggered
delivered
6. Get documents
GET /orders/:identifier/documents
7. Download translations
GET /translations/:identifier/download