Overview

TradeOps API 1.0.0

The TradeOps API powers the TradeOps field app and customer integrations.

Guides, conventions and examples live at https://docs.tradeops.cc.

Base URL: https://api.tradeops.cc/v1
Authentication: send Authorization: Bearer {token}. The field app gets a token from POST /auth/token or POST /auth/phone/token.
Organisations: most routes start with the organisation’s slug, for example /acme-retail/sync. GET /me lists the organisations a member can use.
Format: resources follow JSON:API (application/vnd.api+json) and support include and sparse fields[...]. Sign-in and sync return plain JSON.
Errors: 401 without a valid token, 403 when the member’s role or plan doesn’t allow the call, 404 when a record doesn’t exist in the organisation, 422 with an errors object for invalid input, 429 when rate limited.

Information

Security scheme type: http