v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Orders

Create a new order

Create a new order. Access token scope must include orders.create.

post/projects/{project_id}/orders

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

namestring required

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

lspstring required

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

source_locale_idstring

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

target_locale_idsstring[]

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

translation_typestring

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)

tagstring

Tag you want to order translations for.

messagestring

Message that is displayed to the translators for description.

styleguide_idstring

Style guide for translators to be sent with the order.

unverify_translations_upon_deliveryboolean

Unverify translations upon delivery.

include_untranslated_keysboolean

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

include_unverified_translationsboolean

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

categorystring

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

qualityboolean

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

priorityboolean

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

Example request

{
  "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"
}

Response

Created

idstring

namestring

lspstring

amount_in_centsinteger

currencystring

messagestring

statestring

translation_typestring

progress_percentinteger

tag_namestring

Name of the tag whose keys are included in the order.

unverify_translations_upon_deliveryboolean

qualityboolean

priorityboolean

created_atstring date-time

updated_atstring date-time

Example response

{
  "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_name": "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"
}