Listar pedidos

GET /api/v1/pedidos

Lista pedidos dos clientes do produtor autenticado, em páginas de até 500 registros. Cada pedido inclui seus documentos fiscais e, quando disponível, somente o resumo mais recente do rastreamento.

GET Requisição

bash

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

javascript

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

python

import requests

response = requests.get(
    "https://ev.paylog.cash/api/v1/pedidos",
    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")
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

{
  "current_page": 0,
  "first_page_url": "https://example.com",
  "from": 0,
  "last_page": 0,
  "last_page_url": "https://example.com",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "https://example.com",
  "path": "https://example.com",
  "per_page": 0,
  "prev_page_url": "https://example.com",
  "to": 0,
  "total": 0,
  "data": [
    {
      "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": null,
          "pedido_id": null,
          "quantidade": null,
          "valor_unitario": null,
          "subtotal": null,
          "pacote_id": null,
          "codigo_plataforma": null,
          "descricao": null,
          "created_at": null,
          "updated_at": null
        }
      ],
      "documentos_fiscais": [
        {
          "tipo": null,
          "formato": null,
          "nome": null,
          "url": null,
          "chave": null,
          "numero": null
        }
      ],
      "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": null,
          "nome": null
        },
        "servico": "string",
        "url_rastreamento": "https://example.com",
        "url_transportadora": "https://example.com",
        "status": {
          "codigo": null,
          "descricao": null
        },
        "comprovante_entrega": {
          "imagem_url": null,
          "assinatura_url": null,
          "recebido_por": null,
          "signatario": null
        }
      }
    }
  ]
}

Parâmetros

Consulta

order string Opcional: Opcional. Ordenação por ID; aceita asc (padrão) ou desc.

Valores permitidos asc desc
email string email Opcional: Opcional. E-mail exato do cliente.
cpf string Opcional: Opcional. CPF/CNPJ exato do cliente, com ou sem pontuação.
status integer Opcional: Opcional. Código numérico do status do pedido, de 1 a 20.
page integer Opcional: Opcional. Número da página da paginação.

Respostas

200

Página de pedidos.

application/json

object

current_page integer Obrigatório
first_page_url string uri Obrigatório
from integer aceita nulo Obrigatório
last_page integer Obrigatório
last_page_url string uri Obrigatório
links array Obrigatório
Itens
object

url string aceita nulo Obrigatório

label string Obrigatório

active boolean Obrigatório
next_page_url string uri aceita nulo Obrigatório
path string uri Obrigatório
per_page integer Obrigatório
prev_page_url string uri aceita nulo Obrigatório
to integer aceita nulo Obrigatório
total integer Obrigatório
data array Obrigatório
Itens
object

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

400

Requisição inválida.

application/json

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.

401

Token Bearer ausente ou inválido.

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.