BigCommerce · Schema
metaCollectionFull
Data about the response, including pagination and collection totals.
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
Properties
| Name | Type | Description |
|---|---|---|
| pagination | object | Data about the response, including pagination and collection totals. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/metaCollectionFull",
"title": "metaCollectionFull",
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of items in the result set.\n",
"example": 36
},
"count": {
"type": "integer",
"description": "Total number of items in the collection response.\n",
"example": 36
},
"per_page": {
"type": "integer",
"description": "The amount of items returned in the collection per page, controlled by the limit parameter.\n",
"example": 50
},
"current_page": {
"type": "integer",
"description": "The page you are currently on within the collection.\n",
"example": 2
},
"total_pages": {
"type": "integer",
"description": "The total number of pages in the collection.\n",
"example": 3
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string",
"description": "Link to the previous page returned in the response.\n",
"example": "?page=1&limit=50"
},
"current": {
"type": "string",
"description": "Link to the current page returned in the response.\n",
"example": "?page=2&limit=50"
},
"next": {
"type": "string",
"description": "Link to the next page returned in the response.\n",
"example": "?page=3&limit=50"
}
},
"description": "Pagination links for the previous and next parts of the whole collection.\n"
}
},
"description": "Data about the response, including pagination and collection totals."
}
},
"description": "Data about the response, including pagination and collection totals."
}