BigCommerce · Schema

pagination_Partial

Data about the pagination.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
count integer Total number of items in the collection response.
total integer Total number of items in the result set.
links object Pagination links for the previous, current, or next parts of the whole collection.
total_pages integer The total number of pages in the collection.
View JSON Schema on GitHub

JSON Schema

bigcommerce-pagination-partial-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pagination_Partial",
  "title": "pagination_Partial",
  "type": "object",
  "description": "Data about the pagination.\n",
  "properties": {
    "count": {
      "type": "integer",
      "description": "Total number of items in the collection response.\n"
    },
    "total": {
      "type": "integer",
      "description": "Total number of items in the result set.\n"
    },
    "links": {
      "type": "object",
      "description": "Pagination links for the previous, current, or next parts of the whole collection.\n",
      "properties": {
        "previous": {
          "type": "string",
          "description": "Link to the previous page returned in the response.\n"
        },
        "current": {
          "type": "string",
          "description": "Link to the current page returned in the response.\n"
        },
        "next": {
          "type": "string",
          "description": "Link to the next page returned in the response.\n"
        }
      }
    },
    "total_pages": {
      "type": "integer",
      "description": "The total number of pages in the collection.\n"
    }
  },
  "x-internal": false
}