Edição de pedido

Quando ocorre ruptura de algum item no estoque, pode ser necessário remover um item de um pedido. Em outros cenários, pode ser necessário alterar alguns detalhes de um item, como por exemplo quando há uma pequena variação no peso de um item. Exemplo: cliente pediu 500g de um item e após a separação o item pesou 490g.

Adicionar um item

Para adicionar um item a um pedido, você deve utilizar a requisição POST /items. Durante o processo de adicionar um item, algumas validações são realizadas, como por exemplo: pedido existente e válido, produto adicionado existente no catálogo de produtos da loja, entre outras. Ao adicionar um item e finalizar a separação com sucesso, o item adicionado pode gerar cobrança adicional. Permitido somente para pedidos White Label.

Modificar um item

Para modificar um item de um pedido, você deve utilizar a requisição POST /items/{uniqueId}. Durante o processo de modificar um item, algumas validações são realizadas, como por exemplo: pedido existente e válido, item é parte de um combo, quantidade atribuída ao item, entre outras. Ao modificar um item e finalizar a separação com sucesso, o item alterado pode gerar cobrança adicional ou estorno.

Substituir um item

Durante o processo de substituir um item, algumas validações são realizadas, como por exemplo: pedido existente e válido, produto adicionado existente no catálogo de produtos da loja, regras de valor do item de acordo com o método de pagamento, entre outras. Ao finalizar a separação com sucesso, o item substituto pode gerar cobrança adicional.

Remover um item

Para remover um item de um pedido, você deve utilizar a requisição DELETE /items/{uniqueId}. Durante o processo de remover um item, algumas validações são realizadas, como por exemplo: pedido existente e válido, item é parte de um combo, entre outras. Em caso de combo, todos os itens do combo serão removidos. Ao remover um item e finalizar a separação com sucesso, o item removido pode gerar estorno.

Observação

Alterações de item só serão aplicadas com a ação de Finalizar Separação. A finalização de separação pode retornar falha em alguns casos, como por exemplo: regras específicas de métodos de pagamento, cobrança adicional não permitida, entre outras. Nesse caso, o fim da separação só será possível alterando o pedido de acordo com a regra.

Ações do Pedido

Início da separação

Para informar o início da separação do pedido, você deve utilizar a requisição POST /startSeparation.

Fim da separação

Para informar o fim da separação do pedido, você deve utilizar a requisição POST /endSeparation.

Ciclo de vida do pedido (Status de Separação)

Fluxo de integração

Critérios de Homologação

Verifique os critérios para realizar sua homologação.

Validação

É importante validar e tratar os erros retornados pela API. Códigos de erro 404, 409 e 500 significam que a edição não foi realizada com sucesso.