Global Container Network
रजिस्टर करें

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/v1

Machine-readable OpenAPI: /api/v1/openapi

Postman collection: Download / import

Core endpoints

  • GET /me — org + scopes
  • GET|POST /listings, /listings/bulk
  • GET|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:read
  • listings:write
  • inventory:read
  • inventory:write
  • freight:read
  • freight:write
  • depots:read
  • depots:write
  • manufacturers:read
  • manufacturers:write
  • ports:read
  • ports:write
  • inquiries:read
  • inquiries:write
  • org:read
  • org:write
  • webhooks:manage
  • bulk:write

Partner quickstart

Step-by-step curl examples for catalog sync (all modules), inquiries and webhooks:

docs/api-partner-guide.md

Readiness probe: /api/v1/ready

Notes

  • Unverified orgs: creates stay PENDING until admin approves.
  • Verified orgs: API creates/updates auto-publish as ACTIVE.
  • Use externalId + Idempotency-Key for 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).

जाँच हो रही है…