Introdução
Bem vindo ao guia de referência da API do Kapsula!
Através desta API você poderá integrar seu sistema com o nosso.
No momento, as integrações possíveis são com pedidos e clientes, mais detalhes serão descritos no decorrer deste documento sobre como proceder para utilizar os recursos.
A primeira coisa que você precisa saber é o endereço de endpoint usado:
https://ev.kapsula.com.br/api/v1
Importante: Toda comunicação com a API sobre os valores monetários é feita em centavos, dessa forma para ter o valor correto realize sua divisão por 100 e para enviar um valor monetário multiplique-o por 100.
Possíveis Status dos Pedidos, código e descrição:
| Código | Descrição |
|---|
| 1 | Pendente |
| 2 | Aguardando Faturamento |
| 3 | Faturado |
| 4 | Em Preparação |
| 5 | Devolvido |
| 6 | Estornado |
| 7 | Enviado |
| 8 | Parado |
| 9 | Cancelado |
| 10 | Faturamento Agendado |
| 11 | Correção |
| 12 | Pedidos Agregado (Upsell) |
| 13 | Falha no Faturamento |
| 14 | Entregue |
| 15 | Reenviado |
Possíveis motivos para o pedido estar com status de Parado, código e descrição:
| Código | Descrição |
|---|
| 1 | Falta de Estoque |
| 2 | Falta de Crédito |
| 3 | Não Conseguiu Contato |
| 4 | A pedido do produtor |
| 5 | Erro fiscal |
| 6 | Tipo De Emissão não Configurado |
Possíveis motivos para o pedido estar com status de Devolvido, código e descrição:
| Código | Descrição |
|---|
| 1 | Endereço Incorreto |
| 2 | Cliente Insatisfeito |
Possíveis status dos pacotes, código e descrição:
| Código | Descrição |
|---|
| 0 | Pacote pendente |
| 1 | Pacote ativo |
| 2 | Pacote desabilitado |
Possíveis status dos produtos, código e descrição:
| Código | Descrição |
|---|
| 0 | Produto pendente |
| 1 | Produto aprovado |
