Clients & Counterparts

Overview

Counterparts map your ERP client identifiers to Consentio clients. As a seller, you sync your customer records so that orders can be linked back to your ERP and clients see the correct pricing tier.

Endpoints

Method Endpoint Description
GET /v2/partner/{workspaceID}/client List all counterparts
POST /v2/partner/{workspaceID}/client Create/update counterparts
GET /v2/partner/{workspaceID}/client/address List counterpart addresses
POST /v2/partner/{workspaceID}/client/address Create/update addresses
GET /v2/partner/export/template/methods Get export templates (public)

Counterparts

A counterpart record holds the client_external_id from your ERP, the client name, phone numbers, and a rate_id that links the client to a price group. Once mapped, Consentio populates the consentio_client_id to link the external record to a Consentio user.

Counterparts are matched by client_external_id on upsert.

Addresses

Addresses are linked to counterparts via client_external_id and are used as delivery and pickup locations on orders. Each address includes standard fields (street, city, postal code, country) plus optional coordinates and an external_id for ERP reference.

Export Templates

The GET /export/template/methods endpoint is public (no auth required) and returns the list of available export template method names. Use this to discover which export formats are configured for your integration.

Integration Workflow

Initial Sync

  1. Export clients from your ERP
  2. POST counterparts with client_external_id and rate_id
  3. POST addresses for each counterpart
  4. Verify by retrieving with GET

Ongoing Sync

  • Schedule regular syncs to keep counterpart data current
  • Update rate_id when a client's pricing tier changes
  • Update addresses when delivery locations change