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âmetroO que faz
perPageItens por página, de 1 a 50.
currentPageNú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&currentPage=2' \
  -H 'accept: application/json' \
  -H 'x-idcommerce-api-token: SEU_TOKEN'

O que vem na resposta

CampoConteúdo
totalTotal de itens encontrados na consulta.
perPageLimite de itens por página.
currentPageNúmero da página atual.
lastPageNúmero da última página.
prevPageUrl e nextPageUrlURLs da página anterior e da próxima, com os mesmos filtros.
from e toPosição do primeiro e do último registro da página.
dataA 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).

Isso ajudou?