Read a merchant's fully-paid, closed sales, including item lines, taxes, discounts, and payments.
List sales to retrieve full Sale objects, or search by date, payment status, and sales channel
to retrieve summaries. Use a summary's id to get the full sale.
Amounts are expressed in minor units according to each sale's currency.scale.
Objects:
- List salesGET
/v1.0/merchants/{merchant_code}/salesReturns a paginated list of
Saleobjects. 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/searchfor filtered queries.OAuth scopes: Requires one of:
sales.read.Required permissions:
merchant.read
- Search salesPOST
/v1.0/merchants/{merchant_code}/sales/searchReturns a paginated list of
SaleSearchItemrows 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 withGET /sales.OAuth scopes: Requires one of:
sales.read.Required permissions:
merchant.read
- Get a saleGET
/v1.0/merchants/{merchant_code}/sales/{sale_id}Returns
Saleforsale_id, including item lines andpayments[]. Non-finalised sales are never returned; only fully-paid sales.OAuth scopes: Requires one of:
sales.read.Required permissions:
merchant.read