shopify-webhook-schemas 0.1.6 → 0.1.8

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

@@ -0,0 +1,258 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a checkout is updated.",
+  "name": "checkouts/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Checkout",
+  "response": {
+    "id": 981820079255243500,
+    "token": "123123123",
+    "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
+    "email": "example@email.com",
+    "gateway": null,
+    "buyer_accepts_marketing": false,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "landing_site": null,
+    "note": null,
+    "note_attributes": [],
+    "referring_site": null,
+    "shipping_lines": [],
+    "taxes_included": false,
+    "total_weight": 1133,
+    "currency": "USD",
+    "completed_at": null,
+    "closed_at": null,
+    "user_id": null,
+    "location_id": null,
+    "source_identifier": null,
+    "source_url": null,
+    "device_id": null,
+    "phone": null,
+    "customer_locale": null,
+    "line_items": [
+      {
+        "applied_discounts": [],
+        "discount_allocations": [],
+        "key": "36ff9acde1828d8d047dbb5e351f2ec6",
+        "destination_location_id": 1015975122,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 567,
+        "origin_location_id": 1015975121,
+        "presentment_title": "IPod Nano - 8GB",
+        "presentment_variant_title": "Pink",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+          {
+            "price": "11.94",
+            "position": 1,
+            "rate": 0.06,
+            "title": "Tax",
+            "source": "Shopify",
+            "zone": "province",
+            "jurisdiction_id": null,
+            "jurisdiction_type": null,
+            "jurisdiction_source": null,
+            "reporting_taxable_amount": null,
+            "reporting_non_taxable_amount": null,
+            "reporting_exempt_amount": null,
+            "reporting_jurisdiction_name": null,
+            "reporting_jurisdiction_type": null,
+            "reporting_jurisdiction_code": null,
+            "tax_api_client_id": null,
+            "tax_calculation_price": "11.94",
+            "tax_registration_id": null,
+            "compare_at": 0.06,
+            "channel_liable": false
+          }
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "variant_price": "199.00",
+        "vendor": "Apple",
+        "user_id": null,
+        "unit_price_measurement": {
+          "measured_type": null,
+          "quantity_value": null,
+          "quantity_unit": null,
+          "reference_value": null,
+          "reference_unit": null
+        },
+        "rank": null,
+        "compare_at_price": null,
+        "line_price": "199.00",
+        "price": "199.00"
+      },
+      {
+        "applied_discounts": [],
+        "discount_allocations": [],
+        "key": "36ff9acde1828d8d047dbb5e351f2ec6",
+        "destination_location_id": 1015975122,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 567,
+        "origin_location_id": 1015975121,
+        "presentment_title": "IPod Nano - 8GB",
+        "presentment_variant_title": "Pink",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+          {
+            "price": "11.94",
+            "position": 1,
+            "rate": 0.06,
+            "title": "Tax",
+            "source": "Shopify",
+            "zone": "province",
+            "jurisdiction_id": null,
+            "jurisdiction_type": null,
+            "jurisdiction_source": null,
+            "reporting_taxable_amount": null,
+            "reporting_non_taxable_amount": null,
+            "reporting_exempt_amount": null,
+            "reporting_jurisdiction_name": null,
+            "reporting_jurisdiction_type": null,
+            "reporting_jurisdiction_code": null,
+            "tax_api_client_id": null,
+            "tax_calculation_price": "11.94",
+            "tax_registration_id": null,
+            "compare_at": 0.06,
+            "channel_liable": false
+          }
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "variant_price": "199.00",
+        "vendor": "Apple",
+        "user_id": null,
+        "unit_price_measurement": {
+          "measured_type": null,
+          "quantity_value": null,
+          "quantity_unit": null,
+          "reference_value": null,
+          "reference_unit": null
+        },
+        "rank": null,
+        "compare_at_price": null,
+        "line_price": "199.00",
+        "price": "199.00"
+      }
+    ],
+    "name": "#981820079255243537",
+    "source": null,
+    "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/123123123/recover?key=example-secret-token",
+    "discount_codes": [],
+    "tax_lines": [
+      {
+        "price": "23.88",
+        "rate": 0.06,
+        "title": "Tax",
+        "channel_liable": false
+      }
+    ],
+    "source_name": "web",
+    "presentment_currency": "USD",
+    "buyer_accepts_sms_marketing": false,
+    "sms_marketing_phone": null,
+    "total_discounts": "0.00",
+    "total_line_items_price": "398.00",
+    "total_price": "421.88",
+    "total_tax": "23.88",
+    "subtotal_price": "398.00",
+    "total_duties": null,
+    "reservation_token": null,
+    "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"
+    },
+    "shipping_address": {
+      "first_name": "Steve",
+      "address1": "123 Shipping Street",
+      "phone": "555-555-SHIP",
+      "city": "Shippington",
+      "zip": "K2P0S0",
+      "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"
+    },
+    "customer": {
+      "id": 603851970716743400,
+      "email": "john@example.com",
+      "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,
+      "currency": "USD",
+      "phone": null,
+      "tax_exemptions": [],
+      "admin_graphql_api_id": "gid://shopify/Customer/603851970716743426",
+      "default_address": {
+        "id": null,
+        "customer_id": 603851970716743400,
+        "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
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/collection_listings/add.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection listing is added.",
+  "name": "collection_listings/add",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "collection_listing": {
+      "collection_id": 408372092144951400,
+      "updated_at": null,
+      "body_html": "<b>Some HTML</b>",
+      "default_product_image": null,
+      "handle": "mynewcollection",
+      "image": null,
+      "title": "My New Collection",
+      "sort_order": null,
+      "published_at": "2021-12-31T19:00:00-05:00"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/collection_listings/remove.json

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection listing is removed.",
+  "name": "collection_listings/remove",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "collection_listing": {
+      "collection_id": 408372092144951400
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection listing is updated.",
+  "name": "collection_listings/update",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "collection_listing": {
+      "collection_id": 408372092144951400,
+      "updated_at": null,
+      "body_html": "<b>Some HTML</b>",
+      "default_product_image": null,
+      "handle": "mynewcollection",
+      "image": null,
+      "title": "My New Collection",
+      "sort_order": null,
+      "published_at": "2021-12-31T19:00:00-05:00"
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection publication listing is created.",
+  "name": "collection_publications/create",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "id": null,
+    "publication_id": null,
+    "published_at": "2021-12-31T19:00:00-05:00",
+    "published": true,
+    "created_at": null,
+    "updated_at": null,
+    "collection_id": 408372092144951400
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection publication listing is deleted.",
+  "name": "collection_publications/delete",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "id": null
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection publication listing is updated.",
+  "name": "collection_publications/update",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "id": null,
+    "publication_id": null,
+    "published_at": "2021-12-31T19:00:00-05:00",
+    "published": true,
+    "created_at": null,
+    "updated_at": null,
+    "collection_id": 408372092144951400
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,27 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection is created.",
+  "name": "collections/create",
+  "related_resource": "Collection",
+  "response": {
+    "id": 408372092144951400,
+    "handle": "mynewcollection",
+    "title": "My New Collection",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "body_html": "<b>Some HTML</b>",
+    "published_at": "2021-12-31T16:00:00-05:00",
+    "sort_order": null,
+    "template_suffix": null,
+    "published_scope": "web",
+    "admin_graphql_api_id": "gid://shopify/Collection/408372092144951419"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection is deleted.",
+  "name": "collections/delete",
+  "related_resource": "Collection",
+  "response": {
+    "id": 408372092144951400,
+    "published_scope": "web",
+    "admin_graphql_api_id": "gid://shopify/Collection/408372092144951419"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,27 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a collection is updated, including whenever products are added or removed from the collection. Occurs once if multiple products are added or removed from a collection at the same time.",
+  "name": "collections/update",
+  "related_resource": "Collection",
+  "response": {
+    "id": 408372092144951400,
+    "handle": "mynewcollection",
+    "title": "My New Collection",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "body_html": "<b>Some HTML</b>",
+    "published_at": "2021-12-31T16:00:00-05:00",
+    "sort_order": null,
+    "template_suffix": null,
+    "published_scope": "web",
+    "admin_graphql_api_id": "gid://shopify/Collection/408372092144951419"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company is created.",
+  "name": "companies/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Company",
+  "response": {
+    "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"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company is deleted.",
+  "name": "companies/delete",
+  "related_resource": "Company",
+  "response": {
+    "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"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company is updated.",
+  "name": "companies/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Company",
+  "response": {
+    "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"
+  },
+  "shop_feature": false
+}