Overview
The Sales Data API enables you to sync sales transactions from point-of-sale (POS) systems and other third-party applications with Connecteam, and to read or set per-day aggregated totals. This data can be used for reporting, analytics, dashboards, forecasting, and performance tracking.
Key Concepts
Locations
Locations represent physical branches, stores, or facilities where sales occur. Each location has:
- A unique ID assigned by Connecteam
- A name for identification
- An active/inactive status
Transactions
Transactions represent individual sales events. Each transaction includes:
- The location where the sale occurred
- The sale type (SALE, REFUND, VOID, etc.)
- The amount and optional tax
- A timestamp
Daily Sales
Daily sales are per-location, per-day rollups with two values:
totalSales— aggregated automatically from transactions (read-only via this API; push sales using the Transactions endpoints).projectedSales— a forecast / budget value you set per day via the daily-sales PUT endpoint, used for variance reporting.
Available Endpoints
Locations
| Method | Endpoint | Description |
|---|---|---|
| GET | /sales/v1/locations | Get all locations |
| POST | /sales/v1/locations | Create a new location |
Transactions
| Method | Endpoint | Description |
|---|---|---|
| POST | /sales/v1/transactions | Create transactions (up to 100) |
| DELETE | /sales/v1/transactions | Delete transactions by time period |
| DELETE | /sales/v1/transactions/{transactionId} | Delete a single transaction |
Daily Sales
| Method | Endpoint | Description |
|---|---|---|
| GET | /sales/v1/daily-sales | Get aggregated daily sales totals across locations |
| PUT | /sales/v1/locations/{locationId}/daily-sales | Set projected sales per day for a single location |
Sale Types
Transactions support the following sale types:
| Type | Description |
|---|---|
SALE | Standard sale transaction |
VOID | Voided transaction |
REFUND | Refund transaction |
SPLIT | Split payment transaction |
TRANSFER | Transfer between locations |
RECALL | Recalled transaction |
UPDATE | Updated transaction |
FLOAT | Float/cash management |
TRANSITORY | Temporary transaction |
CROSS_BL | Cross-business line transaction |
CANCEL | Cancelled transaction |
MANUAL | Manually entered transaction |
Constraints
| Constraint | Value |
|---|---|
| Max transactions per request | 100 |
| Max locations per GET request | 1000 |
| Transaction timestamps | Unix epoch (seconds) |
| Daily-sales dates | ISO 8601 (YYYY-MM-DD) |
Authentication
All endpoints require authentication via API key or OAuth 2.0.
Required Scopes
| Scope | Operations |
|---|---|
| sales_data.read | GET locations, GET daily-sales |
| sales_data.write | POST locations, POST transactions, PUT daily-sales (projected) |
| sales_data.delete | DELETE transactions |
Workflow
- Create locations for each store/branch
- Sync transactions by posting sales data with location IDs
- Read daily totals via the daily-sales GET endpoint for dashboards and reports
- Set forecasts with the daily-sales PUT endpoint for variance reporting
- Manage data by deleting outdated or incorrect transactions
NoteYou must create a location before creating transactions or setting projected sales for that location. All endpoints reference locations by their Connecteam-assigned ID.
Guide Pages
| Page | Description |
|---|---|
| Managing Locations | Create and retrieve locations |
| Managing Transactions | Create and delete sales transactions |
| Managing Daily Sales | Read aggregated daily totals and set projected (forecast) sales |
Updated 10 days ago
