BigCommerce · Schema

IndexMeta

BC Meta payload for collection-type responses.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
pagination	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IndexMeta",
  "title": "IndexMeta",
  "type": "object",
  "description": "BC Meta payload for collection-type responses.",
  "properties": {
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "example": 1
        },
        "count": {
          "type": "integer",
          "example": 1
        },
        "per_page": {
          "type": "integer",
          "example": 50
        },
        "current_page": {
          "type": "integer",
          "example": 1
        },
        "total_pages": {
          "type": "integer",
          "example": 1
        },
        "links": {
          "type": "object",
          "properties": {
            "previous": {
              "type": "string",
              "example": "?page=1&limit=50"
            },
            "current": {
              "type": "string",
              "example": "?page=1&limit=50"
            },
            "next": {
              "type": "string",
              "example": "?page=1&limit=50"
            }
          }
        }
      }
    }
  },
  "x-tags": [
    "Models"
  ]
}