API legada/Referência completa/Categorias (REST)

Paginação de categorias

Controla quantas categorias são devolvidas e qual página de resultados é exibida.

Ao consultar várias categorias pela API da Venddor, você controla quantos resultados são devolvidos e qual página exibir com os parâmetros de paginação.

GET/api/categoriesAdmin

Listar categorias com paginação

Parâmetros de consulta

pageintegerpadrão: 1

Define qual página de categorias exibir. As páginas são numeradas a partir de 1.

items_per_pageintegerpadrão: 10

Define quantas categorias entram em cada página.

Exemplos

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

Formato da resposta

A API retorna um array de objetos de categoria conforme os parâmetros de paginação. Cada página contém a quantidade de categorias pedida, a partir do número da página solicitada.

Veja também