Paginação de status

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

Ao consultar dados de status pela API da Venddor, você controla quantos resultados voltam e qual página de resultados é exibida com os parâmetros de paginação. Os dados de status costumam incluir muitos tipos diferentes de status, de pedidos, entregas, pagamentos e outros, e a paginação ajuda você a focar em categorias específicas.

GET/api/statusesAdmin

Listar os status página por página

Parâmetros de consulta

pageintegerpadrão: 1

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

items_per_pageintegerpadrão: 10

Controla quantos status entram em cada página. O valor padrão é 10.

Exemplos

Requisição	Resultado
`GET /api/statuses?page=5`	Retorna 10 status da 5ª página. Como `items_per_page` não foi informado, vale o padrão de 10.
`GET /api/statuses?items_per_page=20`	Retorna 20 status da primeira página. Como `page` não foi informado, vale o padrão de 1.
`GET /api/statuses?page=5&items_per_page=20`	Retorna 20 status 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/statuses?page=5&items_per_page=20"

Formato da resposta

A API devolve um array JSON com objetos de status, de acordo com os parâmetros de paginação. Cada objeto de status traz detalhes como o id do status, o nome, a descrição, o tipo (por exemplo, status de pedido ou de pagamento) e os códigos de cor ou ícones associados.

Veja também