Skip to main content
GET
/
order
/
{id}
Get order details
curl --request GET \
  --url https://playground.runa.io/v2/order/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
  "status": "PROCESSING",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "description": "Your own reference text",
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "USD"
  },
  "currency": "USD",
  "total_price": "10",
  "total_discount": "1",
  "items": [
    {
      "id": "E-NWPEKW4VL",
      "distribution_method": {
        "type": "EMAIL",
        "email_address": "[email protected]",
        "template_id": "DT-01HPSF51G0ZWHJ3JTNWRH0WDYK"
      },
      "products": {
        "type": "MULTIPLE",
        "values": [
          "AMZ-US",
          "AIRBNB-US"
        ]
      },
      "face_value": "10",
      "price": "10",
      "payout": {
        "status": "ACTIVE",
        "status_updated_at": "2023-11-07T05:31:56Z",
        "url": "<string>",
        "expiry_date": "2023-11-07T05:31:56Z"
      },
      "currency": "USD"
    }
  ],
  "transaction_detail": {
    "USD": {
      "value": "10.00",
      "fx": null
    }
  },
  "metadata": {
    "internal_id": "12345",
    "department": "marketing",
    "campaign": "summer_2024"
  }
}
This endpoint can return both complete and incomplete orders. The types of these responses differ, you should use the status field to determine which type of response you are receiving.
  • Completed orders will have a status of COMPLETED or FAILED and have a full response body.
  • Incomplete orders will have a status of PROCESSING and have a partial response body.

Authorizations

​
X-Api-Key
string
header
required

Headers

​
X-Api-Version
string

Path Parameters

​
id
string
required

Response

  • Completed order
  • Incomplete order
​
id
string
required
Example:
​
status
enum<string>
required
Available options:
COMPLETED,
FAILED,
PROCESSING
Example:
​
created_at
string<date-time>
required
​
payment_method
object
required
​
currency
string
required
Example:
​
total_price
string
required
Example:
​
total_discount
string
required
Example:
​
items
CompletedOrderItem · object[]
required
​
completed_at
string<date-time>
​
description
string | null
Maximum length: 128
Example:
​
transaction_detail
object
Example:
​
metadata
object | null
Example: