shopify-webhook-schemas 0.2.7 → 0.2.9

package/metadatas/2025-10/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-10/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-10/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-10/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-10/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-10/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-10/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
+}

package/metadatas/2025-10/company_contact_roles/assign.json

@@ -0,0 +1,114 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a role is assigned to a contact at a location.",
+  "name": "company_contact_roles/assign",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CompanyContactRoleAssignment",
+  "response": {
+    "company_contact": {
+      "customer_admin_graphql_api_id": "gid://shopify/Customer/12123842227812391",
+      "title": "Buyer",
+      "locale": "en",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "admin_graphql_api_id": "gid://shopify/CompanyContact/408372092144951419",
+      "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"
+      }
+    },
+    "company_location": {
+      "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"
+      ],
+      "tax_settings": {
+        "tax_registration_id": "1214214141",
+        "tax_exempt": null,
+        "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",
+        "first_name": null,
+        "last_name": null,
+        "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",
+        "first_name": null,
+        "last_name": null,
+        "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"
+      }
+    },
+    "company_contact_role": {
+      "name": "Location Admin"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/company_contact_roles/revoke.json

@@ -0,0 +1,114 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a role is revoked from a contact at a location.",
+  "name": "company_contact_roles/revoke",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CompanyContactRoleAssignment",
+  "response": {
+    "company_contact": {
+      "customer_admin_graphql_api_id": "gid://shopify/Customer/12123842227812391",
+      "title": "Buyer",
+      "locale": "en",
+      "created_at": "2021-12-31T19:00:00-05:00",
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "admin_graphql_api_id": "gid://shopify/CompanyContact/408372092144951419",
+      "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"
+      }
+    },
+    "company_location": {
+      "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"
+      ],
+      "tax_settings": {
+        "tax_registration_id": "1214214141",
+        "tax_exempt": null,
+        "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",
+        "first_name": null,
+        "last_name": null,
+        "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",
+        "first_name": null,
+        "last_name": null,
+        "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"
+      }
+    },
+    "company_contact_role": {
+      "name": "Location Admin"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/company_contacts/create.json

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company contact is created.",
+  "name": "company_contacts/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CompanyContact",
+  "response": {
+    "customer_admin_graphql_api_id": "gid://shopify/Customer/12123842227812391",
+    "title": "Buyer",
+    "locale": "en",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "admin_graphql_api_id": "gid://shopify/CompanyContact/408372092144951419",
+    "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"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/company_contacts/delete.json

@@ -0,0 +1,34 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company contact is deleted.",
+  "name": "company_contacts/delete",
+  "related_resource": "CompanyContact",
+  "response": {
+    "customer_admin_graphql_api_id": "gid://shopify/Customer/12123842227812391",
+    "title": "Buyer",
+    "locale": "en",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "admin_graphql_api_id": "gid://shopify/CompanyContact/408372092144951419",
+    "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"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/company_contacts/update.json

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company contact is updated.",
+  "name": "company_contacts/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "CompanyContact",
+  "response": {
+    "customer_admin_graphql_api_id": "gid://shopify/Customer/12123842227812391",
+    "title": "Buyer",
+    "locale": "en",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "admin_graphql_api_id": "gid://shopify/CompanyContact/408372092144951419",
+    "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"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/company_locations/create.json

@@ -0,0 +1,91 @@
+{
+  "access_scopes": [
+    "customers",
+    "companies"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a company location is created.",
+  "name": "company_locations/create",
+  "pii": [
+    "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"
+    ],
+    "tax_settings": {
+      "tax_registration_id": "1214214141",
+      "tax_exempt": null,
+      "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",
+      "first_name": null,
+      "last_name": null,
+      "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",
+      "first_name": null,
+      "last_name": null,
+      "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"
+    }
+  },
+  "shop_feature": false
+}