LOlokalise
Orders

Create an order

Creates a translation order. You must have admin privileges in the project you are placing an order in.

Requires <code>write_team_orders</code> OAuth access scope.

post/teams/{team_id}/orders

Request

  • Base URL
    https://api.lokalise.com/api2
  • URL
    https://api.lokalise.com/api2/teams/{team_id}/orders
  • Auth
    API key in header X-Api-Token

Path parameters

team_idnumber required

A unique team identifier

Request body

project_idstring required

Project identifier.

branchstring

Branch name.

payment_method'credit_card' | 'team_credit'

Payment method. Possible values are <code>credit_card</code> (default) or <code>team_credit</code>.

card_idnumber

Identifier of the card used for payment. Required if <code>payment_method</code> = <code>credit_card</code>.

briefingstring required

Order briefing.

source_language_isostring required

Source language code of the order.

target_language_isosstring[] required

List of target languages.

keysstring[] required

List of keys identifiers, included in the order.

provider_slugstring required

Translation provider slug.

translation_tiernumber required

Tier of the translation. Tiers depend on provider.

is_saved_to_translation_memoryboolean

Default true, can be set only with <code>google</code> and <code>deepl</code> providers.

dry_runboolean

Return the response without actually placing an order. Useful for price estimation. The card will not be charged. Defaults to <code>false</code> (live mode).

translation_stylestring

Only for <code>gengo</code> provider. Available values are <code>formal</code>, <code>informal</code>, <code>business</code>, <code>friendly</code>. Defaults to <code>friendly</code>.

Response

OK

order_idstring

A unique order identifier.

project_idstring

Project identifier.

branchstring

Branch name.

payment_methodstring

Payment method. Possible values are <code>credit_card</code>, <code>team_credit</code>, <code>none</code>. <code>null</code> will be returned for orders made before the attribute was introduced.

card_idnumber

Identifier of the card used for payment.

statusstring

Status of the order. Possible values are <code>in progress</code>, <code>completed</code>. <code>processing</code>, <code>draft</code> in case if <code>dry_run</code> = <code>true</code>.

created_atstring

Date and time of the order creation.

created_at_timestampnumber

Unix timestamp when the order was created.

created_bynumber

Identifier of a user, who has created the order.

created_by_emailstring

E-mail of a user, who has created the order.

source_language_isostring

Source language code of the order.

provider_slugstring

Translation provider slug.

translation_stylestring

Style of the translation, applies to <code>gengo</code> provider only.

translation_tiernumber

Tier of the translation. Tiers depend on provider.

translation_tier_namestring

Tier name.

briefingstring

Order briefing.

is_saved_to_translation_memoryboolean

Default true, can be set only with <code>google</code> and <code>deepl</code> providers.

totalnumber

Total cost of the order in major currency units (USD)

Changes

No recorded changes to this operation across all 2 revisions of this API.