Skip to main content
POST
/
projects
/
{project_id}
/
orders
cURL
curl "https://api.phrase.com/v2/projects/:project_id/orders" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"branch":"my-feature-branch","name":"Welcome message translations","lsp":"textmaster","source_locale_id":"abcd1234abcd1234abcd1234abcd1234","target_locale_ids":["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],"translation_type":"premium","tag":"my-awesome-feature","message":"Please make everything sound really nice :)","styleguide_id":"1234abcd1234abcd1234abcd1234abcd","category":"C021"}' \
  -H 'Content-Type: application/json'
{
  "id": "30AB4884",
  "lsp": "gengo",
  "amount_in_cents": 1152,
  "currency": "usd",
  "message": "Please make everything sound really nice :)",
  "state": "confirmed",
  "translation_type": "pro",
  "progress_percent": 50,
  "source_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "en",
    "code": "en-GB"
  },
  "target_locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "de",
      "code": "de-DE"
    },
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "fr",
      "code": "fr-FR"
    }
  ],
  "tag": "latest-upload",
  "styleguide": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "title": "My Styleguide"
  },
  "unverify_translations_upon_delivery": true,
  "quality": true,
  "priority": true,
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
project_id
string
required

Project ID

Body

application/json
​
name
string
required

the name of the order, default name is: Translation order from 'current datetime'

Example:

"Welcome message translations"

​
lsp
string
required

Name of the LSP that should process this order. Can be one of gengo, textmaster.

Example:

"textmaster"

​
branch
string

specify the branch to use

Example:

"my-feature-branch"

​
source_locale_id
string

Source locale for the order. Can be the name or id of the source locale. Preferred is id.

Example:

"abcd1234abcd1234abcd1234abcd1234"

​
target_locale_ids
string[]

List of target locales you want the source content translate to. Can be the name or id of the target locales. Preferred is id.

Example:
[
  "1234abcd1234abcd1234abcd1234abcd",
  "abcd1234abcd1234abcd1234abcd1234"
]
​
translation_type
string

Name of the quality level, availability depends on the LSP. Can be one of: standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster)

Example:

"premium"

​
tag
string

Tag you want to order translations for.

Example:

"my-awesome-feature"

​
message
string

Message that is displayed to the translators for description.

Example:

"Please make everything sound really nice :)"

​
styleguide_id
string

Style guide for translators to be sent with the order.

Example:

"1234abcd1234abcd1234abcd1234abcd"

​
unverify_translations_upon_delivery
boolean

Unverify translations upon delivery.

Example:

null

​
include_untranslated_keys
boolean

Order translations for keys with untranslated content in the selected target locales.

Example:

null

​
include_unverified_translations
boolean

Order translations for keys with unverified content in the selected target locales.

Example:

null

​
category
string

Category to use (required for orders processed by TextMaster).

Example:

"C021"

​
quality
boolean

Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster.

Example:

null

​
priority
boolean

Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster.

Example:

null

Response

Created

​
id
string
​
name
string
​
lsp
string
​
amount_in_cents
integer
​
currency
string
​
message
string
​
state
string
​
translation_type
string
​
progress_percent
integer
​
source_locale
object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
target_locales
locale_preview · object[]
​
tag
string
​
styleguide
object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "title": "My Style Guide"
}
​
unverify_translations_upon_delivery
boolean
​
quality
boolean
​
priority
boolean
​
created_at
string<date-time>
​
updated_at
string<date-time>