shopify-webhook-schemas 0.1.0

package/metadatas/2023-10/company_locations/update.json

@@ -0,0 +1,76 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a company location is updated.",
+  "name": "company_locations/update",
+  "pii": [
+    "third_party",
+    "customer"
+  ],
+  "related_resource": "CompanyLocation",
+  "response": {
+    "name": "Montreal",
+    "external_id": "123456789",
+    "phone": "555-555-5555",
+    "locale": "en",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "note": "Head Office Location",
+    "buyer_experience_configuration": null,
+    "admin_graphql_api_id": "gid://shopify/CompanyLocation/408372092144951419",
+    "tax_exemptions": [
+      "CA_BC_CONTRACTOR_EXEMPTION",
+      "CA_BC_RESELLER_EXEMPTION"
+    ],
+    "company": {
+      "name": "Example Company",
+      "note": "This is an example company",
+      "external_id": "123456789",
+      "main_contact_admin_graphql_api_id": "gid://shopify/CompanyContact/408372092144951652",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "customer_since": "2021-12-31T19:00:00-05:00",
+      "admin_graphql_api_id": "gid://shopify/Company/408372092144951419"
+    },
+    "billing_address": {
+      "address1": "175 Sherbrooke Street West",
+      "city": "Montreal",
+      "province": "Quebec",
+      "country": "Canada",
+      "zip": "H3A 0G4",
+      "recipient": "Adam Felix",
+      "address2": null,
+      "phone": "+49738001239",
+      "zone_code": "QC",
+      "country_code": "CA",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "admin_graphql_api_id": "gid://shopify/CompanyAddress/141016871799219115",
+      "company_admin_graphql_api_id": "gid://shopify/Company/408372092144951419"
+    },
+    "shipping_address": {
+      "address1": "175 Sherbrooke Street West",
+      "city": "Montreal",
+      "province": "Quebec",
+      "country": "Canada",
+      "zip": "H3A 0G4",
+      "recipient": "Adam Felix",
+      "address2": null,
+      "phone": "+49738001239",
+      "zone_code": "QC",
+      "country_code": "CA",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "admin_graphql_api_id": "gid://shopify/CompanyAddress/141016871799219115",
+      "company_admin_graphql_api_id": "gid://shopify/Company/408372092144951419"
+    },
+    "tax_registration": {
+      "tax_id": "1214214141"
+    }
+  }
+}

package/metadatas/2023-10/customer.tags_added.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql"
+  ],
+  "description": "Triggers when tags are added to a customer.",
+  "name": "customer.tags_added",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Payload",
+  "response": {
+    "customerId": "gid://shopify/Customer/1",
+    "tags": [
+      "tag1",
+      "tag2"
+    ],
+    "occurredAt": "2005-05-05T00:00:00.000Z"
+  }
+}

package/metadatas/2023-10/customer.tags_removed.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql"
+  ],
+  "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-05T00:00:00.000Z"
+  }
+}

package/metadatas/2023-10/customer_groups/create.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a customer saved search is created.",
+  "name": "customer_groups/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CustomerSavedSearch",
+  "response": {
+    "id": 239443597569284770,
+    "name": "Repeat Customers",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "query": "orders_count:>1"
+  }
+}

package/metadatas/2023-10/customer_groups/delete.json

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

package/metadatas/2023-10/customer_groups/update.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a customer saved search is updated.",
+  "name": "customer_groups/update",
+  "related_resource": "CustomerSavedSearch",
+  "response": {
+    "id": 239443597569284770,
+    "name": "Repeat Customers",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "query": "orders_count:>1"
+  }
+}

package/metadatas/2023-10/customer_payment_methods/create.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "customer_payment_methods"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

package/metadatas/2023-10/customer_payment_methods/revoke.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "customer_payment_methods"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

package/metadatas/2023-10/customer_payment_methods/update.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "customer_payment_methods"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

package/metadatas/2023-10/customers/create.json

@@ -0,0 +1,43 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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",
+    "orders_count": 0,
+    "state": "disabled",
+    "total_spent": "0.00",
+    "last_order_id": null,
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "tags": "",
+    "last_order_name": null,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "accepts_marketing": false,
+    "accepts_marketing_updated_at": null,
+    "marketing_opt_in_level": null,
+    "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
+  }
+}

package/metadatas/2023-10/customers/delete.json

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

package/metadatas/2023-10/customers/disable.json

@@ -0,0 +1,43 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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",
+    "orders_count": 0,
+    "state": "disabled",
+    "total_spent": "0.00",
+    "last_order_id": null,
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "tags": "",
+    "last_order_name": null,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "accepts_marketing": false,
+    "accepts_marketing_updated_at": null,
+    "marketing_opt_in_level": null,
+    "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
+  }
+}

package/metadatas/2023-10/customers/enable.json

@@ -0,0 +1,43 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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",
+    "orders_count": 0,
+    "state": "disabled",
+    "total_spent": "0.00",
+    "last_order_id": null,
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "tags": "",
+    "last_order_name": null,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "accepts_marketing": false,
+    "accepts_marketing_updated_at": null,
+    "marketing_opt_in_level": null,
+    "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
+  }
+}

package/metadatas/2023-10/customers/merge.json

@@ -0,0 +1,27 @@
+{
+  "access_scopes": [
+    "customer_merge"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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."
+      }
+    ]
+  }
+}

package/metadatas/2023-10/customers/update.json

@@ -0,0 +1,43 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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",
+    "orders_count": 0,
+    "state": "disabled",
+    "total_spent": "0.00",
+    "last_order_id": null,
+    "note": "This customer loves ice cream",
+    "verified_email": true,
+    "multipass_identifier": null,
+    "tax_exempt": false,
+    "tags": "",
+    "last_order_name": null,
+    "currency": "USD",
+    "phone": null,
+    "addresses": [],
+    "accepts_marketing": false,
+    "accepts_marketing_updated_at": null,
+    "marketing_opt_in_level": null,
+    "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
+  }
+}

package/metadatas/2023-10/customers_email_marketing_consent/update.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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
+    }
+  }
+}

package/metadatas/2023-10/customers_marketing_consent/update.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

package/metadatas/2023-10/disputes/create.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "shopify_payments_disputes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a dispute is created.",
+  "name": "disputes/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Dispute",
+  "response": {
+    "id": 285332461850802050,
+    "order_id": 820982911946154500,
+    "type": "chargeback",
+    "amount": "11.50",
+    "currency": "CAD",
+    "reason": "fraudulent",
+    "network_reason_code": "4837",
+    "status": "under_review",
+    "evidence_due_by": "2021-12-30T19:00:00-05:00",
+    "evidence_sent_on": null,
+    "finalized_on": null,
+    "initiated_at": "2021-12-31T19:00:00-05:00"
+  }
+}

package/metadatas/2023-10/disputes/update.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "shopify_payments_disputes"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a dispute is updated.",
+  "name": "disputes/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Dispute",
+  "response": {
+    "id": 285332461850802050,
+    "order_id": 820982911946154500,
+    "type": "chargeback",
+    "amount": "11.50",
+    "currency": "CAD",
+    "reason": "fraudulent",
+    "network_reason_code": "4837",
+    "status": "under_review",
+    "evidence_due_by": "2021-12-30T19:00:00-05:00",
+    "evidence_sent_on": null,
+    "finalized_on": null,
+    "initiated_at": "2021-12-31T19:00:00-05:00"
+  }
+}

package/metadatas/2023-10/domains/create.json

@@ -0,0 +1,19 @@
+{
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a domain is created.",
+  "name": "domains/create",
+  "related_resource": "Domain",
+  "response": {
+    "id": 690933842,
+    "host": "jsmith.myshopify.com",
+    "ssl_enabled": true,
+    "localization": {
+      "country": null,
+      "default_locale": "en",
+      "alternate_locales": []
+    }
+  }
+}

package/metadatas/2023-10/domains/destroy.json

@@ -0,0 +1,19 @@
+{
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a domain is destroyed.",
+  "name": "domains/destroy",
+  "related_resource": "Domain",
+  "response": {
+    "id": 690933842,
+    "host": "jsmith.myshopify.com",
+    "ssl_enabled": true,
+    "localization": {
+      "country": null,
+      "default_locale": "en",
+      "alternate_locales": []
+    }
+  }
+}