Overview
The Consentio Partner API enables external systems (ERPs, middleware, integrations) to interact with Consentio workspaces for managing products, orders, clients, and pricing.
Capabilities
| Feature | Supported | Notes |
|---|---|---|
| Products | Yes | Bulk create/update, base prices |
| Orders | Yes | Export, external sync, promoted |
| Clients | Yes | Counterpart mapping, addresses |
| Price Groups | Yes | Sync pricing tiers |
| Purchase Needs | Yes | Procurement demand management |
| CSV Import | Yes | Products and prices |
| JSON Import | Yes | All resources |
Environments
| Environment | Base URL | Purpose |
|---|---|---|
| Production | https://api.consentio.co |
Live environment |
| Staging | https://staging.api.consentio.co |
UAT testing |
| Sandbox | https://sandbox.api.consentio.co |
Integration testing, demo envs |
Key Concepts
Workspace
A workspace represents a seller's product catalog in Consentio. The workspaceID path parameter is required by most endpoints and identifies which workspace you are operating on.
Counterparts
External client identifiers from your ERP system that map to Consentio clients. Counterparts allow bidirectional sync between your ERP client records and Consentio's user base.
Personas
The API serves two integration personas:
- Seller: Manages their workspace catalog, pricing, client mappings, and processes incoming sale orders. See Seller Guide.
- Buyer: Creates purchase orders and submits procurement demands. See Buyer Guide.
Getting Started
1. Request Integration Access
Contact your Consentio account manager to enable Partner API access. You will receive:
- An API key for your workspace
- Access to the sandbox environment
2. Authenticate
Use your API key to obtain JWT tokens. See Authentication for the full flow.
POST /v2/partner/{workspaceID}/login
3. Start Integrating
Choose the guides relevant to your role:
Seller integrations:
- Products - Import and manage your catalog
- Price Groups - Sync pricing tiers
- Clients - Map ERP counterparts
- Orders (Seller) - Export and process sale orders
Buyer integrations:
- Orders (Buyer) - Create and retrieve purchase orders
- Purchase Needs - Submit procurement demands
Public Endpoints
The following endpoints do not require authentication:
| Endpoint | Method | Description |
|---|---|---|
/v2/partner/{workspaceID}/login |
POST | Authenticate with API key |
/v2/partner/export/template/methods |
GET | Get export templates |
/v2/partner/{workspaceID}/order/{hashID}/prepare |
POST | Mark order as prepared |
Support
- Technical Support: tech@consentio.co
- Documentation Issues: Open an issue in your integration project
API Reference
The complete OpenAPI specification is available in the API Reference tab.
