Paginação
Como percorrer as listagens da API REST da Climba com perPage e currentPage.
Atualizado em
As rotas de listagem (pedidos, produtos, marcas, categorias, clientes e as demais) devolvem os resultados em páginas. Dois parâmetros de query controlam a página:
| Parâmetro | O que faz |
|---|---|
perPage | Itens por página, de 1 a 50. |
currentPage | Número da página, a partir de 1. |
Na listagem de pedidos, sem perPage ou com valor acima de 50 a API devolve 50 pedidos por página, sem erro. Um valor que não é número retorna 406.
curl -X GET 'https://api.exemplo/api/v1/orders?perPage=50¤tPage=2' \
-H 'accept: application/json' \
-H 'x-idcommerce-api-token: SEU_TOKEN'
O que vem na resposta
| Campo | Conteúdo |
|---|---|
total | Total de itens encontrados na consulta. |
perPage | Limite de itens por página. |
currentPage | Número da página atual. |
lastPage | Número da última página. |
prevPageUrl e nextPageUrl | URLs da página anterior e da próxima, com os mesmos filtros. |
from e to | Posição do primeiro e do último registro da página. |
data | A lista de itens da página. |
Para ler tudo, comece em currentPage=1 e avance até currentPage chegar a lastPage. Cada página é uma requisição e conta nos limites de uso: use perPage=50 e filtre só o que mudou (em pedidos, com dateStart; veja Sincronização).