shopify-webhook-schemas 0.2.9 → 0.3.2

package/metadatas/2026-01/draft_orders/create.json

@@ -0,0 +1,244 @@
+{
+  "access_scopes": [
+    "draft_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "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": "#D185",
+    "allow_discount_codes_in_checkout?": false,
+    "b2b?": false,
+    "status": "open",
+    "line_items": [
+      {
+        "id": 4939213,
+        "variant_id": 49148385,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Red",
+        "sku": "IPOD2008RED",
+        "vendor": "Apple",
+        "quantity": 4,
+        "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/4939213"
+      },
+      {
+        "id": 2339947,
+        "variant_id": 457924702,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Black",
+        "sku": "IPOD2008BLACK",
+        "vendor": "Apple",
+        "quantity": 7,
+        "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/2339947"
+      },
+      {
+        "id": 2052809,
+        "variant_id": 808950810,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Pink",
+        "sku": "IPOD2008PINK",
+        "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 - Pink",
+        "properties": [],
+        "custom": false,
+        "price": "199.00",
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2052809"
+      }
+    ],
+    "api_client_id": null,
+    "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",
+    "created_on_api_version_handle": null,
+    "applied_discount": {
+      "description": "ABC 123",
+      "value": "4.0",
+      "title": "ABC 123",
+      "amount": "5.00",
+      "value_type": "percentage"
+    },
+    "order_id": null,
+    "shipping_line": {
+      "title": "ABC 123",
+      "custom": true,
+      "handle": null,
+      "price": "2.00"
+    },
+    "tax_lines": [
+      {
+        "rate": 0.025949325979406725,
+        "title": "State tax",
+        "price": "2.00"
+      },
+      {
+        "rate": 0.025949325979406725,
+        "title": "State tax",
+        "price": "2.00"
+      },
+      {
+        "rate": 0.025949325979406725,
+        "title": "State tax",
+        "price": "5.00"
+      }
+    ],
+    "tags": "",
+    "note_attributes": [],
+    "total_price": "436.00",
+    "subtotal_price": "442.00",
+    "total_tax": "442.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,
+          "reference_id": 890612572568261600,
+          "reference_type": "DraftOrder",
+          "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": "436.00",
+          "currency": "USD",
+          "total_price": "436.00",
+          "total_price_currency": "USD",
+          "balance_due": "436.00",
+          "balance_due_currency": "USD",
+          "total_balance": "436.00",
+          "total_balance_currency": "USD",
+          "outstanding_balance": "436.00",
+          "outstanding_balance_currency": "USD"
+        }
+      ],
+      "can_pay_early": true
+    },
+    "admin_graphql_api_id": "gid://shopify/DraftOrder/890612572568261625",
+    "customer": {
+      "id": 706405506930370000,
+      "created_at": null,
+      "updated_at": null,
+      "first_name": "John",
+      "last_name": "Smith",
+      "state": "disabled",
+      "note": null,
+      "verified_email": true,
+      "multipass_identifier": null,
+      "tax_exempt": false,
+      "email": "john@doe.ca",
+      "phone": null,
+      "currency": "USD",
+      "tax_exemptions": [],
+      "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
+      "default_address": {
+        "id": null,
+        "customer_id": 706405506930370000,
+        "first_name": "John",
+        "last_name": "Smith",
+        "company": null,
+        "address1": "123 Elm St.",
+        "address2": null,
+        "city": "Ottawa",
+        "province": "Ontario",
+        "country": "Canada",
+        "zip": "K2H7A8",
+        "phone": "123-123-1234",
+        "name": "John Smith",
+        "province_code": "ON",
+        "country_code": "CA",
+        "country_name": "Canada",
+        "default": true
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/draft_orders/delete.json

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

package/metadatas/2026-01/draft_orders/update.json

@@ -0,0 +1,244 @@
+{
+  "access_scopes": [
+    "draft_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a draft order is updated.",
+  "name": "draft_orders/update",
+  "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": "#D182",
+    "allow_discount_codes_in_checkout?": false,
+    "b2b?": false,
+    "status": "open",
+    "line_items": [
+      {
+        "id": 1284372,
+        "variant_id": 49148385,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Red",
+        "sku": "IPOD2008RED",
+        "vendor": "Apple",
+        "quantity": 9,
+        "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/1284372"
+      },
+      {
+        "id": 4461594,
+        "variant_id": 457924702,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Black",
+        "sku": "IPOD2008BLACK",
+        "vendor": "Apple",
+        "quantity": 8,
+        "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/4461594"
+      },
+      {
+        "id": 4171510,
+        "variant_id": 808950810,
+        "product_id": 632910392,
+        "title": "IPod Nano - 8GB",
+        "variant_title": "Pink",
+        "sku": "IPOD2008PINK",
+        "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 - Pink",
+        "properties": [],
+        "custom": false,
+        "price": "199.00",
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4171510"
+      }
+    ],
+    "api_client_id": null,
+    "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",
+    "created_on_api_version_handle": null,
+    "applied_discount": {
+      "description": "ABC 123",
+      "value": "4.0",
+      "title": "ABC 123",
+      "amount": "5.00",
+      "value_type": "percentage"
+    },
+    "order_id": null,
+    "shipping_line": {
+      "title": "ABC 123",
+      "custom": true,
+      "handle": null,
+      "price": "10.00"
+    },
+    "tax_lines": [
+      {
+        "rate": 0.038739936816011726,
+        "title": "State tax",
+        "price": "5.00"
+      },
+      {
+        "rate": 0.038739936816011726,
+        "title": "State tax",
+        "price": "2.00"
+      },
+      {
+        "rate": 0.038739936816011726,
+        "title": "State tax",
+        "price": "4.00"
+      }
+    ],
+    "tags": "",
+    "note_attributes": [],
+    "total_price": "427.00",
+    "subtotal_price": "483.00",
+    "total_tax": "490.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,
+          "reference_id": 890612572568261600,
+          "reference_type": "DraftOrder",
+          "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": "427.00",
+          "currency": "USD",
+          "total_price": "427.00",
+          "total_price_currency": "USD",
+          "balance_due": "427.00",
+          "balance_due_currency": "USD",
+          "total_balance": "427.00",
+          "total_balance_currency": "USD",
+          "outstanding_balance": "427.00",
+          "outstanding_balance_currency": "USD"
+        }
+      ],
+      "can_pay_early": true
+    },
+    "admin_graphql_api_id": "gid://shopify/DraftOrder/890612572568261625",
+    "customer": {
+      "id": 706405506930370000,
+      "created_at": null,
+      "updated_at": null,
+      "first_name": "John",
+      "last_name": "Smith",
+      "state": "disabled",
+      "note": null,
+      "verified_email": true,
+      "multipass_identifier": null,
+      "tax_exempt": false,
+      "email": "john@doe.ca",
+      "phone": null,
+      "currency": "USD",
+      "tax_exemptions": [],
+      "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
+      "default_address": {
+        "id": null,
+        "customer_id": 706405506930370000,
+        "first_name": "John",
+        "last_name": "Smith",
+        "company": null,
+        "address1": "123 Elm St.",
+        "address2": null,
+        "city": "Ottawa",
+        "province": "Ontario",
+        "country": "Canada",
+        "zip": "K2H7A8",
+        "phone": "123-123-1234",
+        "name": "John Smith",
+        "province_code": "ON",
+        "country_code": "CA",
+        "country_name": "Canada",
+        "default": true
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/finance_app_staff_member/delete.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "financial_kyc_information"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a staff with access to all or some finance app has been removed.",
+  "name": "finance_app_staff_member/delete",
+  "related_resource": "User",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/finance_app_staff_member/grant.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "financial_kyc_information"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a staff is granted access to all or some finance app.",
+  "name": "finance_app_staff_member/grant",
+  "related_resource": "User",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/finance_app_staff_member/revoke.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "financial_kyc_information"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a staff's access to all or some finance app has been revoked.",
+  "name": "finance_app_staff_member/revoke",
+  "related_resource": "User",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/finance_app_staff_member/update.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "financial_kyc_information"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a staff's information has been updated.",
+  "name": "finance_app_staff_member/update",
+  "related_resource": "User",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/finance_kyc_information/update.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "financial_kyc_information"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever shop's finance KYC information was updated",
+  "name": "finance_kyc_information/update",
+  "related_resource": "FinanceKycInformation",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2026-01/fulfillment_events/create.json

@@ -0,0 +1,38 @@
+{
+  "access_scopes": [
+    "fulfillments"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a fulfillment event is created.",
+  "name": "fulfillment_events/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "FulfillmentEvent",
+  "response": {
+    "id": 1234567,
+    "fulfillment_id": 123456,
+    "status": "in_transit",
+    "message": "Item is now in transit",
+    "happened_at": "2021-12-31T19:00:00-05:00",
+    "city": null,
+    "province": null,
+    "country": "CA",
+    "zip": null,
+    "address1": null,
+    "latitude": null,
+    "longitude": null,
+    "shop_id": 548380009,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "estimated_delivery_at": null,
+    "order_id": 820982911946154500,
+    "admin_graphql_api_id": "gid://shopify/FulfillmentEvent/1234567"
+  },
+  "shop_feature": false
+}

package/metadatas/2026-01/fulfillment_events/delete.json

@@ -0,0 +1,35 @@
+{
+  "access_scopes": [
+    "fulfillments"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a fulfillment event is deleted.",
+  "name": "fulfillment_events/delete",
+  "related_resource": "FulfillmentEvent",
+  "response": {
+    "id": 1234567,
+    "fulfillment_id": 123456,
+    "status": "in_transit",
+    "message": "Item is now in transit",
+    "happened_at": "2021-12-31T19:00:00-05:00",
+    "city": null,
+    "province": null,
+    "country": "CA",
+    "zip": null,
+    "address1": null,
+    "latitude": null,
+    "longitude": null,
+    "shop_id": 548380009,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "estimated_delivery_at": null,
+    "order_id": 820982911946154500,
+    "admin_graphql_api_id": "gid://shopify/FulfillmentEvent/1234567"
+  },
+  "shop_feature": false
+}