shopify-webhook-schemas 0.1.6 → 0.1.8

package/schemas/2025-01/customer.joined_segment.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "customer_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "segment_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "shop_id": {
+      "format": "uri",
+      "type": "string"
+    }
+  },
+  "required": [
+    "customer_id",
+    "segment_id",
+    "shop_id"
+  ],
+  "type": "object"
+}

package/schemas/2025-01/customer.left_segment.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "customer_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "segment_id": {
+      "format": "uri",
+      "type": "string"
+    },
+    "shop_id": {
+      "format": "uri",
+      "type": "string"
+    }
+  },
+  "required": [
+    "customer_id",
+    "segment_id",
+    "shop_id"
+  ],
+  "type": "object"
+}

package/schemas/2025-01/customers/create.json

@@ -95,12 +95,6 @@
       "format": "email",
       "type": "string"
     },
-    "email_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "first_name": {
       "type": "string"
     },
@@ -110,12 +104,6 @@
     "last_name": {
       "type": "string"
     },
-    "last_order_id": {
-      "type": "integer"
-    },
-    "last_order_name": {
-      "type": "string"
-    },
     "multipass_identifier": {
       "type": [
         "null",
@@ -125,27 +113,15 @@
     "note": {
       "type": "string"
     },
-    "orders_count": {
-      "type": "integer"
-    },
     "phone": {
       "type": [
         "null",
         "string"
       ]
     },
-    "sms_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "state": {
       "type": "string"
     },
-    "tags": {
-      "type": "string"
-    },
     "tax_exempt": {
       "type": "boolean"
     },
@@ -153,9 +129,6 @@
       "items": false,
       "type": "array"
     },
-    "total_spent": {
-      "type": "string"
-    },
     "updated_at": {
       "format": "date-time",
       "type": "string"
@@ -171,22 +144,15 @@
     "currency",
     "default_address",
     "email",
-    "email_marketing_consent",
     "first_name",
     "id",
     "last_name",
-    "last_order_id",
-    "last_order_name",
     "multipass_identifier",
     "note",
-    "orders_count",
     "phone",
-    "sms_marketing_consent",
     "state",
-    "tags",
     "tax_exempt",
     "tax_exemptions",
-    "total_spent",
     "updated_at",
     "verified_email"
   ],

package/schemas/2025-01/customers/data_request.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "customer": {
+      "properties": {
+        "email": {
+          "format": "email",
+          "type": "string"
+        },
+        "id": {
+          "type": "integer"
+        },
+        "phone": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "email",
+        "id",
+        "phone"
+      ],
+      "type": "object"
+    },
+    "data_request": {
+      "properties": {
+        "id": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "type": "object"
+    },
+    "orders_requested": {
+      "items": {
+        "type": "integer"
+      },
+      "type": "array"
+    },
+    "shop_domain": {
+      "type": "string"
+    },
+    "shop_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "customer",
+    "data_request",
+    "orders_requested",
+    "shop_domain",
+    "shop_id"
+  ],
+  "type": "object"
+}

package/schemas/2025-01/customers/delete.json

@@ -9,12 +9,6 @@
       "format": "uri",
       "type": "string"
     },
-    "email_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "id": {
       "type": "integer"
     },
@@ -24,12 +18,6 @@
         "string"
       ]
     },
-    "sms_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "tax_exemptions": {
       "items": false,
       "type": "array"
@@ -38,10 +26,8 @@
   "required": [
     "addresses",
     "admin_graphql_api_id",
-    "email_marketing_consent",
     "id",
     "phone",
-    "sms_marketing_consent",
     "tax_exemptions"
   ],
   "type": "object"

package/schemas/2025-01/customers/disable.json

@@ -95,12 +95,6 @@
       "format": "email",
       "type": "string"
     },
-    "email_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "first_name": {
       "type": "string"
     },
@@ -110,12 +104,6 @@
     "last_name": {
       "type": "string"
     },
-    "last_order_id": {
-      "type": "integer"
-    },
-    "last_order_name": {
-      "type": "string"
-    },
     "multipass_identifier": {
       "type": [
         "null",
@@ -125,27 +113,15 @@
     "note": {
       "type": "string"
     },
-    "orders_count": {
-      "type": "integer"
-    },
     "phone": {
       "type": [
         "null",
         "string"
       ]
     },
-    "sms_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "state": {
       "type": "string"
     },
-    "tags": {
-      "type": "string"
-    },
     "tax_exempt": {
       "type": "boolean"
     },
@@ -153,9 +129,6 @@
       "items": false,
       "type": "array"
     },
-    "total_spent": {
-      "type": "string"
-    },
     "updated_at": {
       "format": "date-time",
       "type": "string"
@@ -171,22 +144,15 @@
     "currency",
     "default_address",
     "email",
-    "email_marketing_consent",
     "first_name",
     "id",
     "last_name",
-    "last_order_id",
-    "last_order_name",
     "multipass_identifier",
     "note",
-    "orders_count",
     "phone",
-    "sms_marketing_consent",
     "state",
-    "tags",
     "tax_exempt",
     "tax_exemptions",
-    "total_spent",
     "updated_at",
     "verified_email"
   ],

package/schemas/2025-01/customers/enable.json

@@ -95,12 +95,6 @@
       "format": "email",
       "type": "string"
     },
-    "email_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "first_name": {
       "type": "string"
     },
@@ -110,12 +104,6 @@
     "last_name": {
       "type": "string"
     },
-    "last_order_id": {
-      "type": "integer"
-    },
-    "last_order_name": {
-      "type": "string"
-    },
     "multipass_identifier": {
       "type": [
         "null",
@@ -125,27 +113,15 @@
     "note": {
       "type": "string"
     },
-    "orders_count": {
-      "type": "integer"
-    },
     "phone": {
       "type": [
         "null",
         "string"
       ]
     },
-    "sms_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "state": {
       "type": "string"
     },
-    "tags": {
-      "type": "string"
-    },
     "tax_exempt": {
       "type": "boolean"
     },
@@ -153,9 +129,6 @@
       "items": false,
       "type": "array"
     },
-    "total_spent": {
-      "type": "string"
-    },
     "updated_at": {
       "format": "date-time",
       "type": "string"
@@ -171,22 +144,15 @@
     "currency",
     "default_address",
     "email",
-    "email_marketing_consent",
     "first_name",
     "id",
     "last_name",
-    "last_order_id",
-    "last_order_name",
     "multipass_identifier",
     "note",
-    "orders_count",
     "phone",
-    "sms_marketing_consent",
     "state",
-    "tags",
     "tax_exempt",
     "tax_exemptions",
-    "total_spent",
     "updated_at",
     "verified_email"
   ],

package/schemas/2025-01/customers/purchasing_summary.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "amountSpent": {
+      "properties": {
+        "amount": {
+          "type": "string"
+        },
+        "currencyCode": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "amount",
+        "currencyCode"
+      ],
+      "type": "object"
+    },
+    "customerId": {
+      "format": "uri",
+      "type": "string"
+    },
+    "lastOrderId": {
+      "format": "uri",
+      "type": "string"
+    },
+    "numberOfOrders": {
+      "type": "integer"
+    },
+    "occurredAt": {
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "required": [
+    "amountSpent",
+    "customerId",
+    "lastOrderId",
+    "numberOfOrders",
+    "occurredAt"
+  ],
+  "type": "object"
+}

package/schemas/2025-01/customers/redact.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "properties": {
+    "customer": {
+      "properties": {
+        "email": {
+          "format": "email",
+          "type": "string"
+        },
+        "id": {
+          "type": "integer"
+        },
+        "phone": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "email",
+        "id",
+        "phone"
+      ],
+      "type": "object"
+    },
+    "orders_to_redact": {
+      "items": {
+        "type": "integer"
+      },
+      "type": "array"
+    },
+    "shop_domain": {
+      "type": "string"
+    },
+    "shop_id": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "customer",
+    "orders_to_redact",
+    "shop_domain",
+    "shop_id"
+  ],
+  "type": "object"
+}

package/schemas/2025-01/customers/update.json

@@ -95,12 +95,6 @@
       "format": "email",
       "type": "string"
     },
-    "email_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "first_name": {
       "type": "string"
     },
@@ -110,12 +104,6 @@
     "last_name": {
       "type": "string"
     },
-    "last_order_id": {
-      "type": "integer"
-    },
-    "last_order_name": {
-      "type": "string"
-    },
     "multipass_identifier": {
       "type": [
         "null",
@@ -125,27 +113,15 @@
     "note": {
       "type": "string"
     },
-    "orders_count": {
-      "type": "integer"
-    },
     "phone": {
       "type": [
         "null",
         "string"
       ]
     },
-    "sms_marketing_consent": {
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
     "state": {
       "type": "string"
     },
-    "tags": {
-      "type": "string"
-    },
     "tax_exempt": {
       "type": "boolean"
     },
@@ -153,9 +129,6 @@
       "items": false,
       "type": "array"
     },
-    "total_spent": {
-      "type": "string"
-    },
     "updated_at": {
       "format": "date-time",
       "type": "string"
@@ -171,22 +144,15 @@
     "currency",
     "default_address",
     "email",
-    "email_marketing_consent",
     "first_name",
     "id",
     "last_name",
-    "last_order_id",
-    "last_order_name",
     "multipass_identifier",
     "note",
-    "orders_count",
     "phone",
-    "sms_marketing_consent",
     "state",
-    "tags",
     "tax_exempt",
     "tax_exemptions",
-    "total_spent",
     "updated_at",
     "verified_email"
   ],

package/schemas/2025-01/draft_orders/create.json

@@ -5,6 +5,12 @@
       "format": "uri",
       "type": "string"
     },
+    "allow_discount_codes_in_checkout?": {
+      "type": "boolean"
+    },
+    "api_client_id": {
+      "type": "null"
+    },
     "applied_discount": {
       "properties": {
         "amount": {
@@ -35,6 +41,9 @@
         "object"
       ]
     },
+    "b2b?": {
+      "type": "boolean"
+    },
     "billing_address": {
       "properties": {
         "address1": {
@@ -134,6 +143,9 @@
       "format": "date-time",
       "type": "string"
     },
+    "created_on_api_version_handle": {
+      "type": "null"
+    },
     "currency": {
       "type": "string"
     },
@@ -276,10 +288,7 @@
               ]
             },
             "opt_in_level": {
-              "type": [
-                "null",
-                "string"
-              ]
+              "type": "string"
             },
             "state": {
               "type": "string"
@@ -302,16 +311,10 @@
           "type": "string"
         },
         "last_order_id": {
-          "type": [
-            "integer",
-            "null"
-          ]
+          "type": "integer"
         },
         "last_order_name": {
-          "type": [
-            "null",
-            "string"
-          ]
+          "type": "string"
         },
         "marketing_opt_in_level": {
           "type": "string"
@@ -404,22 +407,15 @@
         "currency",
         "default_address",
         "email",
-        "email_marketing_consent",
         "first_name",
         "id",
         "last_name",
-        "last_order_id",
-        "last_order_name",
         "multipass_identifier",
         "note",
-        "orders_count",
         "phone",
-        "sms_marketing_consent",
         "state",
-        "tags",
         "tax_exempt",
         "tax_exemptions",
-        "total_spent",
         "updated_at",
         "verified_email"
       ],
@@ -1355,10 +1351,14 @@
   },
   "required": [
     "admin_graphql_api_id",
+    "allow_discount_codes_in_checkout?",
+    "api_client_id",
     "applied_discount",
+    "b2b?",
     "billing_address",
     "completed_at",
     "created_at",
+    "created_on_api_version_handle",
     "currency",
     "customer",
     "email",