Paginação

Para métodos GET

Requisições do tipo GET possuem parâmetros de paginação que permitem a fácil navegação entre os resultados a serem listados.

Nestes tipos de requisição, poderemos enviar dois parâmetros (como query params) para limitar itens a serem afetados pela mesma. Sendo eles:

• limit - Permite limitar o número máximo de itens a serem afetados pela requisição. Intervalo (1 - 100)
• page - A página atual dos resultados; Intervalo (1 - total_pages)

Estes parâmetros sempre estarão presentes na seção QUERY PARAMS das requisições GET .

Seção QUERY PARAMS da requisição Listar Clientes

A resposta destas requisições, por sua vez, conterá o número total de páginas (total_pages) e a página atual (page) dos itens. Abaixo, segue um exemplo de resposta da chamada Listar Clientes:

JSON

{
  "http_code": 200,
  "result": {
    "total_pages": 1,
    "page": 1,
    "customers": [
      {
        "entity_id": 1,
        "firstname": "Fulano",
        "middlename": "Ciclano",
        "lastname": "Beltrano",
        "email": "[email protected]",
        "document": "00000000000",
        "billing_address_id": 1,
        "shipping_address_id": 1
      }
    ]
  },
  "errors": null
}