Sales

Returns a paginated list of Sale objects. Results are sorted newest first by the newest event recorded for each sale. Pagination tokens follow that order.

Covers the merchant’s last two years of sales. Non-finalised sales are never returned; only fully-paid sales. Use POST /sales/search for filtered queries.

OAuth scopes: Requires one of: sales.read.

Required permissions:

• merchant_read

Returns a paginated list of SaleSearchItem rows matching filter criteria. Results are sorted newest first by sale close date.

Filters from different categories stack with logical AND; multiple values in one array field stack with logical OR. Results cover the merchant’s last two years of sales (narrow further with start_date / end_date). Pagination tokens are not interchangeable with GET /sales.

OAuth scopes: Requires one of: sales.read.

Required permissions:

• merchant_read

Returns Sale for sale_id, including item lines and payments[]. Non-finalised sales are never returned; only fully-paid sales.

OAuth scopes: Requires one of: sales.read.

Required permissions:

• merchant_read