shopify-webhook-schemas 0.1.6 → 0.1.7

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

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when tags are removed from a customer.",
+  "name": "customer.tags_removed",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Payload",
+  "response": {
+    "customerId": "gid://shopify/Customer/1",
+    "tags": [
+      "tag1",
+      "tag2"
+    ],
+    "occurredAt": "2005-05-05T07:00:00.000Z"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-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/2025-04/customer_groups/create.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer saved search is created.",
+  "name": "customer_groups/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CustomerSavedSearch",
+  "response": {
+    "id": 239443597569284770,
+    "name": "Bob Customers",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "query": "email:bob*"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customer_groups/delete.json

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer saved search is deleted.",
+  "name": "customer_groups/delete",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CustomerSavedSearch",
+  "response": {
+    "id": 239443597569284770
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customer_groups/update.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer saved search is updated.",
+  "name": "customer_groups/update",
+  "related_resource": "CustomerSavedSearch",
+  "response": {
+    "id": 239443597569284770,
+    "name": "Bob Customers",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "query": "email:bob*"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customer_payment_methods/create.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "customer_payment_methods"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer payment method is created.",
+  "name": "customer_payment_methods/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CustomerPaymentMethod",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/CustomerPaymentMethod/0eccccc666aac73efcd31094ddc4ebf0",
+    "token": "0eccccc666aac73efcd31094ddc4ebf0",
+    "customer_id": 82850125,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/82850125",
+    "instrument_type": "CustomerCreditCard",
+    "payment_instrument": {
+      "last_digits": "4242",
+      "month": 8,
+      "year": 2060,
+      "name": "Jim Smith",
+      "brand": "Visa"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customer_payment_methods/revoke.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "customer_payment_methods"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer payment method is revoked.",
+  "name": "customer_payment_methods/revoke",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CustomerPaymentMethod",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/CustomerPaymentMethod/0eccccc666aac73efcd31094ddc4ebf0",
+    "token": "0eccccc666aac73efcd31094ddc4ebf0",
+    "customer_id": 82850125,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/82850125",
+    "instrument_type": "CustomerCreditCard",
+    "payment_instrument": {
+      "last_digits": "4242",
+      "month": 8,
+      "year": 2060,
+      "name": "Jim Smith",
+      "brand": "Visa"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customer_payment_methods/update.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "customer_payment_methods"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer payment method is updated.",
+  "name": "customer_payment_methods/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CustomerPaymentMethod",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/CustomerPaymentMethod/0eccccc666aac73efcd31094ddc4ebf0",
+    "token": "0eccccc666aac73efcd31094ddc4ebf0",
+    "customer_id": 82850125,
+    "admin_graphql_api_customer_id": "gid://shopify/Customer/82850125",
+    "instrument_type": "CustomerCreditCard",
+    "payment_instrument": {
+      "last_digits": "4242",
+      "month": 8,
+      "year": 2060,
+      "name": "Jim Smith",
+      "brand": "Visa"
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,55 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer is created.",
+  "name": "customers/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Customer",
+  "response": {
+    "id": 706405506930370000,
+    "email": "bob@biller.com",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "first_name": "Bob",
+    "last_name": "Biller",
+    "state": "disabled",
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "tax_exemptions": [],
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
+    "default_address": {
+      "id": 12321,
+      "customer_id": 706405506930370000,
+      "first_name": "Bob",
+      "last_name": "Biller",
+      "company": null,
+      "address1": "151 O'Connor Street",
+      "address2": null,
+      "city": "Ottawa",
+      "province": "ON",
+      "country": "CA",
+      "zip": "K2P 2L8",
+      "phone": "555-555-5555",
+      "name": "Bob Biller",
+      "province_code": "ON",
+      "country_code": "CA",
+      "country_name": "CA",
+      "default": false
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customers/data_request.json

@@ -0,0 +1,28 @@
+{
+  "available_on": [
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Customers can request their data from a store owner. When this happens, Shopify sends a payload on the customers/data_request topic to the apps that are installed on that store.",
+  "name": "customers/data_request",
+  "privacy_compliance_topic": true,
+  "related_resource": "Customer",
+  "response": {
+    "shop_id": 954889,
+    "shop_domain": "{shop}.myshopify.com",
+    "customer": {
+      "id": 191167,
+      "email": "john@example.com",
+      "phone": "555-625-1199"
+    },
+    "orders_requested": [
+      299938,
+      280263,
+      220458
+    ],
+    "data_request": {
+      "id": 9999
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer is deleted.",
+  "name": "customers/delete",
+  "related_resource": "Customer",
+  "response": {
+    "id": 706405506930370000,
+    "phone": null,
+    "addresses": [],
+    "tax_exemptions": [],
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,55 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer account is disabled.",
+  "name": "customers/disable",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Customer",
+  "response": {
+    "id": 706405506930370000,
+    "email": "bob@biller.com",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "first_name": "Bob",
+    "last_name": "Biller",
+    "state": "disabled",
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "tax_exemptions": [],
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
+    "default_address": {
+      "id": 12321,
+      "customer_id": 706405506930370000,
+      "first_name": "Bob",
+      "last_name": "Biller",
+      "company": null,
+      "address1": "151 O'Connor Street",
+      "address2": null,
+      "city": "Ottawa",
+      "province": "ON",
+      "country": "CA",
+      "zip": "K2P 2L8",
+      "phone": "555-555-5555",
+      "name": "Bob Biller",
+      "province_code": "ON",
+      "country_code": "CA",
+      "country_name": "CA",
+      "default": false
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,55 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer account is enabled.",
+  "name": "customers/enable",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Customer",
+  "response": {
+    "id": 706405506930370000,
+    "email": "bob@biller.com",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "first_name": "Bob",
+    "last_name": "Biller",
+    "state": "disabled",
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "tax_exemptions": [],
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
+    "default_address": {
+      "id": 12321,
+      "customer_id": 706405506930370000,
+      "first_name": "Bob",
+      "last_name": "Biller",
+      "company": null,
+      "address1": "151 O'Connor Street",
+      "address2": null,
+      "city": "Ottawa",
+      "province": "ON",
+      "country": "CA",
+      "zip": "K2P 2L8",
+      "phone": "555-555-5555",
+      "name": "Bob Biller",
+      "province_code": "ON",
+      "country_code": "CA",
+      "country_name": "CA",
+      "default": false
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customers/merge.json

@@ -0,0 +1,30 @@
+{
+  "access_scopes": [
+    "customer_merge"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when two customers are merged",
+  "name": "customers/merge",
+  "related_resource": "CustomerMergeRequest",
+  "response": {
+    "admin_graphql_api_customer_kept_id": "gid://shopify/Customer/1",
+    "admin_graphql_api_customer_deleted_id": "gid://shopify/Customer/2",
+    "admin_graphql_api_job_id": null,
+    "status": "failed",
+    "errors": [
+      {
+        "customer_ids": [
+          1
+        ],
+        "field": "merge_in_progress",
+        "message": "John Doe is currently being merged."
+      }
+    ]
+  },
+  "shop_feature": false
+}

package/metadatas/2025-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-05T07:00:00.000Z"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customers/redact.json

@@ -0,0 +1,25 @@
+{
+  "available_on": [
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Store owners can request that data is deleted on behalf of a customer. When this happens, Shopify sends a payload on the customers/redact topic to the apps installed on that store.\n\nCustomer redaction occurs either at the end of the grace period after the redaction was requested (today + 10 days), OR the customer's last order date plus the chargeback period of 60 days (last order date + 60 days), whichever occurs later.",
+  "name": "customers/redact",
+  "privacy_compliance_topic": true,
+  "related_resource": "Customer",
+  "response": {
+    "shop_id": 954889,
+    "shop_domain": "{shop}.myshopify.com",
+    "customer": {
+      "id": 191167,
+      "email": "john@example.com",
+      "phone": "555-625-1199"
+    },
+    "orders_to_redact": [
+      299938,
+      280263,
+      220458
+    ]
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,55 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer is updated.",
+  "name": "customers/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Customer",
+  "response": {
+    "id": 706405506930370000,
+    "email": "bob@biller.com",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "first_name": "Bob",
+    "last_name": "Biller",
+    "state": "disabled",
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "tax_exemptions": [],
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
+    "default_address": {
+      "id": 12321,
+      "customer_id": 706405506930370000,
+      "first_name": "Bob",
+      "last_name": "Biller",
+      "company": null,
+      "address1": "151 O'Connor Street",
+      "address2": null,
+      "city": "Ottawa",
+      "province": "ON",
+      "country": "CA",
+      "zip": "K2P 2L8",
+      "phone": "555-555-5555",
+      "name": "Bob Biller",
+      "province_code": "ON",
+      "country_code": "CA",
+      "country_name": "CA",
+      "default": false
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customers_email_marketing_consent/update.json

@@ -0,0 +1,27 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer's email marketing consent is updated.",
+  "name": "customers_email_marketing_consent/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Customer",
+  "response": {
+    "customer_id": 706405506930370000,
+    "email_address": null,
+    "email_marketing_consent": {
+      "state": null,
+      "opt_in_level": null,
+      "consent_updated_at": null
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/customers_marketing_consent/update.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a customer's SMS marketing consent is updated.",
+  "name": "customers_marketing_consent/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Customer",
+  "response": {
+    "id": 706405506930370000,
+    "phone": null,
+    "sms_marketing_consent": {
+      "state": null,
+      "opt_in_level": null,
+      "consent_updated_at": null,
+      "consent_collected_from": "other"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-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/2025-04/discounts/create.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "discounts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a discount is created.",
+  "name": "discounts/create",
+  "related_resource": "PriceRule",
+  "response": {
+    "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"
+  },
+  "shop_feature": false
+}