shopify-webhook-schemas 0.1.6 → 0.1.7

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

@@ -0,0 +1,31 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory item is created.",
+  "name": "inventory_items/create",
+  "related_resource": "InventoryItem",
+  "response": {
+    "id": 271878346596884000,
+    "sku": "example-sku",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "requires_shipping": true,
+    "cost": null,
+    "country_code_of_origin": null,
+    "province_code_of_origin": null,
+    "harmonized_system_code": null,
+    "tracked": true,
+    "country_harmonized_system_codes": [],
+    "weight_value": 0,
+    "weight_unit": "lb",
+    "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,23 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory item is deleted.",
+  "name": "inventory_items/delete",
+  "related_resource": "InventoryItem",
+  "response": {
+    "id": 271878346596884000,
+    "country_code_of_origin": null,
+    "province_code_of_origin": null,
+    "harmonized_system_code": null,
+    "country_harmonized_system_codes": [],
+    "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,31 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory item is updated.",
+  "name": "inventory_items/update",
+  "related_resource": "InventoryItem",
+  "response": {
+    "id": 271878346596884000,
+    "sku": "example-sku",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "requires_shipping": true,
+    "cost": null,
+    "country_code_of_origin": null,
+    "province_code_of_origin": null,
+    "harmonized_system_code": null,
+    "tracked": true,
+    "country_harmonized_system_codes": [],
+    "weight_value": 0,
+    "weight_unit": "lb",
+    "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/inventory_levels/connect.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory level is connected.",
+  "name": "inventory_levels/connect",
+  "related_resource": "InventoryLevel",
+  "response": {
+    "inventory_item_id": 271878346596884000,
+    "location_id": 24826418,
+    "available": null,
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "admin_graphql_api_id": "gid://shopify/InventoryLevel/24826418?inventory_item_id=271878346596884015"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/inventory_levels/disconnect.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory level is disconnected.",
+  "name": "inventory_levels/disconnect",
+  "related_resource": "InventoryLevel",
+  "response": {
+    "inventory_item_id": 271878346596884000,
+    "location_id": 24826418
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory level is updated.",
+  "name": "inventory_levels/update",
+  "related_resource": "InventoryLevel",
+  "response": {
+    "inventory_item_id": 271878346596884000,
+    "location_id": 24826418,
+    "available": null,
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "admin_graphql_api_id": "gid://shopify/InventoryLevel/24826418?inventory_item_id=271878346596884015"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "locales"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a shop locale is created",
+  "name": "locales/create",
+  "related_resource": "ShopLocale",
+  "response": {
+    "locale": "fr-CA",
+    "published": true
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "locales"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a shop locale is updated, such as published or unpublished",
+  "name": "locales/update",
+  "related_resource": "ShopLocale",
+  "response": {
+    "locale": "fr-CA",
+    "published": true
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/locations/activate.json

@@ -0,0 +1,34 @@
+{
+  "access_scopes": [
+    "locations"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a deactivated location is re-activated.",
+  "name": "locations/activate",
+  "related_resource": "Location",
+  "response": {
+    "id": 866550311766439000,
+    "name": "Example Shop",
+    "address1": "34 Example Street",
+    "address2": "Next to example",
+    "city": "ottawa",
+    "zip": "k1n5t5",
+    "province": "ontario",
+    "country": "CA",
+    "phone": "555-555-5555",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "country_code": "CA",
+    "country_name": "Canada",
+    "province_code": "ON",
+    "legacy": false,
+    "active": true,
+    "admin_graphql_api_id": "gid://shopify/Location/866550311766439020"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,34 @@
+{
+  "access_scopes": [
+    "locations"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a location is created.",
+  "name": "locations/create",
+  "related_resource": "Location",
+  "response": {
+    "id": 866550311766439000,
+    "name": "Example Shop",
+    "address1": "34 Example Street",
+    "address2": "Next to example",
+    "city": "ottawa",
+    "zip": "k1n5t5",
+    "province": "ontario",
+    "country": "CA",
+    "phone": "555-555-5555",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "country_code": "CA",
+    "country_name": "Canada",
+    "province_code": "ON",
+    "legacy": false,
+    "active": true,
+    "admin_graphql_api_id": "gid://shopify/Location/866550311766439020"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/locations/deactivate.json

@@ -0,0 +1,34 @@
+{
+  "access_scopes": [
+    "locations"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a location is deactivated.",
+  "name": "locations/deactivate",
+  "related_resource": "Location",
+  "response": {
+    "id": 866550311766439000,
+    "name": "Example Shop",
+    "address1": "34 Example Street",
+    "address2": "Next to example",
+    "city": "ottawa",
+    "zip": "k1n5t5",
+    "province": "ontario",
+    "country": "CA",
+    "phone": "555-555-5555",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "country_code": "CA",
+    "country_name": "Canada",
+    "province_code": "ON",
+    "legacy": false,
+    "active": true,
+    "admin_graphql_api_id": "gid://shopify/Location/866550311766439020"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "locations"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a location is deleted.",
+  "name": "locations/delete",
+  "related_resource": "Location",
+  "response": {
+    "id": 866550311766439000
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,34 @@
+{
+  "access_scopes": [
+    "locations"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a location is updated.",
+  "name": "locations/update",
+  "related_resource": "Location",
+  "response": {
+    "id": 866550311766439000,
+    "name": "Example Shop",
+    "address1": "34 Example Street",
+    "address2": "Next to example",
+    "city": "ottawa",
+    "zip": "k1n5t5",
+    "province": "ontario",
+    "country": "CA",
+    "phone": "555-555-5555",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "country_code": "CA",
+    "country_name": "Canada",
+    "province_code": "ON",
+    "legacy": false,
+    "active": true,
+    "admin_graphql_api_id": "gid://shopify/Location/866550311766439020"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "markets"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a new market is created.",
+  "name": "markets/create",
+  "related_resource": "Market",
+  "response": {
+    "id": 188558248,
+    "name": "United States",
+    "type": "region",
+    "status": "active"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "markets"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a market is deleted.",
+  "name": "markets/delete",
+  "related_resource": "Market",
+  "response": {
+    "id": 188558248
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "markets"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a market is updated.",
+  "name": "markets/update",
+  "related_resource": "Market",
+  "response": {
+    "id": 188558248,
+    "name": "United States",
+    "type": "region",
+    "status": "active"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "content"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a metafield definition is created.",
+  "name": "metafield_definitions/create",
+  "related_resource": "MetafieldDefinition",
+  "response": {
+    "id": null,
+    "shop_id": 548380009,
+    "namespace": "example-type",
+    "key": "example-key",
+    "name": "Example Field",
+    "description": null,
+    "owner_type": "Customer",
+    "deleting": false,
+    "type_name": "single_line_text_field",
+    "options": [],
+    "api_client_id": null,
+    "created_at": null,
+    "updated_at": null,
+    "validation_status": "all_valid",
+    "pinned_position": 0,
+    "standard_template_id": null,
+    "use_as_collection_condition": false,
+    "access": "unrestricted",
+    "admin_filter_status": "not_filterable",
+    "app_config_managed": false
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "content"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a metafield definition is deleted.",
+  "name": "metafield_definitions/delete",
+  "related_resource": "MetafieldDefinition",
+  "response": {
+    "id": "gid://shopify/MetafieldDefinition/1",
+    "type": "ShopifyMetafields::Types::SingleLineTextFieldType",
+    "created_by_app_id": null
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "content"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a metafield definition is updated.",
+  "name": "metafield_definitions/update",
+  "related_resource": "MetafieldDefinition",
+  "response": {
+    "id": null,
+    "shop_id": 548380009,
+    "namespace": "example-type",
+    "key": "example-key",
+    "name": "Example Field",
+    "description": null,
+    "owner_type": "Customer",
+    "deleting": false,
+    "type_name": "single_line_text_field",
+    "options": [],
+    "api_client_id": null,
+    "created_at": null,
+    "updated_at": null,
+    "validation_status": "all_valid",
+    "pinned_position": 0,
+    "standard_template_id": null,
+    "use_as_collection_condition": false,
+    "access": "unrestricted",
+    "admin_filter_status": "not_filterable",
+    "app_config_managed": false
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,33 @@
+{
+  "access_scopes": [
+    "metaobjects"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a metaobject is created.",
+  "name": "metaobjects/create",
+  "related_resource": "Metaobject",
+  "response": {
+    "type": "example-type",
+    "handle": "example-metaobject",
+    "created_at": "1975-10-31T00:55:12-05:00",
+    "updated_at": "1985-07-13T01:55:12-04:00",
+    "display_name": "Example Metaobject",
+    "id": "gid://shopify/Metaobject/123",
+    "definition_id": "gid://shopify/MetaobjectDefinition/222",
+    "fields": {
+      "example-key": "example-value"
+    },
+    "created_by_staff_id": "gid://shopify/StaffMember/444",
+    "created_by_app_id": "gid://shopify/ApiClient/333",
+    "capabilities": {
+      "publishable": {
+        "status": "draft"
+      }
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "metaobjects"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a metaobject is deleted.",
+  "name": "metaobjects/delete",
+  "related_resource": "Metaobject",
+  "response": {
+    "id": "gid://shopify/Metaobject/123",
+    "type": "example-type",
+    "handle": "example-metaobject",
+    "created_by_app_id": "gid://shopify/ApiClient/333"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,33 @@
+{
+  "access_scopes": [
+    "metaobjects"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a metaobject is updated.",
+  "name": "metaobjects/update",
+  "related_resource": "Metaobject",
+  "response": {
+    "type": "example-type",
+    "handle": "example-metaobject",
+    "created_at": "1975-10-31T00:55:12-05:00",
+    "updated_at": "1985-07-13T01:55:12-04:00",
+    "display_name": "Example Metaobject",
+    "id": "gid://shopify/Metaobject/123",
+    "definition_id": "gid://shopify/MetaobjectDefinition/222",
+    "fields": {
+      "example-key": "example-value"
+    },
+    "created_by_staff_id": "gid://shopify/StaffMember/444",
+    "created_by_app_id": "gid://shopify/ApiClient/333",
+    "capabilities": {
+      "publishable": {
+        "status": "draft"
+      }
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,68 @@
+{
+  "access_scopes": [
+    "orders",
+    "marketplace_orders",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a order transaction is created or when it's status is updated. Only occurs for transactions with a status of success, failure or error.",
+  "name": "order_transactions/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "OrderTransaction",
+  "response": {
+    "id": 120560818172775260,
+    "order_id": 820982911946154500,
+    "kind": "authorization",
+    "gateway": "visa",
+    "status": "success",
+    "message": null,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "test": false,
+    "authorization": "1001",
+    "location_id": null,
+    "user_id": null,
+    "parent_id": null,
+    "processed_at": null,
+    "device_id": null,
+    "error_code": null,
+    "source_name": "web",
+    "payment_details": {
+      "credit_card_bin": null,
+      "avs_result_code": null,
+      "cvv_result_code": null,
+      "credit_card_number": "•••• •••• •••• 1234",
+      "credit_card_company": "Visa",
+      "buyer_action_info": null,
+      "credit_card_name": null,
+      "credit_card_wallet": null,
+      "credit_card_expiration_month": null,
+      "credit_card_expiration_year": null,
+      "payment_method_name": "visa"
+    },
+    "receipt": {},
+    "amount": "403.00",
+    "currency": "USD",
+    "payment_id": "#9999.1",
+    "total_unsettled_set": {
+      "presentment_money": {
+        "amount": "403.0",
+        "currency": "USD"
+      },
+      "shop_money": {
+        "amount": "403.0",
+        "currency": "USD"
+      }
+    },
+    "manual_payment_gateway": true,
+    "amount_rounding": null,
+    "admin_graphql_api_id": "gid://shopify/OrderTransaction/120560818172775265"
+  },
+  "shop_feature": false
+}