Paginação de impostos

As bases de impostos podem ficar bem grandes, conforme as jurisdições e os tipos de imposto, por isso os registros de imposto são devolvidos 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 dados de imposto:

Exemplos

Só a página

GET /api/taxes?page=5 devolve 10 registros de imposto da 5ª página. Como items_per_page não foi informado, vale o padrão de 10.

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/taxes?page=5"

Só o tamanho da página

GET /api/taxes?items_per_page=20 devolve 20 registros de imposto da primeira página. Como page não foi informado, vale o padrão 1.

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

Os dois parâmetros

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

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

Formato da resposta

A API devolve um array JSON com objetos de imposto, conforme os parâmetros de paginação. Cada objeto de imposto traz detalhes como a alíquota, a jurisdição, o tipo de imposto e as condições aplicáveis.

Veja também