Merchant sales report

Sales figures for one merchant over a date range: a period summary,
a per-ticket-type breakdown, and a daily breakdown, selectable via
scope.

date_basis picks the date axis. The default, visit, groups both
sales and refunds by the ticket's visit date, answering "how many
tickets are valid per visit day, net of refunds"; rows for future
visit dates keep changing until the day has passed. Tickets without
a fixed visit date (open-date tickets) are excluded from the visit
basis entirely — they appear only on the transaction basis, so the
two bases' totals can differ. Visit-basis figures are refreshed
every three hours and may lag the transaction basis by up to three
hours. transaction groups by when things happened: sales on the
sale date, refunds on the day they were processed — a closed
period's figures never change; every ticket has a sale date, so
nothing is excluded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date
required

First date included, on the selected date_basis.

date
required

Last date included, on the selected date_basis.

string
enum

Date axis to group and filter by. visit attributes sales and refunds to the ticket's visit date; transaction attributes sales to the day the order was placed and refunds to the day they were processed. Defaults to visit.

Allowed:
string

Which of the caller's merchants to report on. Optional when the credentials cover exactly one merchant; required otherwise.

sku
array of strings

Restrict the report to these ticket types. Order-level metrics (orders, refunded_orders, order_value, tickets_per_order) always cover the merchant's full order volume — an order can span ticket types outside the filter.

sku
scope
array of strings

Response sections to include, comma-separated. Defaults to all. ticket_types controls the per-ticket-type breakdowns in the summary and per month/day.

scope
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json