shopify-webhook-schemas 0.1.0

package/metadatas/2024-04/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/2024-04/customers/update.json

@@ -0,0 +1,40 @@
+{
+  "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": [],
+    "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
+    "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
+  }
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "discounts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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-29T08:00:00-04:00",
+    "updated_at": "2016-08-29T08:00:00-04:00"
+  }
+}

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

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "discounts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a discount is deleted.",
+  "name": "discounts/delete",
+  "related_resource": "PriceRule",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
+    "deleted_at": "2018-08-29T08:00:00-04:00"
+  }
+}

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

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "discounts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a redeem code is added to a code discount.",
+  "name": "discounts/redeemcode_added",
+  "related_resource": "DiscountsRedeemcodeWebhookPayload",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/DiscountCodeNode/1",
+    "redeem_code": {
+      "id": "gid://shopify/DiscountRedeemCode/1",
+      "code": "code1"
+    },
+    "updated_at": "2018-08-29T12:00:00.000Z"
+  }
+}

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

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "discounts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a redeem code on a code discount is deleted.",
+  "name": "discounts/redeemcode_removed",
+  "related_resource": "DiscountsRedeemcodeWebhookPayload",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/DiscountCodeNode/1",
+    "redeem_code": {
+      "id": "gid://shopify/DiscountRedeemCode/1",
+      "code": "code1"
+    },
+    "updated_at": "2018-08-29T12:00:00.000Z"
+  }
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "discounts"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a discount is updated.",
+  "name": "discounts/update",
+  "related_resource": "PriceRule",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
+    "title": "Automatic free shipping updated",
+    "status": "ACTIVE",
+    "created_at": "2016-08-29T08:00:00-04:00",
+    "updated_at": "2016-08-29T08:00:00-04:00"
+  }
+}

package/metadatas/2024-04/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/2024-04/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/2024-04/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/2024-04/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": []
+    }
+  }
+}

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

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

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

@@ -0,0 +1,237 @@
+{
+  "access_scopes": [
+    "draft_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a draft order is created.",
+  "name": "draft_orders/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "DraftOrder",
+  "response": {
+    "id": 890612572568261600,
+    "note": null,
+    "email": "jon@doe.ca",
+    "taxes_included": false,
+    "currency": "USD",
+    "invoice_sent_at": null,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "tax_exempt": false,
+    "completed_at": null,
+    "name": "#D133",
+    "status": "open",
+    "line_items": [
+      {
+        "id": 2703207,
+        "variant_id": 49148385,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Red",
+        "sku": "IPOD2008RED",
+        "vendor": "Apple",
+        "quantity": 10,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "fulfillment_service": "manual",
+        "grams": 567,
+        "tax_lines": [],
+        "applied_discount": null,
+        "name": "IPod Nano - 8GB - Red",
+        "properties": [],
+        "custom": false,
+        "price": "199.00",
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2703207"
+      },
+      {
+        "id": 1922369,
+        "variant_id": 457924702,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Black",
+        "sku": "IPOD2008BLACK",
+        "vendor": "Apple",
+        "quantity": 3,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "fulfillment_service": "manual",
+        "grams": 567,
+        "tax_lines": [],
+        "applied_discount": null,
+        "name": "IPod Nano - 8GB - Black",
+        "properties": [],
+        "custom": false,
+        "price": "199.00",
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/1922369"
+      },
+      {
+        "id": 1718363,
+        "variant_id": 808950810,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Pink",
+        "sku": "IPOD2008PINK",
+        "vendor": "Apple",
+        "quantity": 1,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "fulfillment_service": "manual",
+        "grams": 567,
+        "tax_lines": [],
+        "applied_discount": null,
+        "name": "IPod Nano - 8GB - Pink",
+        "properties": [],
+        "custom": false,
+        "price": "199.00",
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/1718363"
+      }
+    ],
+    "shipping_address": {
+      "first_name": "Steve",
+      "address1": "123 Shipping Street",
+      "phone": "555-555-SHIP",
+      "city": "Shippington",
+      "zip": "40150",
+      "province": "Kentucky",
+      "country": "United States",
+      "last_name": "Shipper",
+      "address2": null,
+      "company": "Shipping Company",
+      "latitude": null,
+      "longitude": null,
+      "name": "Steve Shipper",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "billing_address": {
+      "first_name": "Bob",
+      "address1": "123 Billing Street",
+      "phone": "555-555-BILL",
+      "city": "Billtown",
+      "zip": "K2P0B0",
+      "province": "Kentucky",
+      "country": "United States",
+      "last_name": "Biller",
+      "address2": null,
+      "company": "My Company",
+      "latitude": null,
+      "longitude": null,
+      "name": "Bob Biller",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "invoice_url": "https://jsmith.myshopify.com/548380009/invoices/abcd1234abcd1234abcd1234abcd1234",
+    "applied_discount": {
+      "description": "ABC 123",
+      "value": "10.0",
+      "title": "ABC 123",
+      "amount": "7.00",
+      "value_type": "percentage"
+    },
+    "order_id": null,
+    "shipping_line": {
+      "title": "ABC 123",
+      "custom": true,
+      "handle": null,
+      "price": "3.00"
+    },
+    "tax_lines": [
+      {
+        "rate": 0.017665625571207967,
+        "title": "State tax",
+        "price": "4.00"
+      },
+      {
+        "rate": 0.017665625571207967,
+        "title": "State tax",
+        "price": "1.00"
+      },
+      {
+        "rate": 0.017665625571207967,
+        "title": "State tax",
+        "price": "2.00"
+      }
+    ],
+    "tags": "",
+    "note_attributes": [],
+    "total_price": "490.00",
+    "subtotal_price": "449.00",
+    "total_tax": "410.00",
+    "payment_terms": {
+      "id": 706405506930370000,
+      "payment_terms_name": "Net 7",
+      "payment_terms_type": "net",
+      "due_in_days": 7,
+      "created_at": "2021-01-01T00:00:00-05:00",
+      "updated_at": "2021-01-01T00:00:01-05:00",
+      "payment_schedules": [
+        {
+          "id": 606405506930370000,
+          "created_at": "2021-01-01T00:00:00-05:00",
+          "updated_at": "2021-01-01T00:00:01-05:00",
+          "payment_terms_id": 706405506930370000,
+          "issued_at": "2021-01-01T00:00:00-05:00",
+          "due_at": "2021-01-02T00:00:00-05:00",
+          "completed_at": "2021-01-02T00:00:00-05:00",
+          "amount": "10.00",
+          "currency": "USD"
+        }
+      ]
+    },
+    "admin_graphql_api_id": "gid://shopify/DraftOrder/890612572568261625",
+    "customer": {
+      "id": 706405506930370000,
+      "email": "john@doe.ca",
+      "created_at": null,
+      "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/706405506930370084",
+      "default_address": {
+        "id": null,
+        "customer_id": 706405506930370000,
+        "first_name": null,
+        "last_name": null,
+        "company": null,
+        "address1": "123 Elm St.",
+        "address2": null,
+        "city": "Ottawa",
+        "province": "Ontario",
+        "country": "Canada",
+        "zip": "K2H7A8",
+        "phone": "123-123-1234",
+        "name": "",
+        "province_code": "ON",
+        "country_code": "CA",
+        "country_name": "Canada",
+        "default": true
+      }
+    }
+  }
+}

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

@@ -0,0 +1,15 @@
+{
+  "access_scopes": [
+    "draft_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a draft order is deleted.",
+  "name": "draft_orders/delete",
+  "related_resource": "DraftOrder",
+  "response": {
+    "id": 890612572568261600
+  }
+}