VTEX · Schema

ListRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
settings array
View JSON Schema on GitHub

JSON Schema

vtex-listrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListRequest",
  "title": "ListRequest",
  "type": "object",
  "required": [
    "settings"
  ],
  "properties": {
    "settings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "example": "Api key",
            "description": "Custom label."
          },
          "key": {
            "type": "string",
            "example": "aftership-api-key",
            "description": "Custom key."
          },
          "value": {
            "type": "string",
            "example": "8f_XXXXXXXXX_db79",
            "description": "Custom value."
          }
        }
      }
    }
  }
}