VTEX · Schema

Paging

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
page integer Page number of the gift card list.
perPage integer Quantity of gift cards per page.
total integer Total of gift cards in the store.
pages integer Total number of pages.
View JSON Schema on GitHub

JSON Schema

vtex-paging-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Paging",
  "title": "Paging",
  "type": "object",
  "required": [
    "page",
    "perPage",
    "total",
    "pages"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number of the gift card list.",
      "example": 0
    },
    "perPage": {
      "type": "integer",
      "description": "Quantity of gift cards per page.",
      "example": 10
    },
    "total": {
      "type": "integer",
      "description": "Total of gift cards in the store.",
      "example": 4
    },
    "pages": {
      "type": "integer",
      "description": "Total number of pages.",
      "example": 1
    }
  }
}