Orders

Note:This resource is not available in PhraseApp Enterprise

List of categories [TextMaster]

When ordering translations from TextMaster, you need to specify a category ID along with your order. See this list for information on the category ID and their equivalent description.

Category ID Description
C001 Agriculture
C002 Aerospace
C003 Animals/Pets/Plants
C004 Arts/Culture/Literature
C005 Automotive/Transportation
C006 Computers/Technology/Software
C007 Telecom
C008 Real Estate/Construction/Building
C009 Consumer Goods
C010 Education
C011 Entertainment
C012 Ecology/Environment
C013 Health/Biotechnology/Pharma
C014 Internet
C015 Policy/Government/Public
C016 Publishing/Media/Communication
C017 Religion
C018 Food/Beverages
C019 Retail
C020 Fashion/Luxury/Textiles
C021 Travel/Tourism
C022 Natural Resources/Energy
C023 Banking/Financial Services/Insurance
C024 Legal Affairs/Tax/Law
C025 Raw Materials/Industrial Goods
C026 Lifestyle/Leisure/Hobbies
C027 Sports
C028 Home/Family/Friends/Children
C029 Economy/Financial Markets
C030 Science
C031 Human Resources/Employment
C032 Adult (Pornography, Violence, etc.)

GET /v2/projects/:project_id/orders

List all orders for the given project.

This endpoint is paginated.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/orders" \
  -u USERNAME_OR_ACCESS_TOKEN
phraseapp orders list <project_id>

Response

Status: 200
[ { "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" }, { "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" } ]

GET /v2/projects/:project_id/orders/:id

Get details on a single order.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/orders/:id" \
  -u USERNAME_OR_ACCESS_TOKEN
phraseapp order show <project_id> <id>

Response

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

POST /v2/projects/:project_id/orders

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

Parameters

Name Type Description
lsp string Name of the LSP that should process this order. Can be one of gengo, textmaster.
source_locale_id id Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id.
target_locale_ids array of strings List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id.
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)
tag
optional
string Tag you want to order translations for.
message
optional
string Message that is displayed to the translators for description.
styleguide_id
optional
id Style guide for translators to be sent with the order.
unverify_translations_upon_delivery
optional
boolean Unverify translations upon delivery.
Default: false
include_untranslated_keys
optional
boolean Order translations for keys with untranslated content in the selected target locales.
Default: true
include_unverified_translations
optional
boolean Order translations for keys with unverified content in the selected target locales.
Default: false
category string Category to use (required for orders processed by TextMaster). Category List
quality
optional
boolean Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster.
Default: false
priority
optional
boolean Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster.
Default: false

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/orders" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"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'
phraseapp order create <project_id> \
--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

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

PATCH /v2/projects/:project_id/orders/:id/confirm

Confirm an existing order and send it to the provider for translation. Same constraints as for create.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/orders/:id/confirm" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH
phraseapp order confirm <project_id> <id>

Response

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

DELETE /v2/projects/:project_id/orders/:id

Cancel an existing order. Must not yet be confirmed.

Example Request

curl "https://api.phraseapp.com/api/v2/projects/:project_id/orders/:id" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X DELETE
phraseapp order delete <project_id> <id>

Response

Status: 204