Pagination

Type: schema

Description

pagination metadata structure

TypeScript Definition

Pagination: {{
            total_records: number;
            total_pages: number;
            previous_page?: number | null;
            limit: number;
            next_page: number | null;
        };
        /** PanDetail */
}

OpenAPI Schema

{
  "description": "pagination metadata structure",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Pagination",
    "description": "API reference for the Pagination schema"
  },
  "required": [
    "total_records",
    "total_pages",
    "limit",
    "next_page"
  ],
  "properties": {
    "total_records": {
      "type": "integer"
    },
    "total_pages": {
      "type": "integer"
    },
    "previous_page": {
      "type": [
        "integer",
        "null"
      ]
    },
    "limit": {
      "type": "integer"
    },
    "next_page": {
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "examples": [
    {
      "total_records": 252,
      "total_pages": 26,
      "previous_page": null,
      "next_page": 2,
      "limit": 10
    }
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions