List sales

Returns completed POS sales, returns, and exchanges for the organization.

GEThttps://api.tracksales.co/v1/sales

Required scope: sales:read

Request URL: https://api.tracksales.co/v1/sales

Query Params

searchstring

Search by name, code, or reference

location_idinteger

Filter by branch/location ID

customer_idinteger

Filter by customer ID

typestring

Filter by sale type: sale, return, or exchange

statusstring

Filter by status (e.g. paid, voided)

startstring

Sale date on or after (YYYY-MM-DD)

endstring

Sale date on or before (YYYY-MM-DD)

limitinteger

Page size (default 20, max 100)

offsetinteger

Pagination offset (default 0)

Responses

200OK

Request succeeded.

401Unauthorized

API key is missing or invalid.

403Forbidden

API key lacks the required scope.

404Not Found

Sales was not found.

422Validation Error

Request validation failed.

curl -X GET 'https://api.tracksales.co/v1/sales?limit=20&search=acme&start=2026-01-01&end=2026-07-01' \
  -H 'Authorization: Bearer ts_live_YOUR_API_KEY' \
  -H 'Accept: application/json'

{
    "success": true,
    "data": {
        "sales": [
            {
                "id": "880e8400-e29b-41d4-a716-446655440099",
                "reference": "SR-00042",
                "type": "sale",
                "status": "paid",
                "customerId": "660e8400-e29b-41d4-a716-446655440010",
                "locationId": "660e8400-e29b-41d4-a716-446655440001",
                "total": 11600
            }
        ],
        "total": 1,
        "limit": 20,
        "offset": 0
    }
}

{
    "success": false,
    "error": {
        "code": "unauthenticated",
        "message": "Invalid or revoked API key."
    }
}

{
    "success": false,
    "error": {
        "code": "forbidden",
        "message": "API key lacks required scope."
    }
}

{
    "success": false,
    "message": "Sales not found"
}

{
    "success": false,
    "message": "Validation failed",
    "errors": {
        "field": [
            "The field is required."
        ]
    }
}