Skip to main content
Documentation for the GS1 Category Wrapper Schema (data-wrapped) category.

​
Schema Structure

  • type (string) - enum: gs1 (required)
  • data (object) (required)
    • resolver (object) (required)
      • type (string) - enum: scanova_resolver, scanova_domain, custom_resolver, gs1 (required)
      • data (object) (required)
        • domain (string)
    • primaryKey (object) (required)
      • id (string) (required)
      • value (string) (required)
    • qualifiers (array of object (min: 1, max: ))
    • dataAttributes (array of object)
    • resolution (object)
      • type (string) - enum: website_url, file, appStore, scanova_custom_landing_page, description_box (required)
      • data (object) (required)

​
Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GS1 Category Wrapper Schema (data-wrapped)",
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "gs1"
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "resolver",
        "primaryKey"
      ],
      "properties": {
        "resolver": {
          "type": "object",
          "required": [
            "type",
            "data"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "scanova_resolver",
                "scanova_domain",
                "custom_resolver",
                "gs1"
              ]
            },
            "data": {
              "type": "object",
              "properties": {
                "domain": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "primaryKey": {
          "type": "object",
          "required": [
            "id",
            "value"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "qualifiers": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "required": [
              "id",
              "value"
            ],
            "properties": {
              "id": {
                "type": [
                  "string",
                  "integer"
                ]
              },
              "value": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "dataAttributes": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "value"
            ],
            "properties": {
              "id": {
                "type": [
                  "string",
                  "integer"
                ]
              },
              "value": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "resolution": {
          "type": "object",
          "required": [
            "type",
            "data"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "website_url",
                "file",
                "appStore",
                "scanova_custom_landing_page",
                "description_box"
              ]
            },
            "data": {
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": true
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "url"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "playStore",
                          "appleStore"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      }
                    },
                    "additionalProperties": false
                  },
                  "minItems": 1
                }
              ]
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}