List products

Paginated product list for the organization.

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

Required scope: products:read

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

Query Params

searchstring

Search by name, code, or reference

location_idstring

Branch location UUID. When provided, inventory reflects stock at that branch; quantities still includes every branch.

limitinteger

Page size (default 100, max 1000)

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

Products was not found.

422Validation Error

Request validation failed.

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

{
    "success": true,
    "data": {
        "products": [
            {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "name": "Widget A",
                "code": "WGT-001",
                "category": "Electronics",
                "inventory": 45,
                "totalQuantity": 45,
                "quantities": [
                    {
                        "locationId": "660e8400-e29b-41d4-a716-446655440001",
                        "locationName": "Main branch",
                        "quantity": 30
                    },
                    {
                        "locationId": "660e8400-e29b-41d4-a716-446655440002",
                        "locationName": "West branch",
                        "quantity": 15
                    }
                ],
                "costPrice": 800,
                "retailPrice": 1200,
                "isService": false
            }
        ],
        "total": 1,
        "limit": 100,
        "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": "Products not found"
}

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