Gera o pedido de devolução a partir de um pedido existente

POST 
/orders/:idorder/return

Cria o pedido de devolução a partir de um pedido existente: rateia frete e despesas acessórias entre os itens, monta as movimentações com quantidades negativas e gera o estorno conforme a forma escolhida em RefundMethod — vale para o cliente (VOUCHER), espelho proporcional dos pagamentos do pedido de origem (ORIGINAL) ou um tipo de pagamento específico (TYPE_PAYMENT). No espelho proporcional só entram os recebimentos do pedido de origem que tenham tipo de pagamento definido, valor diferente de zero e que não estejam com status Não lançado; pagamentos e ajustes que não casem com uma forma original bloqueiam a devolução. Quando há valor a estornar, o pedido de devolução é sempre marcado como pedido com pagamento. O número do pedido de origem gravado na devolução é o do canal de venda quando a parametrização Utilizar pedido origem ao criar pedido de devolução ou reenvio está ativa e o pedido tem essa informação; caso contrário é o próprio número do pedido. Pode reverter estoque, gerar recebimento e emitir a nota fiscal de devolução. Retorna o pedido de devolução criado, com o comprovante de troca quando houver.

Request

Responses

200

Pedido de devolução criado — devolve a estrutura completa do pedido criado.

400

Validações de cadastro e do fluxo de estorno (prefixo [BadRequest]). Mensagens: Tipo devolução não existe; Tipo pedido de devolução não existe ou não está configurado corretamente. Precisa cadastrar; Armazém não existe; Tipo categoria devolução não existe; Cliente não existe; Endereço não existe; A opção Gerar vale deve ser informada como Sim ou Não; Forma de estorno inválida. Valores permitidos: VOUCHER, ORIGINAL ou TYPE_PAYMENT; A forma de estorno informada é incompatível com a opção Gerar vale; É obrigatório informar um tipo de pagamento válido para a forma de estorno selecionada; O tipo de pagamento deve ficar vazio para Vale ou Pagamento Original; É obrigatório informar o cliente para gerar vale; Tipo de pagamento não está ativo, habilitado na frente de caixa ou permitido para estorno; Tipo de pagamento para vale não está ativo ou habilitado na frente de caixa; O pedido de origem não possui pagamentos disponíveis para estorno; O pedido de origem não possui valor de pagamento disponível para estorno; O pedido de origem possui ajustes de pagamento que não puderam ser vinculados à forma original; O valor da devolução é maior que o valor pago no pedido de origem. Erros vindos da criação do pedido também chegam com a mensagem original.

Validações do estorno feitas na criação do pedido de devolução: O pedido de origem da devolução não foi encontrado.; O valor dos itens da devolução está inválido.; Selecione uma forma de estorno válida.; A devolução possui valor, mas está configurada para não gerar lançamento financeiro.; Não é possível definir uma forma de estorno para uma devolução sem valor.; Informe o pagamento correspondente à forma de estorno selecionada.; Os dados do pagamento da devolução estão em formato inválido.; Informe o valor do pagamento da devolução.; O valor do pagamento da devolução deve ser negativo.; Configure um tipo de pagamento para a geração de vale.; O vale deve possuir exatamente um lançamento financeiro.; O tipo de pagamento configurado para o vale não foi encontrado. Revise o cadastro do tipo de pagamento.; Ative o tipo de pagamento configurado para o vale.; Configure o tipo de pagamento do vale na categoria Crédito na Loja.; A categoria do tipo de pagamento selecionado não está configurada para vale.; Informe o tipo de pagamento do vale.; O tipo de pagamento do lançamento financeiro não corresponde ao vale configurado.; A opção "Gerar vale na devolução" deve estar habilitada no cadastro de Tipo Pedido.; É obrigatório informar o cliente para gerar o vale da devolução.; A opção Gerar vale não pode ser combinada com outra forma de estorno.; Pagamento Original não pode ser combinado com outra forma de estorno.; O pedido de origem não possui uma forma de pagamento disponível para estorno.; O pagamento da devolução não possui uma forma de pagamento original.; A forma de pagamento original não está disponível para estorno.; A forma de estorno selecionada deve possuir exatamente um lançamento financeiro.; A forma de estorno selecionada não foi encontrada.; A forma de estorno selecionada está inativa. Selecione outra forma de estorno.; Selecione uma forma de estorno das categorias Dinheiro, Cheque, Depósito Bancário, Pix ou Outros.; Informe o tipo de pagamento da forma de estorno selecionada.; O tipo de pagamento do lançamento financeiro não corresponde à forma de estorno selecionada.; O valor do estorno não corresponde ao valor da devolução.; Valor do vale compras é acima do disponível para a loja: <valor>.

404

Pedido original inexistente. Mensagem: [NotFound] - Pedido não encontrado.

500

Erro interno. Prefixo Error:.