Paginação de remessas

Os parâmetros page e items_per_page, que controlam quantas remessas voltam e qual página é exibida.

Ao consultar dados de remessas pela API da Venddor, você controla quantos resultados voltam e qual página de resultados é exibida com os parâmetros de paginação. A paginação é especialmente útil para acompanhar remessas ao longo do tempo, já que uma empresa pode ter centenas ou milhares de remessas ativas a qualquer momento.

GET/api/shipmentsAdmin

Listar as remessas página por página

Parâmetros de consulta

pageintegerpadrão: 1

Define qual página de remessas será exibida. As páginas são numeradas a partir de 1.

items_per_pageintegerpadrão: 10

Controla quantas remessas entram em cada página. O valor padrão é 10.

Exemplos

Requisição	Resultado
`GET /api/shipments?page=5`	Retorna 10 remessas da 5ª página. Como `items_per_page` não foi informado, vale o padrão de 10.
`GET /api/shipments?items_per_page=20`	Retorna 20 remessas da primeira página. Como `page` não foi informado, vale o padrão de 1.
`GET /api/shipments?page=5&items_per_page=20`	Retorna 20 remessas da 5ª página. Os dois parâmetros de paginação foram informados, o que dá controle total sobre os resultados.

Exemplo de requisição

bash

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

Formato da resposta

A API devolve um array JSON com objetos de remessa, de acordo com os parâmetros de paginação. Cada objeto de remessa traz detalhes como o id da remessa, o pedido associado, a transportadora, o código de rastreamento, a data de envio, a data estimada de entrega e o status atual.

Veja também