Paginação

Nessa documentação você aprenderá a lidar com nosso sistema de paginação de dados, todas as configurações aqui informadas funcionam em todos os endpoints com paginação.

Estrutura da Paginação

Todas as requisições de listagem de dados retornam uma coleção de recursos que são paginados.
Por exemplo, a consulta de marcas e pedidos.
Toda a resposta paginada é retornada no seguinte formato:

JSON

{
	"data": [
		{
			...
		}
	],
	"links": {
		"first": "https://api.hubiss.com.br/api/v1/orders?page=1",
		"last": "https://api.hubiss.com.br/api/v1/orders?page=2",
		"prev": null,
		"next": "https://api.hubiss.com.br/api/v1/orders?page=2"
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 27,
		"links": [
			{
				"url": null,
				"label": "« Previous",
				"active": false
			},
			{
				"url": "https://api.hubiss.com.br/api/v1/orders?page=1",
				"label": "1",
				"active": true
			},
			{
				"url": "https://api.hubiss.com.br/api/v1/orders?page=2",
				"label": "2",
				"active": false
			},
			{
				"url": "https://api.hubiss.com.br/api/v1/orders?page=2",
				"label": "Next »",
				"active": false
			}
		],
		"path": "https://api.hubiss.com.br/api/v1/orders",
		"per_page": 1,
		"to": 2,
		"total": 27
	}
}

Para usar os parâmetros aqui informados, você deve envia-los por GET na requisição desejada.
Abaixo segue os parâmetros que alteram a forma como a requisição é retornada:

Nome	Descrição	Exemplo
per_page	Limita o número de registros para apresentar em cada página	10
current_page	Define o número da página atual com o número de registros informado	1

👍

Observações

Para facilitar o entendimento e navegação sequencial dos dados, disponibilizaremos automaticamente links para navegar entre a próxima página ou página anterior.