Cancelar pedido

POST /api/v1/pedidos/{id}/cancelar

Cancela um pedido que ainda não possui data_saida e não está em estado final. Pedidos do Mercado Livre e pedidos com documento fiscal emitido não podem ser cancelados pelo produtor.

POST Requisição

bash

curl -X POST "https://ev.paylog.cash/api/v1/pedidos/{id}/cancelar" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "motivo": "string"
  }'

php

use Illuminate\Support\Facades\Http;

$response = Http::withToken('YOUR_TOKEN')
    ->acceptJson()
    ->post('https://ev.paylog.cash/api/v1/pedidos/{id}/cancelar', [
    'motivo' => 'string'
  ]);

javascript

const response = await fetch("https://ev.paylog.cash/api/v1/pedidos/{id}/cancelar", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "motivo": "string"
  }),
});

python

import requests

response = requests.post(
    "https://ev.paylog.cash/api/v1/pedidos/{id}/cancelar",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
    "motivo": "string"
  },
)

ruby

require "net/http"
require "json"
require "uri"

uri = URI("https://ev.paylog.cash/api/v1/pedidos/{id}/cancelar")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = {
  "motivo" => "string"
}.to_json

response = http.request(request)

200 Resposta

json

{
  "code": 0,
  "message": "string",
  "pedido": {
    "id": 0,
    "referencia_externa": "string",
    "codigo_transacao": "string",
    "status": "string",
    "status_code_id": 0,
    "motivo_parado_id": 0,
    "motivo_devolucao_id": 0,
    "frete": 0,
    "data_saida": "2024-01-01T00:00:00Z",
    "data_entrega": "string",
    "created_at": "string",
    "updated_at": "string",
    "qnt_itens": 0,
    "itens": [
      {
        "id": 0,
        "pedido_id": 0,
        "quantidade": 0,
        "valor_unitario": 0,
        "subtotal": 0,
        "pacote_id": 0,
        "codigo_plataforma": "string",
        "descricao": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "documentos_fiscais": [
      {
        "tipo": "nfe_danfe",
        "formato": "pdf",
        "nome": "string",
        "url": "https://example.com",
        "chave": "string",
        "numero": 0
      }
    ],
    "cliente": {
      "id": 0,
      "nome": "string",
      "email": "[email protected]",
      "cpf": "string",
      "data_nascimento": "2024-01-01T00:00:00Z",
      "endereco": "string",
      "cep": "string",
      "numero": "string",
      "complemento": "string",
      "estado": "string",
      "bairro": "string",
      "cidade": "string",
      "pais": "string",
      "celular": "string",
      "telefone": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "referencia_externa": "string"
    },
    "transportadora": {
      "codigo": "string",
      "nome": "string"
    },
    "rastreamento": {
      "codigo": "string",
      "transportadora": {
        "codigo": "string",
        "nome": "string"
      },
      "servico": "string",
      "url_rastreamento": "https://example.com",
      "url_transportadora": "https://example.com",
      "status": {
        "codigo": 0,
        "descricao": "string"
      },
      "comprovante_entrega": {
        "imagem_url": "https://example.com",
        "assinatura_url": "https://example.com",
        "recebido_por": "string",
        "signatario": "string"
      }
    }
  }
}

Corpo da requisição

application/json

object

Corpo opcional dos comandos de cancelamento e pausa.

motivo string aceita nulo

Motivo opcional registrado para auditoria.

Respostas

200

Comando executado e pedido atualizado.

application/json

object

code integer Obrigatório
message string Obrigatório

Mensagem correspondente ao comando executado.
pedido object Obrigatório
- id integer Obrigatório
- referencia_externa string aceita nulo Obrigatório
  
  Referência informada pelo produtor.
- codigo_transacao string aceita nulo Obrigatório
  
  Código da transação na plataforma de origem.
- status string Obrigatório
  
  Rótulo atual do status.
- status_code_id integer Obrigatório
  
  Código numérico do status.
- motivo_parado_id integer aceita nulo Obrigatório
  
  Motivo atual quando o pedido está parado.
- motivo_devolucao_id integer aceita nulo Obrigatório
  
  Motivo atual quando o pedido foi devolvido.
- frete integer aceita nulo Obrigatório
  
  Valor cobrado pelo frete em centavos.
- data_saida string date-time aceita nulo Obrigatório
  
  Data e hora da expedição; null antes do bip de saída.
- data_entrega string aceita nulo Obrigatório
  
  Data de entrega quando registrada.
- created_at string Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
- updated_at string Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
- qnt_itens integer Obrigatório
  
  Soma das quantidades dos itens.
- itens array Obrigatório
  
  Itens
  
  object
  
  id integer Obrigatório
  
  pedido_id integer Obrigatório
  
  quantidade integer Obrigatório
  
  valor_unitario integer Obrigatório
  
  Valor unitário em centavos.
  
  subtotal integer Obrigatório
  
  Subtotal em centavos.
  
  pacote_id integer aceita nulo Obrigatório
  
  codigo_plataforma string aceita nulo Obrigatório
  
  descricao string aceita nulo Obrigatório
  
  created_at string aceita nulo Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
  
  updated_at string aceita nulo Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
- documentos_fiscais array Obrigatório
  
  Documentos disponíveis para o pedido. NF-e gera entradas separadas para DANFE e XML; Declaração de Conteúdo e DACE aparecem somente quando registrados.
  
  Itens
  
  object
  
  tipo string Obrigatório
  
  Tipo público do documento fiscal.
  
  Valores permitidos nfe_danfe nfe_xml mini_danfe declaracao_conteudo dace
  
  formato string Obrigatório
  
  Valores permitidos pdf xml
  
  nome string Obrigatório
  
  Nome legível do documento.
  
  url string uri Obrigatório
  
  URL pública para baixar o documento.
  
  chave string aceita nulo Obrigatório
  
  Chave fiscal quando disponível.
  
  numero integer aceita nulo Obrigatório
  
  Número fiscal quando disponível.
- cliente object Obrigatório
  
  id integer Obrigatório
  
  nome string aceita nulo Obrigatório
  
  email string email aceita nulo Obrigatório
  
  cpf string aceita nulo Obrigatório
  
  data_nascimento string date-time aceita nulo Obrigatório
  
  endereco string aceita nulo Obrigatório
  
  cep string aceita nulo Obrigatório
  
  numero string aceita nulo Obrigatório
  
  complemento string aceita nulo Obrigatório
  
  estado string aceita nulo Obrigatório
  
  bairro string aceita nulo Obrigatório
  
  cidade string aceita nulo Obrigatório
  
  pais string aceita nulo Obrigatório
  
  celular string aceita nulo Obrigatório
  
  telefone string aceita nulo Obrigatório
  
  created_at string date-time aceita nulo Obrigatório
  
  updated_at string date-time aceita nulo Obrigatório
  
  referencia_externa string aceita nulo Obrigatório
- transportadora mixed Obrigatório
  
  Uma das opções
  
  object
  
  codigo string Obrigatório
  
  nome string Obrigatório
  
  null
- rastreamento mixed Obrigatório
  
  Uma das opções
  
  object
  
  Estado mais recente do rastreamento. Consulte o endpoint dedicado de rastreamento para obter a linha do tempo completa.
  
  codigo string Obrigatório
  
  transportadora mixed Obrigatório
  
  Uma das opções
  
  object
  
  codigo string Obrigatório
  
  nome string Obrigatório
  
  null
  
  servico string aceita nulo Obrigatório
  
  url_rastreamento string uri aceita nulo Obrigatório
  
  Página pública de rastreamento da Paylog; funciona para qualquer transportadora.
  
  url_transportadora string uri aceita nulo Obrigatório
  
  Página da própria transportadora, quando ela oferece uma URL por código.
  
  status mixed Obrigatório
  
  Uma das opções
  
  object
  
  codigo integer Obrigatório
  
  descricao string Obrigatório
  
  null
  
  comprovante_entrega mixed Obrigatório
  
  Uma das opções
  
  object
  
  Comprovante de entrega enviado pela transportadora, disponível somente após a entrega. Cada transportadora envia um conjunto diferente: a J&T Express envia as duas imagens (foto e assinatura) mais o signatário; os Correios enviam apenas a foto e o recebedor.
  
  imagem_url string uri Obrigatório
  
  Foto da entrega ou do recibo assinado.
  
  assinatura_url string uri aceita nulo Obrigatório
  
  Imagem da assinatura eletrônica, quando a transportadora coleta uma.
  
  recebido_por string aceita nulo Obrigatório
  
  Nome de quem recebeu o objeto.
  
  signatario string aceita nulo Obrigatório
  
  Quem assinou, por exemplo "porteiro".
  
  null
  
  null

401

Token inválido, pedido inexistente ou pedido fora da conta autenticada.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.

403

O token é válido, mas a conta não possui a permissão necessária para esta operação. O envelope é gerado pelo tratador global de exceções e usa a chave errors (string), não message.

application/json

object

Envelope produzido pelo tratador global de exceções para falhas HTTP que não são geradas pelos controladores — principalmente 403 (permissão ausente) e 405 (verbo não suportado). Difere dos erros dos controladores por usar errors no lugar de message.

errors string Obrigatório

Mensagem da exceção HTTP.
code integer Obrigatório

Código HTTP repetido no corpo.

422

O estado atual impede o comando, ou o corpo enviado é inválido. Na recusa por estado o corpo é o MESMO envelope do sucesso e inclui a chave pedido com o pedido inalterado — a presença de pedido não indica sucesso; use o código HTTP ou o campo code.

application/json

mixed

Uma das opções

object

Recusa por estado. Mesmo envelope do sucesso, com code 422 e o pedido inalterado em pedido.

code integer Obrigatório
message string Obrigatório

Motivo da recusa.
pedido object Obrigatório
- id integer Obrigatório
- referencia_externa string aceita nulo Obrigatório
  
  Referência informada pelo produtor.
- codigo_transacao string aceita nulo Obrigatório
  
  Código da transação na plataforma de origem.
- status string Obrigatório
  
  Rótulo atual do status.
- status_code_id integer Obrigatório
  
  Código numérico do status.
- motivo_parado_id integer aceita nulo Obrigatório
  
  Motivo atual quando o pedido está parado.
- motivo_devolucao_id integer aceita nulo Obrigatório
  
  Motivo atual quando o pedido foi devolvido.
- frete integer aceita nulo Obrigatório
  
  Valor cobrado pelo frete em centavos.
- data_saida string date-time aceita nulo Obrigatório
  
  Data e hora da expedição; null antes do bip de saída.
- data_entrega string aceita nulo Obrigatório
  
  Data de entrega quando registrada.
- created_at string Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
- updated_at string Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
- qnt_itens integer Obrigatório
  
  Soma das quantidades dos itens.
- itens array Obrigatório
  
  Itens
  
  object
  
  id integer Obrigatório
  
  pedido_id integer Obrigatório
  
  quantidade integer Obrigatório
  
  valor_unitario integer Obrigatório
  
  Valor unitário em centavos.
  
  subtotal integer Obrigatório
  
  Subtotal em centavos.
  
  pacote_id integer aceita nulo Obrigatório
  
  codigo_plataforma string aceita nulo Obrigatório
  
  descricao string aceita nulo Obrigatório
  
  created_at string aceita nulo Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
  
  updated_at string aceita nulo Obrigatório
  
  Timestamp serializado como YYYY-MM-DD HH:mm:ss.
- documentos_fiscais array Obrigatório
  
  Documentos disponíveis para o pedido. NF-e gera entradas separadas para DANFE e XML; Declaração de Conteúdo e DACE aparecem somente quando registrados.
  
  Itens
  
  object
  
  tipo string Obrigatório
  
  Tipo público do documento fiscal.
  
  Valores permitidos nfe_danfe nfe_xml mini_danfe declaracao_conteudo dace
  
  formato string Obrigatório
  
  Valores permitidos pdf xml
  
  nome string Obrigatório
  
  Nome legível do documento.
  
  url string uri Obrigatório
  
  URL pública para baixar o documento.
  
  chave string aceita nulo Obrigatório
  
  Chave fiscal quando disponível.
  
  numero integer aceita nulo Obrigatório
  
  Número fiscal quando disponível.
- cliente object Obrigatório
  
  id integer Obrigatório
  
  nome string aceita nulo Obrigatório
  
  email string email aceita nulo Obrigatório
  
  cpf string aceita nulo Obrigatório
  
  data_nascimento string date-time aceita nulo Obrigatório
  
  endereco string aceita nulo Obrigatório
  
  cep string aceita nulo Obrigatório
  
  numero string aceita nulo Obrigatório
  
  complemento string aceita nulo Obrigatório
  
  estado string aceita nulo Obrigatório
  
  bairro string aceita nulo Obrigatório
  
  cidade string aceita nulo Obrigatório
  
  pais string aceita nulo Obrigatório
  
  celular string aceita nulo Obrigatório
  
  telefone string aceita nulo Obrigatório
  
  created_at string date-time aceita nulo Obrigatório
  
  updated_at string date-time aceita nulo Obrigatório
  
  referencia_externa string aceita nulo Obrigatório
- transportadora mixed Obrigatório
  
  Uma das opções
  
  object
  
  codigo string Obrigatório
  
  nome string Obrigatório
  
  null
- rastreamento mixed Obrigatório
  
  Uma das opções
  
  object
  
  Estado mais recente do rastreamento. Consulte o endpoint dedicado de rastreamento para obter a linha do tempo completa.
  
  codigo string Obrigatório
  
  transportadora mixed Obrigatório
  
  Uma das opções
  
  object
  
  codigo string Obrigatório
  
  nome string Obrigatório
  
  null
  
  servico string aceita nulo Obrigatório
  
  url_rastreamento string uri aceita nulo Obrigatório
  
  Página pública de rastreamento da Paylog; funciona para qualquer transportadora.
  
  url_transportadora string uri aceita nulo Obrigatório
  
  Página da própria transportadora, quando ela oferece uma URL por código.
  
  status mixed Obrigatório
  
  Uma das opções
  
  object
  
  codigo integer Obrigatório
  
  descricao string Obrigatório
  
  null
  
  comprovante_entrega mixed Obrigatório
  
  Uma das opções
  
  object
  
  Comprovante de entrega enviado pela transportadora, disponível somente após a entrega. Cada transportadora envia um conjunto diferente: a J&T Express envia as duas imagens (foto e assinatura) mais o signatário; os Correios enviam apenas a foto e o recebedor.
  
  imagem_url string uri Obrigatório
  
  Foto da entrega ou do recibo assinado.
  
  assinatura_url string uri aceita nulo Obrigatório
  
  Imagem da assinatura eletrônica, quando a transportadora coleta uma.
  
  recebido_por string aceita nulo Obrigatório
  
  Nome de quem recebeu o objeto.
  
  signatario string aceita nulo Obrigatório
  
  Quem assinou, por exemplo "porteiro".
  
  null
  
  null

object

code integer

Código legado do erro, normalmente 400.
message string Obrigatório

Resumo do erro de validação.
erros object

Erros por campo retornados pelos endpoints legados.
errors object

Erros por campo retornados por validadores no formato atual.

500

Falha interna durante o processamento.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.