API Documentation
Overview
Section titled “Overview”The TBC CRM API provides programmatic, read-only access to our product catalog, enabling you to sync products and brands into your e-commerce platform, website, or custom application.
It is a Machine-to-Machine (M2M) catalog read/sync API. Creating or editing records — and the entire Quotes and Templates workflow — is reserved for signed-in web-app users and is not available to M2M clients.
Available APIs
Section titled “Available APIs”The M2M API exposes read access to two catalog domains:
Product Catalog API
- Scope:
crm-api/products.read - Access: Read access (list, get-by-id, search) to the product catalog
- Data: Product codes, names, prices, descriptions, images, and more
- Features: Pagination, search, incremental sync (
updatedAfter+syncToken)
Brands API
- Scope:
crm-api/brands.read - Access: Read access (list, get-by-id, search) to product brands
- Data: Brand names, descriptions, metadata
- Features: Search, pagination
Authentication: OAuth 2.0 Client Credentials flow for all APIs
Note for integrators: Request only the two read scopes above. The M2M API is read-oriented for catalog data; creating or editing records and the entire Quotes/Templates workflow are web-app only and are not exposed to M2M. See What’s available via M2M.
Responses are also projected through a fixed, server-owned field set — cost and margin fields are never returned to M2M callers and the set cannot be widened by the caller. See Field policy for the complete list.
Getting Started
Section titled “Getting Started”Ready to integrate? Head over to our Getting Started Guide for step-by-step instructions.
Need API Access?
Section titled “Need API Access?”Your CRM administrator creates M2M credentials for you in the CRM web app under Settings → API Access (see Client Management).
Your administrator will provide you with:
- Client ID and Client Secret
- API base URL and token endpoint
- Appropriate scopes for your use case
- Technical support during integration
Common Use Cases
Section titled “Common Use Cases”WooCommerce Integration
Section titled “WooCommerce Integration”Automatically sync the TBC product catalog to your WooCommerce store:
- Daily product updates
- Automatic pricing synchronization
- Product image management
- Inventory status tracking
Custom Applications
Section titled “Custom Applications”Build custom integrations for:
- Mobile applications
- Internal sales tools
- Custom e-commerce platforms
- Product comparison websites
Support
Section titled “Support”Need help? We’re here to assist:
- Email: support@tbc-app.com
- Response Time: 24-48 hours (business days)
- API Status: https://status.tbc-app.com