ENUMs da API

Nesta página, você encontrará os valores pré definidos (ENUMs) da API do Koncili.

---

Esta documentação descreve todos os tipos enumerados (ENUMs) utilizados na API Marketplace, incluindo seus valores possíveis, significados e endpoints relacionados.

Visão geral dos ENUMs

Os ENUMs são utilizados para padronizar:

• Status de pedidos
• Métodos de pagamento
• Tipos de lançamentos financeiros
• Outros campos com valores pré-definidos

Como utilizar

Sempre referencie os valores exatos como documentados abaixo, incluindo maiúsculas e underlines.

Importante

Ao integrar com a API:

• Consulte esta documentação para os valores ENUMs aceitos em cada endpoint
• Valide os valores antes de enviá-los à API
• Implemente tratamento adequado para respostas com ENUMs desconhecidos
• Atualize periodicamente sua implementação conforme novas versões dos ENUMs

Descrição dos ENUMs

Status de pedido

Valor ENUM	Descrição	Endpoints Relacionados
INVOICED	Pedido faturado	POST /order GET /order POST /reconciliation
PAID_WAITING_DELIVERY	Pagamento confirmado, aguardando entrega	POST /order GET /order POST /reconciliation
CONCLUDED	Pedido concluído com sucesso	POST /order GET /order POST /reconciliation
CANCELED	Pedido cancelado	POST /order GET /order POST /reconciliation

Formas de pagamento

Valor ENUM	Descrição	Endpoints Relacionados
IN_CASH	Pagamento à vista	POST /order GET /order

Tipos de lançamentos financeiros

Valor ENUM	Descrição	Endpoints Relacionados
COMISSION	Comissão sobre venda	POST /order GET /order POST /reconciliation
SHIP	Frete	POST /order GET /order POST /reconciliation
RETURN_COMISSION	Devolução de comissão	POST /order GET /order POST /reconciliation
RETURN_SHIP	Devolução de frete	POST /order GET /order POST /reconciliation
SALE	Venda direta	POST /order GET /order POST /reconciliation
ADJUSTMENT	Ajuste	POST /order GET /order POST /reconciliation

Tipos de notificação

Valor ENUM	Descrição	Endpoints Relacionados
TEST_NOTIFICATION	Teste da url cadastrada	POST na URL do integrador
ACCOUNT_CREATED	Conta criada	POST na URL do integrador
RECONCILIATION_COMPLETED	Conciliação finalizada	POST na URL do integrador
BLOCKED_TEMPORARY	Bloqueio temporário	POST na URL do integrador
BLOCKED_PERMANENT	Bloqueio permanente	POST na URL do integrador
UNLOCKED	Desbloqueio	POST na URL do integrador