Actions34
- Cliente Actions
- Catálogo Actions
- Pedido Actions
- Conversa Actions
- Contexto Actions
- Telemetria Actions
- Canal WhatsApp Actions
- Paciente Actions
- Procedimento Actions
- Agenda Actions
- Agendamento Actions
- Lembrete Odonto Actions
Pedido → Alterar
AI-generatedSummary
Alterar um pedido existente, modificando suas propriedades como agendamento, itens, forma de pagamento, taxa, desconto, cobranças, observações e endereço de entrega; usa idempotência para evitar duplicações.
Inputs
- Pedido ID (required) — UUID do pedido a ser alterado, válido para o tenant atual.
- Observações — Texto para atualizar as observações do pedido.
- Agendado Para — Nova data/hora ISO 8601 para agendamento; vazio para não alterar.
- Tipo de Entrega (alterar) — Muda a modalidade do pedido para 'retirada' ou 'entrega'; se mudar para entrega deve-se preencher também o endereço de entrega.
- Endereço de Entrega (JSON) — Objeto JSON com dados do endereço para entrega incluindo logradouro e cidade obrigatórios; não pode ser usado se modalidade final for retirada.
- Adicionar Itens (JSON) — Array JSON de itens a adicionar com produto e configuração obrigatória; pedido recusado se item incompleto.
- Remover Itens (IDs) — IDs dos itens a remover, separados por vírgula ou JSON array.
- Alterar Quantidade de Itens (JSON) — Array JSON com alterações absolutas de quantidade por item_id já existente no pedido.
- Ajustar Itens por Produto (JSON) — Array JSON para ajuste relativo (incrementar/decrementar) de quantidade por produto_id.
- Definir Itens por Produto (JSON) — Array JSON para definir quantidade absoluta por produto_id, removendo a linha se zero.
- Remover Produtos (produto_ids) — IDs de produtos para remover completamente do pedido, separados por vírgula ou JSON array.
- Forma de Pagamento (alterar) — Nova forma de pagamento para o pedido (PIX, cartão, dinheiro); vazio para não alterar.
- Troco Para (alterar) — Valor da nota que o cliente entregará em dinheiro (maior ou igual ao valor do pedido); só enviado se forma de pagamento for dinheiro.
- Taxa de Entrega (alterar) — Valor da taxa de entrega a aplicar; vazio para não alterar, use zero para zerar.
- Desconto (alterar) — Valor do desconto a aplicar; vazio para não alterar, use zero para zerar.
- Cobranças Comerciais (JSON) — Array JSON que substitui as cobranças comerciais do pedido, incluindo adicionais pagos referenciados pela chave da regra e revisão operacional.
- Idempotency Key — Chave para garantir idempotência da operação; use a mesma chave para tentativas de alteração para evitar reaplicações duplicadas.
- Token ID Dinamico — Token retornado pelo bootstrap multi-tenant para uso com signing secret dinâmico.
- Signing Secret Dinamico — Segredo efêmero de assinatura para uso com token dinâmico; não deve ser registrado em logs.
Output shape
Objeto JSON com resposta do servidor contendo detalhes atualizados do pedido ou mensagem de erro.
Usa HTTP PATCH para envio das alterações; idempotência previne duplicação. Mensagens de erro HTTP 4xx/5xx retornam exceção, salvo falha com continueOnFail ativo, que retorna erro para o item. Pedido deve pertencer ao tenant identificado pelo token.