Listar pacotes

GET /api/v1/pacotes

Lista pacotes do produtor e inclui a quantidade de cada produto no pacote. A composição aparece na chave pacote_produtos AQUI, mas na chave produtos em GET /api/v1/pacotes/{id} — os itens são idênticos, só o nome da chave muda. O filtro usa pacotes.user_id igual ao ID do produtor efetivo do token — quando o token pertence a uma subconta, sobe para o produtor pai.

GET Requisição

bash

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

javascript

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

python

import requests

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

ruby

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

uri = URI("https://ev.paylog.cash/api/v1/pacotes")
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,
      "nome": "string",
      "status": 0,
      "pacote_produtos": [
        {
          "id": null,
          "nome": null,
          "status": null,
          "quantidade": null
        }
      ]
    }
  ]
}

Parâmetros

Consulta

status integer Opcional: Opcional. 0 pendente, 1 ativo (padrão) ou 2 desabilitado.

Valores permitidos 0 1 2
nome string Opcional: Opcional. Trecho do nome do pacote.
data_inicio string date Opcional: Opcional. Data inicial inclusiva aceita pelo Carbon, preferencialmente YYYY-MM-DD.
data_fim string date Opcional: Opcional. Data final inclusiva aceita pelo Carbon, preferencialmente YYYY-MM-DD.
codigo_referencia string Opcional: Opcional. Código exato de referência do pacote em uma plataforma.
plataforma integer Opcional: Opcional. Código numérico da plataforma associada à referência (por exemplo 8 = API, 13 = B4You). Enviar codigo_referencia ou plataforma ativa a junção com pacotes_referencias, então pacotes sem nenhuma referência saem do resultado.
page integer Opcional: Opcional. Número da página da paginação.

Respostas

200

Página de pacotes.

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

nome string Obrigatório

status integer Obrigatório

0 pendente, 1 ativo ou 2 desabilitado.

Valores permitidos 0 1 2

pacote_produtos array Obrigatório

Itens

object

id integer Obrigatório

ID interno do produto.

nome string Obrigatório

Nome do produto.

status integer Obrigatório

0 pendente ou 1 aprovado.

Valores permitidos 0 1

quantidade integer Obrigatório

Quantidade do produto neste pacote.

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 nas rotas legadas de pacotes e produtos. O corpo NÃO é JSON: os controladores devolvem o texto puro Algo deu errado!. Falhas que escapam do catch do controlador (erro fatal de PHP) caem no tratador do framework e devolvem {"message":"Server Error"} em JSON. Trate 500 pelo código HTTP, nunca pelo corpo.

text/plain

string

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.