Order search and amounts

Each order returned by POST /v2/order/search has a top-level priceDetail projected from its saved price breakdown. Search for one order by order number:

{
  "filter": { "search": "O-DEMO-001" },
  "paging": { "skip": 0, "limit": 1 },
  "preferred": { "version": "v2", "currency": "CNY" }
}

Amounts

Field Meaning
orders[].priceDetail.aggregated.sum Order total after deductions, in priceDetail.currency
orders[].priceDetail.aggregated.approximate.sum Order total after deductions, in priceDetail.approximate.currency
orders[].priceDetail.aggregated.sumReservation Total before deductions, in priceDetail.currency
orders[].priceDetail.aggregated.approximate.sumReservation Total before deductions, in priceDetail.approximate.currency
orders[].priceDetail.breakdown Room charge, tax, and order-level discounts; discounts are usually negative

The top-level priceDetail and details[].booking.rate.priceDetail use the same currency, aggregate, and breakdown field meanings, but their values can differ. The rate is a quote and may hide order-level discounts; the top-level detail retains those discounts and the resulting order total. breakdown[].item is localized for the requested language. details[].payment.status reports payment state; the order total does not indicate that payment was collected.

This synthetic example shows CNY 1,000 in room charges and tax, a CNY 20 instant prepayment discount, and a CNY 80 instant commission discount. The order total is CNY 900, while payment is still pending:

{
  "orders": [{
    "no": "O-DEMO-001",
    "priceDetail": {
      "currency": "CNY",
      "approximate": { "currency": "CNY", "exchangeRate": 1 },
      "aggregated": {
        "currency": "CNY",
        "sumReservation": 1000,
        "sum": 900,
        "approximate": {
          "currency": "CNY",
          "sumReservation": 1000,
          "sum": 900
        }
      },
      "breakdown": [
        { "item": "Room charge", "type": "base", "amount": 900, "currency": "CNY" },
        { "item": "Tax", "type": "tax", "amount": 100, "currency": "CNY" },
        { "item": "Instant Prepay Discount", "type": "discount", "amount": -20, "currency": "CNY" },
        { "item": "Commission deduction", "type": "discount", "amount": -80, "currency": "CNY" }
      ]
    },
    "details": [{
      "booking": { "rate": { "priceDetail": { "aggregated": { "sumReservation": 1000 } } } },
      "payment": { "type": "prepay", "status": "toBePaid" }
    }]
  }],
  "paging": { "skip": 0, "limit": 1, "count": 1 }
}

Complete a mock booking in the Hotel API demo to inspect the /v2/order/search response and order total. See the Open API v2 Order reference for all fields.