Rastrear pedido

GET /api/v1/pedidos/{id}/rastreamento

Consulta o rastreamento atual e a linha do tempo completa de eventos únicos, ordenados do mais antigo para o mais recente. O identificador pode ser o ID interno ou o código de transação de um pedido criado via API. A resposta não expõe IDs internos de transportadora, rastreio ou evento.

GET Requisição

bash

curl -X GET "https://ev.paylog.cash/api/v1/pedidos/{id}/rastreamento" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

javascript

const response = await fetch("https://ev.paylog.cash/api/v1/pedidos/{id}/rastreamento", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
  },
});

python

import requests

response = requests.get(
    "https://ev.paylog.cash/api/v1/pedidos/{id}/rastreamento",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
    },
)

ruby

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

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

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"

response = http.request(request)

200 Resposta

json

{
  "code": 0,
  "pedido_id": 0,
  "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"
    },
    "eventos": [
      {
        "codigo_evento": "string",
        "ocorrido_em": "2024-01-01T00:00:00Z",
        "status": {
          "codigo": null,
          "descricao": null
        },
        "descricao": "string",
        "detalhe": "string",
        "sub_status": "string",
        "localizacao": {
          "cidade": null,
          "uf": null
        },
        "recebido_por": "string",
        "unidade": {
          "tipo": null,
          "endereco": null
        },
        "unidade_destino": {
          "tipo": null,
          "nome": null,
          "codigo": null,
          "endereco": null
        },
        "retirada": {
          "tipo_unidade": null,
          "logradouro": null,
          "numero": null,
          "bairro": null,
          "cidade": null,
          "uf": null,
          "cep": null,
          "retirar_ate": null,
          "codigo_lista": null
        }
      }
    ]
  }
}

Respostas

200

Rastreamento encontrado, ou rastreamento: null quando o pedido ainda não possui código.

application/json

object

code integer Obrigatório
pedido_id integer Obrigatório
rastreamento mixed Obrigatório
Uma das opções
object

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

eventos array Obrigatório

Eventos únicos em ordem cronológica.

Itens

object

codigo_evento string aceita nulo Obrigatório

Identificador público informado pela transportadora.

ocorrido_em string date-time aceita nulo Obrigatório

status mixed Obrigatório

Uma das opções

object

codigo integer Obrigatório

descricao string Obrigatório

null

descricao string aceita nulo Obrigatório

detalhe string aceita nulo Obrigatório

sub_status string aceita nulo Obrigatório

localizacao object Obrigatório

cidade string aceita nulo Obrigatório

uf string aceita nulo Obrigatório

recebido_por string aceita nulo Obrigatório

unidade mixed Obrigatório

Uma das opções

object

tipo string aceita nulo Obrigatório

endereco mixed Obrigatório

Uma das opções

object

Endereço normalizado; somente campos disponíveis são retornados.

logradouro string

numero string

complemento string

bairro string

cidade string

uf string

cep string

pais string

null

null

unidade_destino mixed Obrigatório

Uma das opções

object

tipo string

nome string

codigo string

endereco object

Endereço normalizado; somente campos disponíveis são retornados.

logradouro string

numero string

complemento string

bairro string

cidade string

uf string

cep string

pais string

null

retirada mixed Obrigatório

Uma das opções

object

tipo_unidade string aceita nulo Obrigatório

logradouro string aceita nulo Obrigatório

numero string aceita nulo Obrigatório

bairro string aceita nulo Obrigatório

cidade string aceita nulo Obrigatório

uf string aceita nulo Obrigatório

cep string aceita nulo Obrigatório

retirar_ate string date aceita nulo Obrigatório

codigo_lista string aceita nulo Obrigatório

null
null

401

Token ausente/inválido, pedido inexistente ou pertencente a outro produtor.

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.

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.