O que faz #
Atualiza o status de um pedido e, opcionalmente, forma de pagamento, parcelas, comprovante, rastreio e nota fiscal. Cancelar devolve o estoque à loja.
Requisição #
| Método | POST |
| URL | https://api.viashopmoda.com.br/via/pedido/atualizar/{TOKEN} |
| Corpo | Objeto JSON { ... }, cabeçalho Content-Type: application/json |
| Token | Substitua {TOKEN} pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. |
Campos #
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pedido.numero_pedido | texto | sim | Número do pedido na loja (6 dígitos). |
pedido.status_pedido | texto | sim | Nome exato de um status (tabela abaixo). |
pedido.forma_pagamento | texto | não | Nome exato de uma forma de formas_pagamento/consultar. Sem ele, mantém a atual. |
pedido.fixar_pagamento | texto | não | "Sim" obriga o cliente a pagar com essa forma. |
pedido.url_notafiscal | texto | não | URL da nota fiscal. |
subpedido.parcelas_pagamento | número | não | Parcelas. |
subpedido.numero_comprovante | texto | não | Comprovante de pagamento. |
subpedido.rastreio_frete | texto | não | Código de rastreio. |
Os campos de subpedido também são aceitos dentro de pedido.
Status aceitos #
Use o texto exatamente assim:
| Status | Conta como pago? |
|---|---|
Pedido em análise | não |
Aguardando Pagamento | não |
Falha na tentativa de pagamento | não |
Pagamento efetuado, aguardando captura | sim |
Pagamento autorizado, aguardando envio | sim |
Pedido em transporte | sim |
Pedido entregue | sim |
Pedido cancelado | — |
Aguardando Pagamentotem o "P" maiúsculo. Os códigosAN,PG,EN… valem só empedido/cadastrar, não aqui.
Regras #
Pedido canceladodevolve ao estoque da loja os itens que tinham sido baixados.- Um pedido cancelado pode voltar a outro status; a loja anota a mudança nas observações.
- As datas de cada etapa são gravadas com a data do dia da atualização.
Exemplo #
{
"pedido": {
"numero_pedido": "111111",
"status_pedido": "Pedido em transporte"
},
"subpedido": {
"rastreio_frete": "BR123456789BR"
}
}{
"retorno": true,
"msg": "Pedido '111111' atualizado com sucesso.",
"numero_pedido": "111111",
"status_antigo": "Pagamento autorizado, aguardando envio",
"status_novo": "Pedido em transporte"
}Recusas (HTTP 200 com retorno: false):
| Mensagem | Causa |
|---|---|
POST do pedido deve ser um object (...) | Corpo não é objeto. |
'status_pedido' não encontrado / 'status_pedido' não pode ser vazio | Falta o status. |
Status 'X' não encontrado ou não existe | Grafia diferente da tabela. |
Pode reenviar? #
Sim. Reenviar o mesmo status não muda nada além das datas da etapa.
Onde entra no processo #
Guia Pedidos.