TradeOps API
The TradeOps API is what the TradeOps field app runs on, and it’s open to customers on plans with API access. It covers the work a field team does every day:
- Visits: store checks scheduled for a rep.
- Checklists: the fields a rep fills in at a store.
- Store checks: completed checklists, with scores.
- Customers: the stores and outlets reps visit.
- Campaigns and follow-ups.
Where to start
Section titled “Where to start”- Quickstart: get a token and make your first call.
- Conventions: authentication, organisations, formats, errors and limits.
- API reference: every endpoint, generated from the code.
- OpenAPI spec and clients: download the spec and generate a typed client.
Words we use
Section titled “Words we use”The product and the API use different words for some things. The reference uses both.
| In the app | In the API |
|---|---|
| Organisation | team |
| Checklist | audit type |
| Store check | submission |
| Visit | assignment |
| Follow-up | corrective action |
| Rep | auditor |