shopify-webhook-schemas 0.1.3 → 0.1.5

package/metadatas/2024-04/themes/delete.json

@@ -4,12 +4,15 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a theme is deleted. Does not occur when theme files are deleted.",
   "name": "themes/delete",
   "related_resource": "Theme",
   "response": {
     "id": 512162865275216960
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-04/themes/publish.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a theme with the main or mobile (deprecated) role is published.",
   "name": "themes/publish",
   "related_resource": "Theme",
@@ -19,5 +21,6 @@
     "previewable": true,
     "processing": false,
     "admin_graphql_api_id": "gid://shopify/Theme/512162865275216980"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-04/themes/update.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a theme is updated. Does not occur when theme files are updated.",
   "name": "themes/update",
   "related_resource": "Theme",
@@ -19,5 +21,6 @@
     "previewable": true,
     "processing": false,
     "admin_graphql_api_id": "gid://shopify/Theme/512162865275216980"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-04/variants/in_stock.json

@@ -0,0 +1,45 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a variant becomes in stock.",
+  "name": "variants/in_stock",
+  "related_resource": "ProductVariant",
+  "response": {
+    "id": 642667041472714000,
+    "product_id": 788032119674292900,
+    "title": "Small",
+    "price": "19.99",
+    "position": 1,
+    "inventory_policy": "deny",
+    "compare_at_price": "24.99",
+    "option1": "Small",
+    "option2": null,
+    "option3": null,
+    "created_at": "2021-12-29T19:00:00-05:00",
+    "updated_at": "2021-12-30T19:00:00-05:00",
+    "taxable": true,
+    "barcode": null,
+    "fulfillment_service": "manual",
+    "grams": 0,
+    "inventory_management": null,
+    "requires_shipping": true,
+    "sku": null,
+    "weight": 0,
+    "weight_unit": "lb",
+    "inventory_quantity": 75,
+    "old_inventory_quantity": 75,
+    "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
+    "image_id": null
+  },
+  "shop_feature": false,
+  "shopify_approval_scope": [
+    "write_publications"
+  ]
+}

package/metadatas/2024-04/variants/out_of_stock.json

@@ -0,0 +1,45 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a variant becomes out of stock.",
+  "name": "variants/out_of_stock",
+  "related_resource": "ProductVariant",
+  "response": {
+    "id": 642667041472714000,
+    "product_id": 788032119674292900,
+    "title": "Small",
+    "price": "19.99",
+    "position": 1,
+    "inventory_policy": "deny",
+    "compare_at_price": "24.99",
+    "option1": "Small",
+    "option2": null,
+    "option3": null,
+    "created_at": "2021-12-29T19:00:00-05:00",
+    "updated_at": "2021-12-30T19:00:00-05:00",
+    "taxable": true,
+    "barcode": null,
+    "fulfillment_service": "manual",
+    "grams": 0,
+    "inventory_management": null,
+    "requires_shipping": true,
+    "sku": null,
+    "weight": 0,
+    "weight_unit": "lb",
+    "inventory_quantity": 0,
+    "old_inventory_quantity": 0,
+    "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
+    "image_id": null
+  },
+  "shop_feature": false,
+  "shopify_approval_scope": [
+    "write_publications"
+  ]
+}

package/metadatas/2024-07/app/uninstalled.json

@@ -1,13 +1,12 @@
 {
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a shop has uninstalled the app.",
   "name": "app/uninstalled",
-  "pii": [
-    "merchant"
-  ],
   "related_resource": "Shop",
   "response": {
     "id": 548380009,
@@ -64,7 +63,8 @@
     "enabled_presentment_currencies": [
       "USD"
     ],
-    "transactional_sms_disabled": false,
-    "marketing_sms_consent_enabled_at_checkout": false
-  }
+    "marketing_sms_consent_enabled_at_checkout": false,
+    "transactional_sms_disabled": false
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/app_purchases_one_time/update.json

@@ -1,18 +1,21 @@
 {
   "available_on": [
-    "graphql"
+    "graphql",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a one-time app charge is updated.",
   "name": "app_purchases_one_time/update",
   "related_resource": "ApplicationCharge",
   "response": {
     "app_purchase_one_time": {
-      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262358",
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262352",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
       "created_at": "2021-12-31T19:00:00-05:00",
       "updated_at": "2021-12-31T19:00:00-05:00"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/app_subscriptions/approaching_capped_amount.json

@@ -1,13 +1,15 @@
 {
   "available_on": [
-    "graphql"
+    "graphql",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs when the balance used on an app subscription crosses 90% of the capped amount.",
   "name": "app_subscriptions/approaching_capped_amount",
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266970",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266954",
       "name": "Webhook Test",
       "balance_used": 0,
       "capped_amount": "20.0",
@@ -16,5 +18,6 @@
       "created_at": "2021-12-31T19:00:00-05:00",
       "updated_at": "2021-12-31T19:00:00-05:00"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/app_subscriptions/update.json

@@ -1,14 +1,16 @@
 {
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever an app subscription is updated.",
   "name": "app_subscriptions/update",
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266963",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266952",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
@@ -17,5 +19,6 @@
       "currency": "USD",
       "capped_amount": "20.0"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/audit_events/admin_api_activity.json

@@ -0,0 +1,67 @@
+{
+  "access_scopes": [
+    "audit_events"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers for each auditable Admin API request. This topic is limited to one active subscription per Plus store and requires the use of Google Cloud Pub/Sub or AWS EventBridge.",
+  "name": "audit_events/admin_api_activity",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "AuditEvent",
+  "response": {
+    "events": [
+      {
+        "time": 1634678724,
+        "event": {
+          "context": {
+            "context_type": "network_request",
+            "context_identifier": "13493be9-24f2-4eea-b71d-a8acd7af7917",
+            "context_metadata": {
+              "client_ip": "192.168.64.1",
+              "content_type": "json",
+              "response_time_ms": 116.47000000812113,
+              "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36",
+              "api_request_failed": false,
+              "response_code": 200
+            }
+          },
+          "action": "api_request",
+          "actor": {
+            "actor_type": "app",
+            "actor_identifier": 4,
+            "actor_metadata": {
+              "app_name": "Private app",
+              "api_version_requested": "unstable",
+              "api_version_served": "unstable",
+              "ecosystem_category": "private"
+            },
+            "on_behalf_of": {
+              "user_email": "dev@example.com"
+            }
+          },
+          "subject": {
+            "subject_type": "shop",
+            "subject_identifier": "shop1.myshopify.io",
+            "subject_metadata": {}
+          },
+          "timestamp": "2021-10-19T21:25:24Z",
+          "additional_metadata": {
+            "request_type": "GraphQL",
+            "mutation_names": [],
+            "query": "query orders {\n  orders(first: $first) {\n    edges {\n      node {\n        id\n      }\n    }\n  }\n}",
+            "variables": {
+              "first": 10
+            },
+            "error_codes": []
+          }
+        }
+      }
+    ]
+  },
+  "shop_feature": true
+}

package/metadatas/2024-07/bulk_operations/finish.json

@@ -1,17 +1,20 @@
 {
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Notifies when a Bulk Operation finishes.",
   "name": "bulk_operations/finish",
   "related_resource": "BulkOperation",
   "response": {
     "admin_graphql_api_id": "gid://shopify/BulkOperation/147595010",
-    "completed_at": "2024-04-19T14:38:41-04:00",
-    "created_at": "2024-04-19T14:38:41-04:00",
+    "completed_at": "2024-10-16T12:53:08-04:00",
+    "created_at": "2024-10-16T12:53:08-04:00",
     "error_code": null,
     "status": "completed",
     "type": "query"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/carts/create.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs when a cart is created in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are created in a custom storefront.",
   "name": "carts/create",
   "pii": [
@@ -33,7 +35,7 @@
         "product_id": 788032119674292900,
         "sku": "example-shirt-s",
         "taxable": true,
-        "title": "Example T-Shirt",
+        "title": "Example T-Shirt - Small",
         "total_discount": "0.00",
         "vendor": "Acme",
         "discounted_price_set": {
@@ -91,5 +93,6 @@
     "note": null,
     "updated_at": "2022-01-01T00:00:00.000Z",
     "created_at": "2022-01-01T00:00:00.000Z"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/carts/update.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs when a cart is updated in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are updated in a custom storefront.",
   "name": "carts/update",
   "pii": [
@@ -33,7 +35,7 @@
         "product_id": 788032119674292900,
         "sku": "example-shirt-s",
         "taxable": true,
-        "title": "Example T-Shirt",
+        "title": "Example T-Shirt - Small",
         "total_discount": "0.00",
         "vendor": "Acme",
         "discounted_price_set": {
@@ -91,5 +93,6 @@
     "note": null,
     "updated_at": "2022-01-01T00:00:00.000Z",
     "created_at": "2022-01-01T00:00:00.000Z"
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/channels/delete.json

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a channel is deleted.",
+  "name": "channels/delete",
+  "related_resource": "Channel",
+  "response": {
+    "id": "123456789"
+  },
+  "shop_feature": false,
+  "shopify_approval_scope": [
+    "write_publications"
+  ]
+}

package/metadatas/2024-07/checkouts/create.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a checkout is created.",
   "name": "checkouts/create",
   "pii": [
@@ -42,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "d19ac4d87b1625894fbcb3b1ea6d22c7",
-        "destination_location_id": 938998241,
+        "key": "04146c0fca55b1ad72ae9ed35248b684",
+        "destination_location_id": 1015975152,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998240,
+        "origin_location_id": 1015975151,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -74,6 +76,7 @@
             "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
           }
@@ -100,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "d19ac4d87b1625894fbcb3b1ea6d22c7",
-        "destination_location_id": 938998241,
+        "key": "04146c0fca55b1ad72ae9ed35248b684",
+        "destination_location_id": 1015975152,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998240,
+        "origin_location_id": 1015975151,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -132,6 +135,7 @@
             "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
           }
@@ -260,5 +264,6 @@
         "default": true
       }
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/checkouts/delete.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a checkout is deleted.",
   "name": "checkouts/delete",
   "related_resource": "Checkout",
@@ -22,5 +24,6 @@
     "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
     "total_duties": null,
     "reservation_token": null
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/checkouts/update.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a checkout is updated.",
   "name": "checkouts/update",
   "pii": [
@@ -42,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "d899d53bd0c8212123df2aa1d0510289",
-        "destination_location_id": 938998211,
+        "key": "fdc2f3d43cec601dbe9d1a7b86152329",
+        "destination_location_id": 1015975130,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998210,
+        "origin_location_id": 1015975129,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -74,6 +76,7 @@
             "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
           }
@@ -100,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "d899d53bd0c8212123df2aa1d0510289",
-        "destination_location_id": 938998211,
+        "key": "fdc2f3d43cec601dbe9d1a7b86152329",
+        "destination_location_id": 1015975130,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 938998210,
+        "origin_location_id": 1015975129,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -132,6 +135,7 @@
             "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
           }
@@ -260,5 +264,6 @@
         "default": true
       }
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/collection_listings/add.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a collection listing is added.",
   "name": "collection_listings/add",
   "related_resource": "CollectionPublication",
@@ -21,5 +23,6 @@
       "sort_order": null,
       "published_at": "2021-12-31T19:00:00-05:00"
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/collection_listings/remove.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a collection listing is removed.",
   "name": "collection_listings/remove",
   "related_resource": "CollectionPublication",
@@ -13,5 +15,6 @@
     "collection_listing": {
       "collection_id": 408372092144951400
     }
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/collection_listings/update.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a collection listing is updated.",
   "name": "collection_listings/update",
   "related_resource": "CollectionPublication",
@@ -21,5 +23,6 @@
       "sort_order": null,
       "published_at": "2021-12-31T19:00:00-05:00"
     }
-  }
+  },
+  "shop_feature": false
 }