@authorizedretailers/spec 0.1.1 → 0.2.0

package/schemas/0.2/common.json

@@ -0,0 +1,761 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://authorizedretailers.ai/schemas/0.2/common.json",
+  "title": "Authorized Retailers v0.2 shared definitions",
+  "$defs": {
+    "specVersion": {
+      "const": "authorized-retailers/0.2"
+    },
+    "timestamp": {
+      "description": "RFC 3339 timestamp in UTC with a Z suffix.",
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,9})?Z$"
+    },
+    "date": {
+      "description": "ISO 8601 calendar date.",
+      "type": "string",
+      "format": "date",
+      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
+    },
+    "domain": {
+      "description": "A bare hostname, lowercase: no scheme, port, path, trailing dot or leading www. (section 6).",
+      "type": "string",
+      "maxLength": 253,
+      "pattern": "^(?!www\\.)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z]{2,63}|xn--[a-z0-9-]{1,59})$"
+    },
+    "countryCode": {
+      "description": "ISO 3166-1 alpha-2, uppercase. The United Kingdom is GB.",
+      "enum": [
+        "AD",
+        "AE",
+        "AF",
+        "AG",
+        "AI",
+        "AL",
+        "AM",
+        "AO",
+        "AQ",
+        "AR",
+        "AS",
+        "AT",
+        "AU",
+        "AW",
+        "AX",
+        "AZ",
+        "BA",
+        "BB",
+        "BD",
+        "BE",
+        "BF",
+        "BG",
+        "BH",
+        "BI",
+        "BJ",
+        "BL",
+        "BM",
+        "BN",
+        "BO",
+        "BQ",
+        "BR",
+        "BS",
+        "BT",
+        "BV",
+        "BW",
+        "BY",
+        "BZ",
+        "CA",
+        "CC",
+        "CD",
+        "CF",
+        "CG",
+        "CH",
+        "CI",
+        "CK",
+        "CL",
+        "CM",
+        "CN",
+        "CO",
+        "CR",
+        "CU",
+        "CV",
+        "CW",
+        "CX",
+        "CY",
+        "CZ",
+        "DE",
+        "DJ",
+        "DK",
+        "DM",
+        "DO",
+        "DZ",
+        "EC",
+        "EE",
+        "EG",
+        "EH",
+        "ER",
+        "ES",
+        "ET",
+        "FI",
+        "FJ",
+        "FK",
+        "FM",
+        "FO",
+        "FR",
+        "GA",
+        "GB",
+        "GD",
+        "GE",
+        "GF",
+        "GG",
+        "GH",
+        "GI",
+        "GL",
+        "GM",
+        "GN",
+        "GP",
+        "GQ",
+        "GR",
+        "GS",
+        "GT",
+        "GU",
+        "GW",
+        "GY",
+        "HK",
+        "HM",
+        "HN",
+        "HR",
+        "HT",
+        "HU",
+        "ID",
+        "IE",
+        "IL",
+        "IM",
+        "IN",
+        "IO",
+        "IQ",
+        "IR",
+        "IS",
+        "IT",
+        "JE",
+        "JM",
+        "JO",
+        "JP",
+        "KE",
+        "KG",
+        "KH",
+        "KI",
+        "KM",
+        "KN",
+        "KP",
+        "KR",
+        "KW",
+        "KY",
+        "KZ",
+        "LA",
+        "LB",
+        "LC",
+        "LI",
+        "LK",
+        "LR",
+        "LS",
+        "LT",
+        "LU",
+        "LV",
+        "LY",
+        "MA",
+        "MC",
+        "MD",
+        "ME",
+        "MF",
+        "MG",
+        "MH",
+        "MK",
+        "ML",
+        "MM",
+        "MN",
+        "MO",
+        "MP",
+        "MQ",
+        "MR",
+        "MS",
+        "MT",
+        "MU",
+        "MV",
+        "MW",
+        "MX",
+        "MY",
+        "MZ",
+        "NA",
+        "NC",
+        "NE",
+        "NF",
+        "NG",
+        "NI",
+        "NL",
+        "NO",
+        "NP",
+        "NR",
+        "NU",
+        "NZ",
+        "OM",
+        "PA",
+        "PE",
+        "PF",
+        "PG",
+        "PH",
+        "PK",
+        "PL",
+        "PM",
+        "PN",
+        "PR",
+        "PS",
+        "PT",
+        "PW",
+        "PY",
+        "QA",
+        "RE",
+        "RO",
+        "RS",
+        "RU",
+        "RW",
+        "SA",
+        "SB",
+        "SC",
+        "SD",
+        "SE",
+        "SG",
+        "SH",
+        "SI",
+        "SJ",
+        "SK",
+        "SL",
+        "SM",
+        "SN",
+        "SO",
+        "SR",
+        "SS",
+        "ST",
+        "SV",
+        "SX",
+        "SY",
+        "SZ",
+        "TC",
+        "TD",
+        "TF",
+        "TG",
+        "TH",
+        "TJ",
+        "TK",
+        "TL",
+        "TM",
+        "TN",
+        "TO",
+        "TR",
+        "TT",
+        "TV",
+        "TW",
+        "TZ",
+        "UA",
+        "UG",
+        "UM",
+        "US",
+        "UY",
+        "UZ",
+        "VA",
+        "VC",
+        "VE",
+        "VG",
+        "VI",
+        "VN",
+        "VU",
+        "WF",
+        "WS",
+        "YE",
+        "YT",
+        "ZA",
+        "ZM",
+        "ZW"
+      ]
+    },
+    "httpsUrl": {
+      "type": "string",
+      "format": "uri",
+      "pattern": "^https://",
+      "maxLength": 2048
+    },
+    "registryUrl": {
+      "description": "Section 5.1: a list URL MUST be on authorizedretailers.ai.",
+      "type": "string",
+      "format": "uri",
+      "pattern": "^https://authorizedretailers\\.ai/",
+      "maxLength": 2048
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9_-]{1,64}$"
+    },
+    "revocationId": {
+      "description": "Section 10.3: a random value, rv_ followed by at least 16 base64url characters.",
+      "type": "string",
+      "pattern": "^rv_[A-Za-z0-9_-]{16,64}$"
+    },
+    "nonEmptyString": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "sellerId": {
+      "type": "string",
+      "pattern": "^\\S{1,128}$"
+    },
+    "amazonChannel": {
+      "type": "object",
+      "required": [
+        "type",
+        "domain",
+        "seller_id"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "amazon"
+        },
+        "domain": {
+          "enum": [
+            "amazon.com",
+            "amazon.ca",
+            "amazon.co.uk",
+            "amazon.de",
+            "amazon.fr",
+            "amazon.it",
+            "amazon.es",
+            "amazon.com.au"
+          ]
+        },
+        "seller_id": {
+          "$ref": "#/$defs/sellerId"
+        }
+      }
+    },
+    "walmartChannel": {
+      "type": "object",
+      "required": [
+        "type",
+        "domain",
+        "seller_id"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "walmart"
+        },
+        "domain": {
+          "enum": [
+            "walmart.com",
+            "walmart.ca"
+          ]
+        },
+        "seller_id": {
+          "$ref": "#/$defs/sellerId"
+        }
+      }
+    },
+    "ebayChannel": {
+      "type": "object",
+      "required": [
+        "type",
+        "domain",
+        "seller_id"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "ebay"
+        },
+        "domain": {
+          "enum": [
+            "ebay.com",
+            "ebay.co.uk",
+            "ebay.ca",
+            "ebay.de",
+            "ebay.com.au"
+          ]
+        },
+        "seller_id": {
+          "$ref": "#/$defs/sellerId"
+        }
+      }
+    },
+    "webChannel": {
+      "type": "object",
+      "required": [
+        "type",
+        "domain"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "web"
+        },
+        "domain": {
+          "allOf": [
+            {
+              "$ref": "#/$defs/domain"
+            },
+            {
+              "not": {
+                "enum": [
+                  "amazon.com",
+                  "amazon.ca",
+                  "amazon.co.uk",
+                  "amazon.de",
+                  "amazon.fr",
+                  "amazon.it",
+                  "amazon.es",
+                  "amazon.com.au",
+                  "walmart.com",
+                  "walmart.ca",
+                  "ebay.com",
+                  "ebay.co.uk",
+                  "ebay.ca",
+                  "ebay.de",
+                  "ebay.com.au"
+                ]
+              }
+            }
+          ]
+        }
+      }
+    },
+    "channel": {
+      "description": "Section 6. Every channel is identified by a domain.",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/amazonChannel"
+        },
+        {
+          "$ref": "#/$defs/walmartChannel"
+        },
+        {
+          "$ref": "#/$defs/ebayChannel"
+        },
+        {
+          "$ref": "#/$defs/webChannel"
+        }
+      ]
+    },
+    "party": {
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "entity_id": {
+          "$ref": "#/$defs/id"
+        }
+      }
+    },
+    "territories": {
+      "description": "ISO 3166-1 alpha-2 codes, or exactly [\"*\"] for worldwide.",
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "anyOf": [
+        {
+          "const": [
+            "*"
+          ]
+        },
+        {
+          "items": {
+            "$ref": "#/$defs/countryCode"
+          }
+        }
+      ]
+    },
+    "productLine": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^\\S(.*\\S)?$"
+    },
+    "productLines": {
+      "description": "Named product lines, or exactly [\"all\"].",
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "anyOf": [
+        {
+          "const": [
+            "all"
+          ]
+        },
+        {
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/$defs/productLine"
+              },
+              {
+                "not": {
+                  "const": "all"
+                }
+              }
+            ]
+          }
+        }
+      ]
+    },
+    "namedProductLines": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "allOf": [
+          {
+            "$ref": "#/$defs/productLine"
+          },
+          {
+            "not": {
+              "const": "all"
+            }
+          }
+        ]
+      }
+    },
+    "productIds": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/id"
+      }
+    },
+    "gtin": {
+      "description": "8, 12, 13 or 14 digits with a valid GS1 check digit (checked by the validator).",
+      "type": "string",
+      "pattern": "^([0-9]{8}|[0-9]{12,14})$"
+    },
+    "asin": {
+      "description": "10 uppercase letters or digits.",
+      "type": "string",
+      "pattern": "^[A-Z0-9]{10}$"
+    },
+    "product": {
+      "description": "Section 3.1. At least one of gtin or asins.",
+      "type": "object",
+      "required": [
+        "id",
+        "name"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "product_line": {
+          "$ref": "#/$defs/productLine"
+        },
+        "attributes": {
+          "type": "object",
+          "maxProperties": 32,
+          "propertyNames": {
+            "minLength": 1,
+            "maxLength": 64
+          },
+          "additionalProperties": {
+            "type": "string",
+            "maxLength": 256
+          }
+        },
+        "gtin": {
+          "$ref": "#/$defs/gtin"
+        },
+        "asins": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/asin"
+          }
+        }
+      },
+      "anyOf": [
+        {
+          "required": [
+            "gtin"
+          ]
+        },
+        {
+          "required": [
+            "asins"
+          ]
+        }
+      ]
+    },
+    "scope": {
+      "description": "Section 3. product_lines, products or both; territories optional (section 6.2).",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "territories": {
+          "$ref": "#/$defs/territories"
+        },
+        "product_lines": {
+          "$ref": "#/$defs/productLines"
+        },
+        "products": {
+          "allOf": [
+            {
+              "$ref": "#/$defs/productIds"
+            },
+            {
+              "minItems": 1
+            }
+          ]
+        },
+        "exclude_product_lines": {
+          "$ref": "#/$defs/namedProductLines"
+        },
+        "exclude_products": {
+          "$ref": "#/$defs/productIds"
+        }
+      },
+      "anyOf": [
+        {
+          "required": [
+            "product_lines"
+          ]
+        },
+        {
+          "required": [
+            "products"
+          ]
+        }
+      ]
+    },
+    "exclusions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "product_lines": {
+          "$ref": "#/$defs/namedProductLines"
+        },
+        "products": {
+          "$ref": "#/$defs/productIds"
+        }
+      }
+    },
+    "authorization": {
+      "type": "object",
+      "required": [
+        "id",
+        "revocation_id",
+        "retailer",
+        "channels",
+        "scope"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "revocation_id": {
+          "$ref": "#/$defs/revocationId"
+        },
+        "retailer": {
+          "$ref": "#/$defs/party"
+        },
+        "channels": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/channel"
+          }
+        },
+        "scope": {
+          "$ref": "#/$defs/scope"
+        },
+        "proposed_by": {
+          "description": "The distributor that proposed this authorization, if any (section 3).",
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/party"
+            }
+          ]
+        },
+        "expires": {
+          "description": "Optional end date set by the brand (section 10).",
+          "$ref": "#/$defs/timestamp"
+        }
+      }
+    },
+    "brand": {
+      "description": "Pointer form: one domain.",
+      "type": "object",
+      "required": [
+        "name",
+        "domain"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "domain": {
+          "$ref": "#/$defs/domain"
+        }
+      }
+    },
+    "listBrand": {
+      "description": "Every domain the list applies to (section 5.2).",
+      "type": "object",
+      "required": [
+        "name",
+        "domains"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "domains": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/domain"
+          }
+        }
+      }
+    },
+    "signature": {
+      "type": "object",
+      "required": [
+        "kid",
+        "jws"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kid": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9._-]{1,64}$"
+        },
+        "jws": {
+          "description": "Detached compact JWS: header..signature (empty payload segment).",
+          "type": "string",
+          "pattern": "^[A-Za-z0-9_-]+\\.\\.[A-Za-z0-9_-]+$"
+        }
+      }
+    }
+  }
+}