Listar Pedidos

Listar pedidos

get

Retorna uma lista paginada de pedidos com filtros

Autorizações

ApiKeyAuth

Parâmetros de consulta

customerDocumentstringOpcional

Documento do cliente para filtro

namestringOpcional

Nome para filtro

emailstring · emailOpcional

Email para filtro

documentstringOpcional

Documento para filtro

notificationEmailstring · emailOpcional

Email de notificação para filtro

statusstring · enumOpcional

Status do pedido para filtro

Valores possíveis:

paymentMethodstringOpcional

Método de pagamento para filtro

expirationDateInitialstring · dateOpcional

Data inicial de expiração para filtro

expirationDateFinalstring · dateOpcional

Data final de expiração para filtro

pageinteger · int32Opcional

Número da página (começando em 0)

Default: 0

sizeinteger · int32 · mín: 1Opcional

Quantidade de itens por página

Default: 20

sortstring[]Opcional

Critérios de ordenação (sort=name,asc&sort=createdAt,desc)

idempotencyKeystringOpcional

Chave de idempotência como query parameter

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumOpcional

Tipo de conteúdo da requisição

Valores possíveis:

x-ip-origin-requeststringOpcional

IP de origem da requisição

x-idempotency-keystringOpcional

Chave de idempotência

Respostas

200

Lista de pedidos retornada com sucesso

application/json

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Recurso não encontrado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

get

HTTPcURLJavaScriptPython

GET /v2/orders HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*

{
  "content": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "status": "SENT",
      "startDate": "2024-03-20",
      "value": 100,
      "installments": 1,
      "title": "Compra de produto",
      "description": "Descrição da compra",
      "uuidBuyer": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-03-20T10:00:00Z",
      "updatedAt": "2024-03-20T10:00:00Z",
      "metadata": [
        {
          "key": "código",
          "value": "YMC"
        }
      ]
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1
}