EntrarCadastrar

API empresarial

API REST versionada para sync ERP. Autentique com Authorization: Bearer gcn_live_… ou gcn_test_…. Crie chaves no painel Business.

Novo aqui? Comece pelo checklist de onboarding de parceiros.

URL base

/api/v1

OpenAPI legível por máquina: /api/v1/openapi

Coleção Postman: Baixar / importar

Endpoints principais

  • GET /me — org + scopes
  • GET|POST /listings, /listings/bulk
  • GET|POST /inventory, /inventory/bulk (syncMode: upsert|replace)
  • /freight, /freight/bulk · /depots, /depots/bulk · /storage, /storage/bulk · /manufacturers, /manufacturers/bulk · /ports, /ports/bulk
  • /inquiries, /inquiries/{id}/reply
  • /organization, /webhooks, /bulk/{jobId}

Scopes

Novas chaves recebem todos os scopes. Restrição fina via o modelo de dados.

  • listings:read
  • listings:write
  • inventory:read
  • inventory:write
  • freight:read
  • freight:write
  • depots:read
  • depots:write
  • storage:read
  • storage:write
  • manufacturers:read
  • manufacturers:write
  • ports:read
  • ports:write
  • inquiries:read
  • inquiries:write
  • org:read
  • org:write
  • webhooks:manage
  • bulk:write

Início rápido para parceiros

Exemplos curl passo a passo para sync de catálogo (todos os módulos), consultas e webhooks:

docs/api-partner-guide.md

Sonda de prontidão: /api/v1/ready

Notas

  • Orgs não verificadas: criações ficam PENDING até aprovação admin.
  • Orgs verificadas: criações/atualizações API publicam ACTIVE automaticamente.
  • Use externalId + Idempotency-Key para retries ERP seguros.
  • Bulk máx. 200 itens/requisição; webhooks até 3 retries com backoff.
  • Webhooks assinados HMAC (x-gcn-signature, x-gcn-timestamp).

Verificando…