POST
/
order
/
estimate
Estimate order
curl --request POST \
  --url https://playground.runa.io/v2/order/estimate \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "USD"
  },
  "items": [
    {
      "products": {
        "type": "MULTIPLE",
        "values": [
          "AMZ-US",
          "AIRBNB-US"
        ]
      },
      "face_value": 10
    }
  ]
}'
{
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "USD"
  },
  "items": [
    {
      "products": {
        "type": "MULTIPLE",
        "values": [
          "AMZ-US",
          "AIRBNB-US"
        ]
      },
      "face_value": 10,
      "price": 123,
      "discount_multiplier": "0.05",
      "currency": "USD"
    }
  ],
  "currency": "USD",
  "total_discount": 123,
  "total_price": 123,
  "transaction_detail": {
    "USD": {
      "value": "10.00",
      "fx": null
    }
  }
}
The estimate endpoint is currently unsupported in the playground environment.

Authorizations

​
X-Api-Key
string
header
required

Your API key. See the API key page on details of how to generate and store your keys.

Headers

​
X-Api-Version
string

The dated version of the API, if not specified a default is used. See API versioning for more information.

Body

application/json

The details of the order to estimate.

Request for a price estimate for an order.

​
payment_method
object
required

Payment method for the order. Select the ACCOUNT_BALANCE you want to pay for the order from. Pay using your account balance.

​
items
OrderItemPriceRequest · object[]
required

List of order items for price estimation.

Required array length: 1 - 500 elements

Response

OK

Response object for a order price estimate.

​
payment_method
object
required

Account balance payment.

​
items
OrderItemDiscount · object[]
required

List of order items with price and discount.

​
currency
string
required

The currency of the order, represented by ISO 4217 currency codes. Please check the currency section in the guidelines for how to use this field.

Example:

"USD"

​
total_discount
number
required

Total discount on the entire order.

​
total_price
number
required

Total price of the entire order.

​
transaction_detail
object

A mapping of the subtotal of the order using the payout currency as a key.

Example:
{ "USD": { "value": "10.00", "fx": null } }