Skip to main content
POST
Estimate order
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
enum<string>
default:2024-02-05

The dated version of the API, if not specified a default is used. See API versioning for more information. The dated version of the Runa API. Send it on every request: a client that omits it silently follows whatever the server default happens to be.

Available options:
2024-02-05

Body

application/json

The details of the order to estimate.

Request for a price estimate for an order.

payment_method
Payment Method · object
required

Payment method for the order. Select the ACCOUNT_BALANCE you want to pay for the order from.

items
Estimate item · 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
Payment Method · object
required

Account balance payment.

items
Order item estimate · object[]
required

List of order items with price and discount.

currency
string<iso-4217>
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.

Pattern: ^[A-Z]{3}$
Example:

"USD"

total_discount
string<decimal>
required

Total discount on the entire order.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"0.50"

total_price
string<decimal>
required

Total price of the entire order.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"9.50"

transaction_detail
Transaction detail · object

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

Example: