shopify-webhook-schemas 0.2.9 → 0.3.2

package/schemas/2026-01/selling_plan_groups/create.json

@@ -0,0 +1,216 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_app": {
+      "format": "uri",
+      "type": "string"
+    },
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "app_id": {
+      "anyOf": [
+        {
+          "type": "integer"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "description": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "id": {
+      "type": "integer"
+    },
+    "merchant_code": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "options": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "position": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "product_variants": {
+      "items": false,
+      "type": "array"
+    },
+    "products": {
+      "items": {
+        "properties": {
+          "id": {
+            "type": "integer"
+          },
+          "storefront_graphql_api_id": {
+            "format": "uri",
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "storefront_graphql_api_id",
+          "title"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "selling_plans": {
+      "items": {
+        "properties": {
+          "billing_policy": {
+            "properties": {
+              "interval": {
+                "type": "string"
+              },
+              "interval_count": {
+                "type": "integer"
+              },
+              "max_cycles": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              },
+              "min_cycles": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              }
+            },
+            "required": [
+              "interval",
+              "interval_count",
+              "max_cycles",
+              "min_cycles"
+            ],
+            "type": "object"
+          },
+          "delivery_policy": {
+            "properties": {
+              "anchors": {
+                "items": false,
+                "type": "array"
+              },
+              "cutoff": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              },
+              "interval": {
+                "type": "string"
+              },
+              "interval_count": {
+                "type": "integer"
+              },
+              "pre_anchor_behavior": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "anchors",
+              "cutoff",
+              "interval",
+              "interval_count",
+              "pre_anchor_behavior"
+            ],
+            "type": "object"
+          },
+          "description": {
+            "type": [
+              "null",
+              "string"
+            ]
+          },
+          "name": {
+            "type": "string"
+          },
+          "options": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "position": {
+            "type": [
+              "integer",
+              "null"
+            ]
+          },
+          "pricing_policies": {
+            "items": {
+              "properties": {
+                "adjustment_type": {
+                  "type": "string"
+                },
+                "adjustment_value": {
+                  "type": "string"
+                },
+                "after_cycle": {
+                  "type": "integer"
+                }
+              },
+              "required": [
+                "adjustment_type",
+                "adjustment_value",
+                "after_cycle"
+              ],
+              "type": "object"
+            },
+            "type": "array"
+          }
+        },
+        "required": [
+          "billing_policy",
+          "delivery_policy",
+          "description",
+          "name",
+          "options",
+          "position",
+          "pricing_policies"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "summary": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_app",
+    "admin_graphql_api_id",
+    "app_id",
+    "description",
+    "id",
+    "merchant_code",
+    "name",
+    "options",
+    "position",
+    "product_variants",
+    "products",
+    "selling_plans",
+    "summary"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/selling_plan_groups/delete.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "admin_graphql_api_id",
+    "id"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/selling_plan_groups/update.json

@@ -0,0 +1,216 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "admin_graphql_api_app": {
+      "format": "uri",
+      "type": "string"
+    },
+    "admin_graphql_api_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "app_id": {
+      "anyOf": [
+        {
+          "type": "integer"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "description": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "id": {
+      "type": "integer"
+    },
+    "merchant_code": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "options": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "position": {
+      "type": [
+        "integer",
+        "null"
+      ]
+    },
+    "product_variants": {
+      "items": false,
+      "type": "array"
+    },
+    "products": {
+      "items": {
+        "properties": {
+          "id": {
+            "type": "integer"
+          },
+          "storefront_graphql_api_id": {
+            "format": "uri",
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "storefront_graphql_api_id",
+          "title"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "selling_plans": {
+      "items": {
+        "properties": {
+          "billing_policy": {
+            "properties": {
+              "interval": {
+                "type": "string"
+              },
+              "interval_count": {
+                "type": "integer"
+              },
+              "max_cycles": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              },
+              "min_cycles": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              }
+            },
+            "required": [
+              "interval",
+              "interval_count",
+              "max_cycles",
+              "min_cycles"
+            ],
+            "type": "object"
+          },
+          "delivery_policy": {
+            "properties": {
+              "anchors": {
+                "items": false,
+                "type": "array"
+              },
+              "cutoff": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              },
+              "interval": {
+                "type": "string"
+              },
+              "interval_count": {
+                "type": "integer"
+              },
+              "pre_anchor_behavior": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "anchors",
+              "cutoff",
+              "interval",
+              "interval_count",
+              "pre_anchor_behavior"
+            ],
+            "type": "object"
+          },
+          "description": {
+            "type": [
+              "null",
+              "string"
+            ]
+          },
+          "name": {
+            "type": "string"
+          },
+          "options": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "position": {
+            "type": [
+              "integer",
+              "null"
+            ]
+          },
+          "pricing_policies": {
+            "items": {
+              "properties": {
+                "adjustment_type": {
+                  "type": "string"
+                },
+                "adjustment_value": {
+                  "type": "string"
+                },
+                "after_cycle": {
+                  "type": "integer"
+                }
+              },
+              "required": [
+                "adjustment_type",
+                "adjustment_value",
+                "after_cycle"
+              ],
+              "type": "object"
+            },
+            "type": "array"
+          }
+        },
+        "required": [
+          "billing_policy",
+          "delivery_policy",
+          "description",
+          "name",
+          "options",
+          "position",
+          "pricing_policies"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "summary": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "admin_graphql_api_app",
+    "admin_graphql_api_id",
+    "app_id",
+    "description",
+    "id",
+    "merchant_code",
+    "name",
+    "options",
+    "position",
+    "product_variants",
+    "products",
+    "selling_plans",
+    "summary"
+  ],
+  "type": "object"
+}

package/schemas/2026-01/shipping_addresses/create.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "address1": {
+      "type": "string"
+    },
+    "address2": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "city": {
+      "type": "string"
+    },
+    "company": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "country": {
+      "type": "string"
+    },
+    "country_code": {
+      "type": "string"
+    },
+    "first_name": {
+      "type": "string"
+    },
+    "last_name": {
+      "type": "string"
+    },
+    "latitude": {
+      "type": [
+        "null",
+        "number"
+      ]
+    },
+    "longitude": {
+      "type": [
+        "null",
+        "number"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "phone": {
+      "type": "string"
+    },
+    "province": {
+      "type": "string"
+    },
+    "province_code": {
+      "type": "string"
+    },
+    "zip": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

package/schemas/2026-01/shipping_addresses/update.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "address1": {
+      "type": "string"
+    },
+    "address2": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "city": {
+      "type": "string"
+    },
+    "company": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "country": {
+      "type": "string"
+    },
+    "country_code": {
+      "type": "string"
+    },
+    "first_name": {
+      "type": "string"
+    },
+    "last_name": {
+      "type": "string"
+    },
+    "latitude": {
+      "type": [
+        "null",
+        "number"
+      ]
+    },
+    "longitude": {
+      "type": [
+        "null",
+        "number"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "phone": {
+      "type": "string"
+    },
+    "province": {
+      "type": "string"
+    },
+    "province_code": {
+      "type": "string"
+    },
+    "zip": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

package/schemas/2026-01/shop/redact.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "shop_domain": {
+      "type": "string"
+    },
+    "shop_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "shop_domain",
+    "shop_id"
+  ],
+  "type": "object"
+}