VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Formas de pagamento

Paginação de formas de pagamento

Controle quantas formas de pagamento a listagem devolve e qual página você recebe, com os parâmetros page e items_per_page.

Uma loja pode ter várias formas de pagamento, por isso a listagem é devolvida em páginas. Você escolhe a página e o tamanho dela com dois parâmetros de consulta. As rotas usam o endereço base da loja ($BASE_URL/api) e credenciais HTTP Basic ($EMAIL:$API_KEY).

Parâmetros de paginação

Acrescente estes parâmetros às requisições para controlar a paginação das formas de pagamento:

GET/api/paymentsAdmin

Lista as formas de pagamento, uma página por vez

Parâmetros de consulta

pageintegerpadrão: 1
Define qual página de formas de pagamento será exibida. As páginas são numeradas a partir de 1.
items_per_pageintegerpadrão: 10
Controla quantas formas de pagamento entram em cada página.
Dica

Se você não informar esses parâmetros, a API devolve as 10 primeiras formas de pagamento.

Exemplos

Só a página

GET /api/payments?page=5 devolve 10 formas de pagamento da 5ª página. Como items_per_page não foi informado, vale o padrão de 10.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/payments?page=5"

Só o tamanho da página

GET /api/payments?items_per_page=20 devolve 20 formas de pagamento da primeira página. Como page não foi informado, vale o padrão 1.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/payments?items_per_page=20"

Os dois parâmetros

GET /api/payments?page=5&items_per_page=20 devolve 20 formas de pagamento da 5ª página. Com os dois parâmetros informados, você controla totalmente o resultado.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/payments?page=5&items_per_page=20"
Nota

A paginação ajuda a percorrer com eficiência conjuntos grandes de formas de pagamento, sem precisar buscar todos os registros de uma vez, o que melhora o desempenho da API e da sua aplicação.

Veja também

Endpoints
As URLs da API de formas de pagamento.
Formas de pagamento
Visão geral e as rotas da API 2.0.
Anterior
Endpoints de formas de pagamento
Próxima
Métodos de frete
Nesta página
  • Parâmetros de paginação
  • Exemplos
  • Só a página
  • Só o tamanho da página
  • Os dois parâmetros
  • Veja também