Skip to main content

Get Line Option Values Report

GET 

/api/reports/line-option-values

Totals per customer option value on sales order lines: how many lines chose each value, the units and revenue of those lines, and the add-on revenue the option itself carried. Use it to see which made-to-order choices sell (for example how many binding covers were ordered with "Punching Pattern: Wire Binding 3:1 Square").

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token (scope reports:read).

Filters (all optional):

  • filter[date_from], filter[date_to] (Y-m-d, in the account's timezone) — order date range. Defaults to the 30 days ending today; date_to must be on or after date_from.
  • filter[sales_channel_id] (integer) — one sales channel.
  • filter[name] (string) — one option name, e.g. Punching Pattern.
  • filter[include_hidden] (boolean, default false) — include values hidden by everywhere hide rules.

Draft and cancelled orders are excluded, as are configured SKU options. A manual option replaces the channel option of the same name on that line.

Row fields: name, value, lines (distinct lines), units (sum of line quantity), revenue (sum of quantity × unit price) and price_delta_total (sum of quantity × the option's add-on price), both in the account currency. Rows are ordered by lines, most first. Not paginated.

Request​

Responses​

OK

Response Headers
    Content-Type