VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Métodos de frete

Paginação de métodos de envio

Controle quantos métodos de envio a listagem devolve e qual página você recebe, com os parâmetros page e items_per_page.

Os métodos de envio costumam reunir opções variadas, com regras de preço diferentes, por isso a listagem é devolvida em páginas. Você escolhe a página e o tamanho dela com dois parâmetros de consulta. As requisições 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 dos métodos de envio:

GET/api/shippingsAdmin

Lista os métodos de envio, uma página por vez

Parâmetros de consulta

pageintegerpadrão: 1
Define qual página de métodos de envio será exibida. As páginas são numeradas a partir de 1.
items_per_pageintegerpadrão: 10
Controla quantos métodos de envio entram em cada página.
Dica

Os métodos de envio costumam reunir opções variadas, com regras de preço diferentes, o que torna a paginação especialmente útil ao recuperar esses dados.

Exemplos

Só a página

GET /api/shippings?page=5 devolve 10 métodos de envio 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/shippings?page=5"

Só o tamanho da página

GET /api/shippings?items_per_page=20 devolve 20 métodos de envio da primeira página. Como page não foi informado, vale o padrão 1.

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

Os dois parâmetros

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

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

Formato da resposta

A API devolve um array JSON com objetos de método de envio, conforme os parâmetros de paginação. Cada objeto traz detalhes como o ID do método, o nome, a descrição, as regras de preço, os prazos estimados de entrega e as restrições geográficas (quando houver).

Importante

Alguns métodos de envio podem estar disponíveis apenas para regiões, tipos de produto ou valores de pedido específicos. Confira sempre os critérios de elegibilidade incluídos em cada objeto de método de envio.

Veja também

Métodos de envio
Visão geral e as rotas dos métodos de envio.
Endpoints
As URLs da API de métodos de envio.
Anterior
Campos de métodos de envio
Próxima
Armazéns
Nesta página
  • Parâmetros de paginação
  • Exemplos
  • Só a página
  • Só o tamanho da página
  • Os dois parâmetros
  • Formato da resposta
  • Veja também