Enterprise API
Versioned REST API for ERP sync. Authenticate with Authorization: Bearer gcn_live_… or gcn_test_…. Create keys in your Business dashboard.
New here? Start with the partner onboarding checklist.
Base URL
/api/v1Machine-readable OpenAPI: /api/v1/openapi
Postman collection: Download / import
Core endpoints
GET /me— org + scopesGET|POST /listings,/listings/bulkGET|POST /inventory,/inventory/bulk(syncMode: upsert|replace)/freight,/freight/bulk·/depots,/depots/bulk·/manufacturers,/manufacturers/bulk·/ports,/ports/bulk/inquiries,/inquiries/{id}/reply/organization,/webhooks,/bulk/{jobId}
Scopes
New keys receive all scopes. Fine-grained restriction is available via the data model.
listings:readlistings:writeinventory:readinventory:writefreight:readfreight:writedepots:readdepots:writemanufacturers:readmanufacturers:writeports:readports:writeinquiries:readinquiries:writeorg:readorg:writewebhooks:managebulk:write
Partner quickstart
Step-by-step curl examples for catalog sync (all modules), inquiries and webhooks:
docs/api-partner-guide.mdReadiness probe: /api/v1/ready
Notes
- Unverified orgs: creates stay
PENDINGuntil admin approves. - Verified orgs: API creates/updates auto-publish as
ACTIVE. - Use
externalId+Idempotency-Keyfor safe ERP retries. - Bulk max 200 items/request; webhooks retry up to 3 times with backoff.
- Webhooks are HMAC-signed (
x-gcn-signature,x-gcn-timestamp).