BigCommerce · Schema

MetaPaginationObject

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
pagination object
View JSON Schema on GitHub

JSON Schema

bigcommerce-metapaginationobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetaPaginationObject",
  "title": "MetaPaginationObject",
  "type": "object",
  "properties": {
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "example": 246,
          "minimum": 0
        },
        "count": {
          "type": "integer",
          "example": 5,
          "minimum": 0
        },
        "per_page": {
          "type": "integer",
          "example": 5,
          "minimum": 0
        },
        "current_page": {
          "type": "integer",
          "example": 1,
          "minimum": 1
        },
        "total_pages": {
          "type": "integer",
          "example": 50,
          "minimum": 0
        },
        "links": {
          "type": "object",
          "properties": {
            "next": {
              "type": "string",
              "example": "?limit=5&page=2"
            },
            "current": {
              "type": "string",
              "example": "?limit=5&page=1"
            }
          }
        }
      }
    }
  },
  "x-tags": [
    "Models"
  ]
}