Sign in
Orders

List the revenue breakdown for an order

Return the order's revenue rolled up by revenue centre. Each entry carries the revenue centre code, the gross and net amounts (in the lowest denomination of the order's currency) and the tax components that contributed to the gross figure. Used by the operator-facing revenue panel and by the reporting suite to drill down into a single order's contribution to a daily or monthly total.

The response's meta.currency mirrors the order's currency so that callers don't have to look it up on the parent order.

Not paginated.

get/shop/orders/{orderId}/revenues

Response

The revenue breakdown for the order, grouped by revenue centre.

Example response

{
  "data": [
    {
      "revenue_centre": "treatments",
      "revenue_centre_name": "Treatments",
      "gross_amount": 12000,
      "net_amount": 10000,
      "taxes": [
        {
          "name": "VAT (20%)",
          "rate": 0.2,
          "amount": 2000
        }
      ]
    }
  ],
  "meta": {
    "currency": "gbp"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.