Fluxo de pedidos

Nesta página, você encontrará os detalhes sobre os fluxos de pedidos na API do Koncili.

---

Envio de pedido

• Novo pedido: identificado e enviado pelo integrador. Só serão aceitos pedidos a partir do status INVOICED (faturado)
• Atualização de pedido: qualquer mudança relevante, como status ou valores, também deve ser enviada como um novo request completo
• API Koncili: valida, processa e encaminha os dados
• Koncili: armazena as informações e prepara os dados para conciliação

Validações

A requisição enviada via POST /order passa por diversas etapas de validação antes de ser aceita:

1. Validação do canal (account):
   A conta informada no payload deve estar habilitada para importações via API. Caso contrário, a requisição será rejeitada

2. Validação do tipo de lançamento:
   O campo type contido na lista de extracts aceita 3 valores válidos (SALE, COMISSION e SHIP). Qualquer outro valor resultará em erro

3. Validação de datas:
   As datas no payload devem ser consistentes. Isso inclui a ordem cronológica dos eventos e a presença de campos obrigatórios com base no status do pedido

4. Validação de status do pedido (status): Os status de pedidos aceitos incluem INVOICED, PAID_WAITING_DELIVERY, CONCLUDED e CANCELED

   Para cada status, os seguintes campos são obrigatórios:

   Status	Datas obrigatórias
   INVOICED	Nenhum adicional obrigatório
   PAID_WAITING_DELIVERY	sendDate, estimatedDeliveryDate
   CONCLUDED	sendDate, estimatedDeliveryDate, deliveryDate
   CANCELED	cancelDate

Boas práticas

Os pedidos devem ser enviados via operação POST e em qualquer alteração que o pedido sofrer deverá ser realizado um novo request, no mesmo end-point, contendo todas as informações referentes ao pedido.

Consulta de pedido

A operação GET permite consultar os detalhes de um pedido previamente enviado ao Koncili.
Pode ser usada para verificação de dados, sincronização entre sistemas ou validação do status de envio.

Atualização de status

As atualizações são consolidadas a cada 30 minutos.
Caso sua consulta não reflita a realidade do pedido, repita a consulta após este intervalo.

Validações

A requisição enviada via GET /order passa por diversas etapas de validação antes de ser aceita:

1. Validação do canal (account):
   A conta informada na request deve estar habilitada para importações via API. Caso contrário, a requisição será rejeitada

2. Consulta do pedido:
   O pedido consultado deve existir no Koncili. Se não for encontrado, a requisição retornará um erro

Deleção de pedido

A operação DELETE permite remover um pedido previamente enviado ao Koncili.

Validações

A requisição enviada via DELETE /order passa por diversas etapas de validação antes de ser aceita:

1. Validação do canal (account):
   A conta informada na request deve estar habilitada para importações via API. Caso contrário, a requisição será rejeitada

2. Consulta do pedido:
   O pedido consultado deve existir no Koncili. Se não for encontrado, a requisição retornará um erro

3. Verifica se o pedido foi importado via API:
   O pedido deve ter sido enviado via API. Se não for o caso, a requisição retornará um erro

4. Verifica se o pedido está conciliado:
   O pedido não pode estar conciliado. Se estiver, a requisição retornará um erro

Importante!

A deleção de pedidos deve ser feita com cautela, pois uma vez removido, o pedido não poderá ser recuperado.