Orders
CalculateOrder
Enables applications to preview order pricing without creating an order.
post/v2/orders/calculate
Request body
Example request
{
"idempotency_key": "b3e98fe3-b8de-471c-82f1-545f371e637c",
"order": {
"discounts": [
{
"name": "50% Off",
"percentage": "50",
"scope": "ORDER"
}
],
"line_items": [
{
"base_price_money": {
"amount": 500,
"currency": "USD"
},
"name": "Item 1",
"quantity": "1"
},
{
"base_price_money": {
"amount": 300,
"currency": "USD"
},
"name": "Item 2",
"quantity": "2"
}
],
"location_id": "D7AVYMEAPJ3A3"
}
}Response
Success
Example response
{
"order": {
"created_at": "2020-05-18T16:30:49.614Z",
"discounts": [
{
"applied_money": {
"amount": 550,
"currency": "USD"
},
"name": "50% Off",
"percentage": "50",
"scope": "ORDER",
"type": "FIXED_PERCENTAGE",
"uid": "zGsRZP69aqSSR9lq9euSPB"
}
],
"line_items": [
{
"applied_discounts": [
{
"applied_money": {
"amount": 250,
"currency": "USD"
},
"discount_uid": "zGsRZP69aqSSR9lq9euSPB",
"uid": "9zr9S4dxvPAixvn0lpa1VC"
}
],
"base_price_money": {
"amount": 500,
"currency": "USD"
},
"gross_sales_money": {
"amount": 500,
"currency": "USD"
},
"name": "Item 1",
"quantity": "1",
"total_discount_money": {
"amount": 250,
"currency": "USD"
},
"total_money": {
"amount": 250,
"currency": "USD"
},
"total_service_charge_money": {
"amount": 0,
"currency": "USD"
},
"total_tax_money": {
"amount": 0,
"currency": "USD"
},
"uid": "ULkg0tQTRK2bkU9fNv3IJD",
"variation_total_price_money": {
"amount": 500,
"currency": "USD"
}
},
{
"applied_discounts": [
{
"applied_money": {
"amount": 300,
"currency": "USD"
},
"discount_uid": "zGsRZP69aqSSR9lq9euSPB",
"uid": "qa8LwwZK82FgSEkQc2HYVC"
}
],
"base_price_money": {
"amount": 300,
"currency": "USD"
},
"gross_sales_money": {
"amount": 600,
"currency": "USD"
},
"name": "Item 2",
"quantity": "2",
"total_discount_money": {
"amount": 300,
"currency": "USD"
},
"total_money": {
"amount": 300,
"currency": "USD"
},
"total_service_charge_money": {
"amount": 0,
"currency": "USD"
},
"total_tax_money": {
"amount": 0,
"currency": "USD"
},
"uid": "mumY8Nun4BC5aKe2yyx5a",
"variation_total_price_money": {
"amount": 600,
"currency": "USD"
}
}
],
"location_id": "D7AVYMEAPJ3A3",
"net_amounts": {
"discount_money": {
"amount": 550,
"currency": "USD"
},
"service_charge_money": {
"amount": 0,
"currency": "USD"
},
"tax_money": {
"amount": 0,
"currency": "USD"
},
"tip_money": {
"amount": 0,
"currency": "USD"
},
"total_money": {
"amount": 550,
"currency": "USD"
}
},
"state": "OPEN",
"total_discount_money": {
"amount": 550,
"currency": "USD"
},
"total_money": {
"amount": 550,
"currency": "USD"
},
"total_service_charge_money": {
"amount": 0,
"currency": "USD"
},
"total_tax_money": {
"amount": 0,
"currency": "USD"
},
"total_tip_money": {
"amount": 0,
"currency": "USD"
},
"updated_at": "2020-05-18T16:30:49.614Z",
"version": 1
}
}