shopify-webhook-schemas 0.2.1 → 0.2.2

package/dist/src/scrape.js

@@ -96,6 +96,11 @@ const main = async () => {
             else {
                 webhook.response = JSON.parse(webhook.response);
             }
+            if (webhook.response === undefined || webhook.response === null) {
+                console.warn(`${webhook.name} has an empty response`);
+                warnings += 1;
+                webhook.response = {};
+            }
             const metadataFile = path_1.default.join(rootDir, "metadatas", version, webhook.name + ".json");
             await fs_extra_1.default.mkdir(path_1.default.dirname(metadataFile), { recursive: true });
             await fs_extra_1.default.writeFile(metadataFile, JSON.stringify(webhook, null, 2), "utf-8");

package/metadatas/2024-04/app/scopes_update.json

@@ -0,0 +1,23 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever the access scopes of any installation are modified. Allows apps to keep track of the granted access scopes of their installations.",
+  "name": "app/scopes_update",
+  "related_resource": "Shop",
+  "response": {
+    "id": 1,
+    "previous": [
+      "read_products"
+    ],
+    "current": [
+      "read_products",
+      "write_products"
+    ],
+    "updated_at": "2024-06-25T00:00:00.000Z"
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/app_purchases_one_time/update.json

@@ -9,7 +9,7 @@
   "related_resource": "ApplicationCharge",
   "response": {
     "app_purchase_one_time": {
-      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262348",
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262352",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

package/metadatas/2024-04/app_subscriptions/approaching_capped_amount.json

@@ -9,7 +9,7 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266956",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266955",
       "name": "Webhook Test",
       "balance_used": 0,
       "capped_amount": "20.0",

package/metadatas/2024-04/app_subscriptions/update.json

@@ -10,14 +10,17 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266951",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266960",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
       "created_at": "2021-12-31T19:00:00-05:00",
       "updated_at": "2021-12-31T19:00:00-05:00",
       "currency": "USD",
-      "capped_amount": "20.0"
+      "capped_amount": "20.0",
+      "price": "10.00",
+      "interval": "every_30_days",
+      "plan_handle": "plan-123"
     }
   },
   "shop_feature": false

package/metadatas/2024-04/bulk_operations/finish.json

@@ -11,7 +11,7 @@
   "response": {
     "admin_graphql_api_id": "gid://shopify/BulkOperation/147595010",
     "completed_at": "2024-01-01T07:34:56-05:00",
-    "created_at": "2025-01-30T15:41:03-05:00",
+    "created_at": "2025-06-13T11:19:23-04:00",
     "error_code": null,
     "status": "completed",
     "type": "query"

package/metadatas/2024-04/checkout_and_accounts_configurations/update.json

@@ -0,0 +1,22 @@
+{
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "The event occurs whenever a published checkout and account configuration is updated.",
+  "name": "checkout_and_accounts_configurations/update",
+  "related_resource": "Payload",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/CheckoutProfile/1",
+    "name": "Sample Checkout Profile",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "edited_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "is_published": true,
+    "settings": {
+      "typ_osp_pages_enabled": false
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/checkouts/create.json

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "fd5774a7c08ef6210bc390184a712caa",
-        "destination_location_id": 1015975132,
+        "key": "b22a172abde59e26c1ae496968b82f80",
+        "destination_location_id": 1015975144,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975131,
+        "origin_location_id": 1015975143,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "fd5774a7c08ef6210bc390184a712caa",
-        "destination_location_id": 1015975132,
+        "key": "b22a172abde59e26c1ae496968b82f80",
+        "destination_location_id": 1015975144,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975131,
+        "origin_location_id": 1015975143,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -182,6 +182,7 @@
     "total_tax": "23.88",
     "subtotal_price": "398.00",
     "total_duties": null,
+    "reservation_token": null,
     "billing_address": {
       "first_name": "Bob",
       "address1": "123 Billing Street",
@@ -223,25 +224,14 @@
       "updated_at": null,
       "first_name": "John",
       "last_name": "Smith",
-      "orders_count": 0,
       "state": "disabled",
-      "total_spent": "0.00",
-      "last_order_id": null,
       "note": null,
       "verified_email": true,
       "multipass_identifier": null,
       "tax_exempt": false,
-      "tags": "",
-      "last_order_name": null,
       "currency": "USD",
       "phone": null,
       "tax_exemptions": [],
-      "email_marketing_consent": {
-        "state": "not_subscribed",
-        "opt_in_level": null,
-        "consent_updated_at": null
-      },
-      "sms_marketing_consent": null,
       "admin_graphql_api_id": "gid://shopify/Customer/603851970716743426",
       "default_address": {
         "id": null,

package/metadatas/2024-04/checkouts/delete.json

@@ -22,7 +22,8 @@
     "total_tax": "23.88",
     "subtotal_price": "398.00",
     "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
-    "total_duties": null
+    "total_duties": null,
+    "reservation_token": null
   },
   "shop_feature": false
 }

package/metadatas/2024-04/checkouts/update.json

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "261145db8f8a3d8ac9e8a66d0cedc6b9",
-        "destination_location_id": 1015975146,
+        "key": "cb3277c1334fee8f5ddebb2a93a991b2",
+        "destination_location_id": 1015975154,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975145,
+        "origin_location_id": 1015975153,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "261145db8f8a3d8ac9e8a66d0cedc6b9",
-        "destination_location_id": 1015975146,
+        "key": "cb3277c1334fee8f5ddebb2a93a991b2",
+        "destination_location_id": 1015975154,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975145,
+        "origin_location_id": 1015975153,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -182,6 +182,7 @@
     "total_tax": "23.88",
     "subtotal_price": "398.00",
     "total_duties": null,
+    "reservation_token": null,
     "billing_address": {
       "first_name": "Bob",
       "address1": "123 Billing Street",
@@ -223,25 +224,14 @@
       "updated_at": null,
       "first_name": "John",
       "last_name": "Smith",
-      "orders_count": 0,
       "state": "disabled",
-      "total_spent": "0.00",
-      "last_order_id": null,
       "note": null,
       "verified_email": true,
       "multipass_identifier": null,
       "tax_exempt": false,
-      "tags": "",
-      "last_order_name": null,
       "currency": "USD",
       "phone": null,
       "tax_exemptions": [],
-      "email_marketing_consent": {
-        "state": "not_subscribed",
-        "opt_in_level": null,
-        "consent_updated_at": null
-      },
-      "sms_marketing_consent": null,
       "admin_graphql_api_id": "gid://shopify/Customer/603851970716743426",
       "default_address": {
         "id": null,

package/metadatas/2024-04/company_contact_roles/assign.json

@@ -48,6 +48,14 @@
         "CA_BC_CONTRACTOR_EXEMPTION",
         "CA_BC_RESELLER_EXEMPTION"
       ],
+      "tax_settings": {
+        "tax_registration_id": "1214214141",
+        "tax_exempt": null,
+        "tax_exemptions": [
+          "CA_BC_CONTRACTOR_EXEMPTION",
+          "CA_BC_RESELLER_EXEMPTION"
+        ]
+      },
       "company": {
         "name": "Example Company",
         "note": "This is an example company",

package/metadatas/2024-04/company_contact_roles/revoke.json

@@ -48,6 +48,14 @@
         "CA_BC_CONTRACTOR_EXEMPTION",
         "CA_BC_RESELLER_EXEMPTION"
       ],
+      "tax_settings": {
+        "tax_registration_id": "1214214141",
+        "tax_exempt": null,
+        "tax_exemptions": [
+          "CA_BC_CONTRACTOR_EXEMPTION",
+          "CA_BC_RESELLER_EXEMPTION"
+        ]
+      },
       "company": {
         "name": "Example Company",
         "note": "This is an example company",

package/metadatas/2024-04/company_locations/create.json

@@ -29,6 +29,14 @@
       "CA_BC_CONTRACTOR_EXEMPTION",
       "CA_BC_RESELLER_EXEMPTION"
     ],
+    "tax_settings": {
+      "tax_registration_id": "1214214141",
+      "tax_exempt": null,
+      "tax_exemptions": [
+        "CA_BC_CONTRACTOR_EXEMPTION",
+        "CA_BC_RESELLER_EXEMPTION"
+      ]
+    },
     "company": {
       "name": "Example Company",
       "note": "This is an example company",

package/metadatas/2024-04/company_locations/delete.json

@@ -26,6 +26,14 @@
       "CA_BC_CONTRACTOR_EXEMPTION",
       "CA_BC_RESELLER_EXEMPTION"
     ],
+    "tax_settings": {
+      "tax_registration_id": "1214214141",
+      "tax_exempt": null,
+      "tax_exemptions": [
+        "CA_BC_CONTRACTOR_EXEMPTION",
+        "CA_BC_RESELLER_EXEMPTION"
+      ]
+    },
     "company": {
       "name": "Example Company",
       "note": "This is an example company",

package/metadatas/2024-04/company_locations/update.json

@@ -29,6 +29,14 @@
       "CA_BC_CONTRACTOR_EXEMPTION",
       "CA_BC_RESELLER_EXEMPTION"
     ],
+    "tax_settings": {
+      "tax_registration_id": "1214214141",
+      "tax_exempt": null,
+      "tax_exemptions": [
+        "CA_BC_CONTRACTOR_EXEMPTION",
+        "CA_BC_RESELLER_EXEMPTION"
+      ]
+    },
     "company": {
       "name": "Example Company",
       "note": "This is an example company",

package/metadatas/2024-04/customer.joined_segment.json

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a customer joins a segment.",
+  "name": "customer.joined_segment",
+  "related_resource": "JoinedSegment",
+  "response": {
+    "shop_id": "gid://shopify/Shop/1",
+    "customer_id": "gid://shopify/Customer/2",
+    "segment_id": "gid://shopify/Segment/3"
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/customer.left_segment.json

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a customer leaves a segment.",
+  "name": "customer.left_segment",
+  "related_resource": "LeftSegment",
+  "response": {
+    "shop_id": "gid://shopify/Shop/1",
+    "customer_id": "gid://shopify/Customer/2",
+    "segment_id": "gid://shopify/Segment/3"
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/customer.tags_added.json

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T07:00:00.000Z"
+    "occurredAt": "2005-05-05T04:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/customer.tags_removed.json

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T07:00:00.000Z"
+    "occurredAt": "2005-05-05T04:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/customer_account_settings/update.json

@@ -0,0 +1,17 @@
+{
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when merchants change customer account setting.",
+  "name": "customer_account_settings/update",
+  "related_resource": "CustomerSettingsRecord",
+  "response": {
+    "url": null,
+    "customer_accounts_version": "classic",
+    "login_required_at_checkout": true,
+    "login_links_visible_on_storefront_and_checkout": true
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/customers/create.json

@@ -21,22 +21,15 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
-    "orders_count": 1,
     "state": "disabled",
-    "total_spent": "100.00",
-    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
-    "tags": "",
-    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
-    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

package/metadatas/2024-04/customers/delete.json

@@ -16,8 +16,6 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
-    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
   },
   "shop_feature": false

package/metadatas/2024-04/customers/disable.json

@@ -21,22 +21,15 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
-    "orders_count": 1,
     "state": "disabled",
-    "total_spent": "100.00",
-    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
-    "tags": "",
-    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
-    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

package/metadatas/2024-04/customers/enable.json

@@ -21,22 +21,15 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
-    "orders_count": 1,
     "state": "disabled",
-    "total_spent": "100.00",
-    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
-    "tags": "",
-    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
-    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

package/metadatas/2024-04/customers/purchasing_summary.json

@@ -0,0 +1,27 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a customer sales history change.",
+  "name": "customers/purchasing_summary",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Payload",
+  "response": {
+    "customerId": "gid://shopify/Customer/1",
+    "numberOfOrders": 1,
+    "amountSpent": {
+      "amount": "100.00",
+      "currencyCode": "USD"
+    },
+    "lastOrderId": "gid://shopify/Order/1",
+    "occurredAt": "2005-05-05T04:00:00.000Z"
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/customers/update.json

@@ -21,22 +21,15 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
-    "orders_count": 1,
     "state": "disabled",
-    "total_spent": "100.00",
-    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
-    "tags": "",
-    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
-    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

package/metadatas/2024-04/delivery_promise_settings/update.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "shipping"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a promise setting is updated.",
+  "name": "delivery_promise_settings/update",
+  "related_resource": "PromiseSetting",
+  "response": {
+    "shop_id": "gid://shopify/Shop/548380009",
+    "processing_time": "P2D",
+    "delivery_dates_enabled": true
+  },
+  "shop_feature": false
+}

package/metadatas/2024-04/discounts/create.json

@@ -15,8 +15,8 @@
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
     "title": "Automatic free shipping",
     "status": "ACTIVE",
-    "created_at": "2016-08-29T15:00:00-04:00",
-    "updated_at": "2016-08-29T15:00:00-04:00"
+    "created_at": "2016-08-29T12:00:00-04:00",
+    "updated_at": "2016-08-29T12:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/discounts/delete.json

@@ -13,7 +13,7 @@
   "related_resource": "PriceRule",
   "response": {
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
-    "deleted_at": "2018-08-29T15:00:00-04:00"
+    "deleted_at": "2018-08-29T12:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/discounts/redeemcode_added.json

@@ -17,7 +17,7 @@
       "id": "gid://shopify/DiscountRedeemCode/1",
       "code": "code1"
     },
-    "updated_at": "2018-08-29T19:00:00.000Z"
+    "updated_at": "2018-08-29T16:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/discounts/redeemcode_removed.json

@@ -17,7 +17,7 @@
       "id": "gid://shopify/DiscountRedeemCode/1",
       "code": "code1"
     },
-    "updated_at": "2018-08-29T19:00:00.000Z"
+    "updated_at": "2018-08-29T16:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/discounts/update.json

@@ -15,8 +15,8 @@
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
     "title": "Automatic free shipping updated",
     "status": "ACTIVE",
-    "created_at": "2016-08-29T15:00:00-04:00",
-    "updated_at": "2016-08-29T15:00:00-04:00"
+    "created_at": "2016-08-29T12:00:00-04:00",
+    "updated_at": "2016-08-29T12:00:00-04:00"
   },
   "shop_feature": false
 }