shopify-webhook-schemas 0.2.7 → 0.2.8

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

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a shipment is deleted.",
+  "name": "inventory_shipments/delete",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/mark_in_transit.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a shipment is marked as in transit.",
+  "name": "inventory_shipments/mark_in_transit",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "status": "IN_TRANSIT",
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/receive_items.json

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "inventory_shipments_received_items"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when items on a shipment are received.",
+  "name": "inventory_shipments/receive_items",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "status": "PARTIALLY_RECEIVED",
+    "items_received": [
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/82243",
+        "old_accepted_quantity": 5,
+        "old_rejected_quantity": 2,
+        "new_accepted_quantity": 11,
+        "new_rejected_quantity": 3,
+        "remaining_quantity_to_receive": 6
+      },
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/57116",
+        "old_accepted_quantity": 21,
+        "old_rejected_quantity": 9,
+        "new_accepted_quantity": 37,
+        "new_rejected_quantity": 14,
+        "remaining_quantity_to_receive": 16
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/remove_items.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever items are removed from a shipment.",
+  "name": "inventory_shipments/remove_items",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "items_removed": [
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/82243"
+      },
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/57116"
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/update_item_quantities.json

@@ -0,0 +1,30 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever quantities change on a shipment.",
+  "name": "inventory_shipments/update_item_quantities",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "items_updated": [
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/82243",
+        "old_quantity": 10,
+        "new_quantity": 23
+      },
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/57116",
+        "old_quantity": 7,
+        "new_quantity": 42
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/update_tracking.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when tracking info on a shipment is updated.",
+  "name": "inventory_shipments/update_tracking",
+  "related_resource": "Shipment",
+  "response": {
+    "shipment_id": "gid://shopify/InventoryShipment/3921201",
+    "updated_tracking": {
+      "tracking_number": "8375692728",
+      "tracking_url": "https://exampletracking.shopify.com/track/8375692728",
+      "company": "Purolator",
+      "arrives_at": "2023-10-02T03:24:44-04:00"
+    },
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_transfers/add_items.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "inventory_transfers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs any time items are added to a transfer.",
+  "name": "inventory_transfers/add_items",
+  "related_resource": "Transfer",
+  "response": {
+    "id": "gid://shopify/InventoryTransfer/2921201",
+    "items_added": [
+      {
+        "line_item_id": "gid://shopify/InventoryTransferLineItem/72243",
+        "quantity": 14
+      },
+      {
+        "line_item_id": "gid://shopify/InventoryTransferLineItem/81958",
+        "quantity": 22
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_transfers/cancel.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "inventory_transfers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a transfer is canceled.",
+  "name": "inventory_transfers/cancel",
+  "related_resource": "Transfer",
+  "response": {
+    "id": "gid://shopify/InventoryTransfer/2921201",
+    "status": "CANCELED",
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_transfers/complete.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "inventory_transfers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a transfer is completed.",
+  "name": "inventory_transfers/complete",
+  "related_resource": "Transfer",
+  "response": {
+    "id": "gid://shopify/InventoryTransfer/2921201",
+    "status": "TRANSFERRED",
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_transfers/ready_to_ship.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "inventory_transfers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a transfer is marked as ready to ship.",
+  "name": "inventory_transfers/ready_to_ship",
+  "related_resource": "Transfer",
+  "response": {
+    "id": "gid://shopify/InventoryTransfer/2921201",
+    "status": "READY_TO_SHIP",
+    "happened_at": "2023-09-01T08:19:56-04:00",
+    "line_items": [
+      {
+        "id": "gid://shopify/InventoryTransferLineItem/72243",
+        "quantity": 10
+      },
+      {
+        "id": "gid://shopify/InventoryTransferLineItem/81958",
+        "quantity": 8
+      }
+    ]
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_transfers/remove_items.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "inventory_transfers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs any time items are removed from a transfer.",
+  "name": "inventory_transfers/remove_items",
+  "related_resource": "Transfer",
+  "response": {
+    "id": "gid://shopify/InventoryTransfer/2921201",
+    "items_removed": [
+      {
+        "line_item_id": "gid://shopify/InventoryTransferLineItem/72243"
+      },
+      {
+        "line_item_id": "gid://shopify/InventoryTransferLineItem/81958"
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_transfers/update_item_quantities.json

@@ -0,0 +1,31 @@
+{
+  "access_scopes": [
+    "inventory_transfers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever the quantity of transfer line items changes.",
+  "name": "inventory_transfers/update_item_quantities",
+  "related_resource": "Transfer",
+  "response": {
+    "id": "gid://shopify/InventoryTransfer/2921201",
+    "status": "IN_PROGRESS",
+    "items_updated": [
+      {
+        "line_item_id": "gid://shopify/InventoryTransferLineItem/72243",
+        "old_quantity": 10,
+        "new_quantity": 23
+      },
+      {
+        "line_item_id": "gid://shopify/InventoryTransferLineItem/81958",
+        "old_quantity": 8,
+        "new_quantity": 15
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/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-10/locales/destroy.json

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

package/metadatas/2025-10/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-10/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-10/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-10/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-10/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-10/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-10/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-10/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-10/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-10/markets_backup_region/update.json

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "markets"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a backup region is updated.",
+  "name": "markets_backup_region/update",
+  "related_resource": "Region",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/MarketRegion/238945671234567891",
+    "code": "US"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,45 @@
+{
+  "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,
+    "merchant_writeable": null,
+    "storefront_readable": null,
+    "customer_access": null,
+    "namespace_owner_api_client_id": null,
+    "unique_values": false,
+    "smart_collection_condition": false,
+    "option_linkable": false,
+    "admin_filterable": false,
+    "admin_filterable_status": null,
+    "app_config_managed": false,
+    "access_only": false,
+    "admin_filter_status": "not_filterable",
+    "use_as_collection_condition": false
+  },
+  "shop_feature": false
+}