Orders endpoint

Orders documentation

Fetch all orders

orders(team_id[, params = None])
Parameters:
  • team_id (int or str) – ID of the team

  • params (dict) – (optional) Pagination params

Returns:

Collection of orders

Example:

client.orders(12345, {"page": 3, "limit": 2})

Fetch a single order

order(team_id, order_id)
Parameters:
  • team_id (int or str) – ID of the team

  • order_id (str) – ID of the order

Returns:

Order model

Example:

order = client.order(12345, "20201102FTR")
order.status # => "completed"
order.provider_slug # => "gengo"

Create an order

create_order(team_id, params)
Parameters:
  • team_id (int or str) – ID of the team

  • params (dict) – Order parameters

Returns:

Order model

Example:

order = client.create_order(34567, {
    "project_id": '132.abc',
    "card_id": 2185,
    "briefing": "Please make it gooood!",
    "source_language_iso": "en",
    "target_language_isos": ["ru_RU"],
    "keys": [34089123, 3214567],
    "provider_slug": "gengo",
    "translation_tier": 1
})
order.project_id # => '132.abc'
order.card_id # => 2185
order.status # => "in progress"
order.provider_slug # => "gengo"
order.briefing # => "Please make it gooood!"
order.total # => 1.42