BigCommerce · Schema

Pagination

Data about the response, including pagination and collection totals.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
total integer Total number of items in the result set.
count integer Total number of items in the collection response.
per_page integer The amount of items returned in the collection per page, controlled by the limit parameter.
current_page integer The page you are currently on within the collection.
total_pages integer The total number of pages in the collection.
links object
View JSON Schema on GitHub

JSON Schema

bigcommerce-pagination-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Pagination",
  "title": "Pagination",
  "description": "Data about the response, including pagination and collection totals.",
  "type": "object",
  "properties": {
    "total": {
      "description": "Total number of items in the result set.",
      "type": "integer",
      "format": "int32"
    },
    "count": {
      "description": "Total number of items in the collection response.",
      "type": "integer",
      "format": "int32"
    },
    "per_page": {
      "description": "The amount of items returned in the collection per page, controlled by the limit parameter.",
      "type": "integer",
      "format": "int32"
    },
    "current_page": {
      "description": "The page you are currently on within the collection.",
      "type": "integer",
      "format": "int32"
    },
    "total_pages": {
      "description": "The total number of pages in the collection.",
      "type": "integer",
      "format": "int32"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    }
  },
  "x-internal": false
}