shopify-webhook-schemas 0.1.4 → 0.1.6

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

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever an active product is listed on a channel.",
   "name": "product_listings/add",
   "related_resource": "ProductListing",
@@ -19,13 +21,13 @@
       "product_type": "Shirts",
       "title": "Example T-Shirt",
       "vendor": "Acme",
-      "available": false,
+      "available": true,
       "tags": "example, mens, t-shirt",
       "published_at": "2021-12-31T19:00:00-05:00",
       "variants": [
         {
           "id": 642667041472714000,
-          "title": "",
+          "title": "Small",
           "option_values": [
             {
               "option_id": 527050010214937800,
@@ -36,26 +38,26 @@
           "price": "19.99",
           "formatted_price": "$19.99",
           "compare_at_price": "24.99",
-          "grams": 200,
+          "grams": 0,
           "requires_shipping": true,
-          "sku": "example-shirt-s",
+          "sku": null,
           "barcode": null,
           "taxable": true,
           "position": 1,
-          "available": false,
+          "available": true,
           "inventory_policy": "deny",
-          "inventory_quantity": 0,
-          "inventory_management": "shopify",
+          "inventory_quantity": 75,
+          "inventory_management": null,
           "fulfillment_service": "manual",
-          "weight": 200,
-          "weight_unit": "g",
+          "weight": 0,
+          "weight_unit": "lb",
           "image_id": null,
-          "created_at": null,
-          "updated_at": null
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-30T19:00:00-05:00"
         },
         {
           "id": 757650484644203900,
-          "title": "",
+          "title": "Medium",
           "option_values": [
             {
               "option_id": 527050010214937800,
@@ -66,22 +68,22 @@
           "price": "19.99",
           "formatted_price": "$19.99",
           "compare_at_price": "24.99",
-          "grams": 200,
+          "grams": 0,
           "requires_shipping": true,
-          "sku": "example-shirt-m",
+          "sku": null,
           "barcode": null,
           "taxable": true,
           "position": 2,
-          "available": false,
+          "available": true,
           "inventory_policy": "deny",
-          "inventory_quantity": 0,
-          "inventory_management": "shopify",
+          "inventory_quantity": 50,
+          "inventory_management": null,
           "fulfillment_service": "manual",
-          "weight": 200,
-          "weight_unit": "g",
+          "weight": 0,
+          "weight_unit": "lb",
           "image_id": null,
-          "created_at": null,
-          "updated_at": null
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-31T19:00:00-05:00"
         }
       ],
       "images": [],
@@ -98,5 +100,6 @@
         }
       ]
     }
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a product listing is removed from the channel.",
   "name": "product_listings/remove",
   "related_resource": "ProductListing",
@@ -13,5 +15,6 @@
     "product_listing": {
       "product_id": 788032119674292900
     }
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a product publication is updated.",
   "name": "product_listings/update",
   "related_resource": "ProductListing",
@@ -19,13 +21,13 @@
       "product_type": "Shirts",
       "title": "Example T-Shirt",
       "vendor": "Acme",
-      "available": false,
+      "available": true,
       "tags": "example, mens, t-shirt",
       "published_at": "2021-12-31T19:00:00-05:00",
       "variants": [
         {
           "id": 642667041472714000,
-          "title": "",
+          "title": "Small",
           "option_values": [
             {
               "option_id": 527050010214937800,
@@ -36,26 +38,26 @@
           "price": "19.99",
           "formatted_price": "$19.99",
           "compare_at_price": "24.99",
-          "grams": 200,
+          "grams": 0,
           "requires_shipping": true,
-          "sku": "example-shirt-s",
+          "sku": null,
           "barcode": null,
           "taxable": true,
           "position": 1,
-          "available": false,
+          "available": true,
           "inventory_policy": "deny",
-          "inventory_quantity": 0,
-          "inventory_management": "shopify",
+          "inventory_quantity": 75,
+          "inventory_management": null,
           "fulfillment_service": "manual",
-          "weight": 200,
-          "weight_unit": "g",
+          "weight": 0,
+          "weight_unit": "lb",
           "image_id": null,
-          "created_at": null,
-          "updated_at": null
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-30T19:00:00-05:00"
         },
         {
           "id": 757650484644203900,
-          "title": "",
+          "title": "Medium",
           "option_values": [
             {
               "option_id": 527050010214937800,
@@ -66,22 +68,22 @@
           "price": "19.99",
           "formatted_price": "$19.99",
           "compare_at_price": "24.99",
-          "grams": 200,
+          "grams": 0,
           "requires_shipping": true,
-          "sku": "example-shirt-m",
+          "sku": null,
           "barcode": null,
           "taxable": true,
           "position": 2,
-          "available": false,
+          "available": true,
           "inventory_policy": "deny",
-          "inventory_quantity": 0,
-          "inventory_management": "shopify",
+          "inventory_quantity": 50,
+          "inventory_management": null,
           "fulfillment_service": "manual",
-          "weight": 200,
-          "weight_unit": "g",
+          "weight": 0,
+          "weight_unit": "lb",
           "image_id": null,
-          "created_at": null,
-          "updated_at": null
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-31T19:00:00-05:00"
         }
       ],
       "images": [],
@@ -98,5 +100,6 @@
         }
       ]
     }
-  }
+  },
+  "shop_feature": false
 }

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

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product publication for an active product is created, or whenever an existing product publication is published on the app that is subscribed to this webhook topic. Note that a webhook is only emitted when there are publishing changes to the app that is subscribed to the topic (ie. no webhook will be emitted if there is a publishing change to the online store and the webhook subscriber of the topic is a third-party app).",
+  "name": "product_publications/create",
+  "related_resource": "ProductListing",
+  "response": {
+    "id": null,
+    "publication_id": null,
+    "published_at": "2021-12-31T19:00:00-05:00",
+    "published": true,
+    "created_at": null,
+    "updated_at": null,
+    "product_id": 788032119674292900
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product publication for an active product is removed, or whenever an existing product publication is unpublished from the app that is subscribed to this webhook topic. Note that a webhook is only emitted when there are publishing changes to the app that is subscribed to the topic (ie. no webhook will be emitted if there is a publishing change to the online store and the webhook subscriber of the topic is a third-party app).",
+  "name": "product_publications/delete",
+  "related_resource": "ProductListing",
+  "response": {
+    "id": null
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "publications"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product publication is updated from the app that is subscribed to this webhook topic. Note that a webhook is only emitted when there are publishing changes to the app that is subscribed to the topic (ie. no webhook will be emitted if there is a publishing change to the online store and the webhook subscriber of the topic is a third-party app).",
+  "name": "product_publications/update",
+  "related_resource": "ProductListing",
+  "response": {
+    "id": null,
+    "publication_id": null,
+    "published_at": "2021-12-31T19:00:00-05:00",
+    "published": true,
+    "created_at": null,
+    "updated_at": null,
+    "product_id": 788032119674292900
+  },
+  "shop_feature": false
+}

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

@@ -4,9 +4,11 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
-  "description": "Occurs whenever a product is created. Product webhooks will return a full variants payload for the first 100 records.For variants 101+, the payload won't include the full variant details,but the variant_gids field will still be included for these variants.",
+  "deprecated": false,
+  "description": "Occurs whenever a product is created. Product webhooks will return a full variants payload for the first 100 records. For records 101 and higher, the payload won't include the full variant details, but the `variant_gids` field will still include a `admin_graphql_api_id` value for these variants. `variant_gids` are sorted by `updated_at`, with the gids for recently updated variants appearing first.",
   "name": "products/create",
   "related_resource": "Product",
   "response": {
@@ -29,57 +31,45 @@
         "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
         "barcode": null,
         "compare_at_price": "24.99",
-        "created_at": null,
-        "fulfillment_service": "manual",
+        "created_at": "2021-12-29T19:00:00-05:00",
         "id": 642667041472714000,
-        "inventory_management": "shopify",
         "inventory_policy": "deny",
         "position": 1,
         "price": "19.99",
         "product_id": 788032119674292900,
-        "sku": "example-shirt-s",
+        "sku": null,
         "taxable": true,
-        "title": "",
-        "updated_at": null,
+        "title": "Small",
+        "updated_at": "2021-12-30T19:00:00-05:00",
         "option1": "Small",
         "option2": null,
         "option3": null,
-        "grams": 200,
         "image_id": null,
-        "weight": 200,
-        "weight_unit": "g",
         "inventory_item_id": null,
         "inventory_quantity": 75,
-        "old_inventory_quantity": 75,
-        "requires_shipping": true
+        "old_inventory_quantity": 75
       },
       {
         "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962",
         "barcode": null,
         "compare_at_price": "24.99",
-        "created_at": null,
-        "fulfillment_service": "manual",
+        "created_at": "2021-12-29T19:00:00-05:00",
         "id": 757650484644203900,
-        "inventory_management": "shopify",
         "inventory_policy": "deny",
         "position": 2,
         "price": "19.99",
         "product_id": 788032119674292900,
-        "sku": "example-shirt-m",
+        "sku": null,
         "taxable": true,
-        "title": "",
-        "updated_at": null,
+        "title": "Medium",
+        "updated_at": "2021-12-31T19:00:00-05:00",
         "option1": "Medium",
         "option2": null,
         "option3": null,
-        "grams": 200,
         "image_id": null,
-        "weight": 200,
-        "weight_unit": "g",
         "inventory_item_id": null,
         "inventory_quantity": 50,
-        "old_inventory_quantity": 50,
-        "requires_shipping": true
+        "old_inventory_quantity": 50
       }
     ],
     "options": [],
@@ -88,11 +78,14 @@
     "media": [],
     "variant_gids": [
       {
-        "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922"
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962",
+        "updated_at": "2022-01-01T00:00:00.000Z"
       },
       {
-        "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962"
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
+        "updated_at": "2021-12-31T00:00:00.000Z"
       }
     ]
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,12 +4,15 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a product is deleted.",
   "name": "products/delete",
   "related_resource": "Product",
   "response": {
     "id": 788032119674292900
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,9 +4,11 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
-  "description": "Occurs whenever a product is updated, or whenever a product is ordered, or whenever a variant is added, removed, or updated. Product webhooks will return a full variants payload for the first 100 records.For variants 101+, the payload won't include the full variant details,but the variant_gids field will still be included for these variants.",
+  "deprecated": false,
+  "description": "Occurs whenever a product is updated, ordered, or variants are added, removed or updated. Product webhooks will return a full variants payload for the first 100 records. For records 101 and higher, the payload won't include the full variant details, but the `variant_gids` field will still include a `admin_graphql_api_id` value for these variants. `variant_gids` are sorted by `updated_at`, with the gids for recently updated variants appearing first.",
   "name": "products/update",
   "related_resource": "Product",
   "response": {
@@ -29,57 +31,45 @@
         "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
         "barcode": null,
         "compare_at_price": "24.99",
-        "created_at": null,
-        "fulfillment_service": "manual",
+        "created_at": "2021-12-29T19:00:00-05:00",
         "id": 642667041472714000,
-        "inventory_management": "shopify",
         "inventory_policy": "deny",
         "position": 1,
         "price": "19.99",
         "product_id": 788032119674292900,
-        "sku": "example-shirt-s",
+        "sku": null,
         "taxable": true,
-        "title": "",
-        "updated_at": null,
+        "title": "Small",
+        "updated_at": "2021-12-30T19:00:00-05:00",
         "option1": "Small",
         "option2": null,
         "option3": null,
-        "grams": 200,
         "image_id": null,
-        "weight": 200,
-        "weight_unit": "g",
         "inventory_item_id": null,
         "inventory_quantity": 75,
-        "old_inventory_quantity": 75,
-        "requires_shipping": true
+        "old_inventory_quantity": 75
       },
       {
         "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962",
         "barcode": null,
         "compare_at_price": "24.99",
-        "created_at": null,
-        "fulfillment_service": "manual",
+        "created_at": "2021-12-29T19:00:00-05:00",
         "id": 757650484644203900,
-        "inventory_management": "shopify",
         "inventory_policy": "deny",
         "position": 2,
         "price": "19.99",
         "product_id": 788032119674292900,
-        "sku": "example-shirt-m",
+        "sku": null,
         "taxable": true,
-        "title": "",
-        "updated_at": null,
+        "title": "Medium",
+        "updated_at": "2021-12-31T19:00:00-05:00",
         "option1": "Medium",
         "option2": null,
         "option3": null,
-        "grams": 200,
         "image_id": null,
-        "weight": 200,
-        "weight_unit": "g",
         "inventory_item_id": null,
         "inventory_quantity": 50,
-        "old_inventory_quantity": 50,
-        "requires_shipping": true
+        "old_inventory_quantity": 50
       }
     ],
     "options": [],
@@ -88,11 +78,14 @@
     "media": [],
     "variant_gids": [
       {
-        "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922"
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962",
+        "updated_at": "2022-01-01T00:00:00.000Z"
       },
       {
-        "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962"
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
+        "updated_at": "2021-12-31T00:00:00.000Z"
       }
     ]
-  }
+  },
+  "shop_feature": false
 }

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

@@ -5,8 +5,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a delivery profile is created",
   "name": "profiles/create",
   "pii": [
@@ -15,5 +17,6 @@
   "related_resource": "DeliveryProfile",
   "response": {
     "id": 1
-  }
+  },
+  "shop_feature": false
 }

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

@@ -5,12 +5,15 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a delivery profile is deleted",
   "name": "profiles/delete",
   "related_resource": "DeliveryProfile",
   "response": {
     "id": 1
-  }
+  },
+  "shop_feature": false
 }

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

@@ -5,8 +5,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a delivery profile is updated",
   "name": "profiles/update",
   "pii": [
@@ -15,5 +17,6 @@
   "related_resource": "DeliveryProfile",
   "response": {
     "id": 1
-  }
+  },
+  "shop_feature": false
 }