shopify-webhook-schemas 0.1.6 → 0.1.7

package/metadatas/2025-04/product_feeds/full_sync.json

@@ -0,0 +1,111 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a full sync for a product feed is performed",
+  "name": "product_feeds/full_sync",
+  "related_resource": "",
+  "response": {
+    "metadata": {
+      "action": "CREATE",
+      "type": "FULL",
+      "resource": "PRODUCT",
+      "fullSyncId": "gid://shopify/ProductFullSync/1123511235",
+      "truncatedFields": [],
+      "occurred_at": "2022-01-01T00:00:00.000Z"
+    },
+    "productFeed": {
+      "id": "gid://shopify/ProductFeed/12345",
+      "shop_id": "gid://shopify/Shop/12345",
+      "country": "CA",
+      "language": "EN"
+    },
+    "product": {
+      "id": "gid://shopify/Product/12345",
+      "title": "Coffee",
+      "description": "The best coffee in the world",
+      "onlineStoreUrl": "https://example.com/products/coffee",
+      "createdAt": "2021-12-31T19:00:00-05:00",
+      "updatedAt": "2021-12-31T19:00:00-05:00",
+      "isPublished": true,
+      "publishedAt": "2021-12-31T19:00:00-05:00",
+      "productType": "Coffee",
+      "vendor": "Cawfee Inc",
+      "handle": "",
+      "images": {
+        "edges": [
+          {
+            "node": {
+              "id": "gid://shopify/ProductImage/394",
+              "url": "https://cdn.shopify.com/s/files/1/0262/9117/5446/products/IMG_0022.jpg?v=1675101331",
+              "height": 3024,
+              "width": 4032
+            }
+          }
+        ]
+      },
+      "options": [
+        {
+          "name": "Title",
+          "values": [
+            "151cm",
+            "155cm",
+            "158cm"
+          ]
+        }
+      ],
+      "seo": {
+        "title": "seo title",
+        "description": "seo description"
+      },
+      "tags": [
+        "tag1",
+        "tag2"
+      ],
+      "variants": {
+        "edges": [
+          {
+            "node": {
+              "id": "gid://shopify/ProductVariant/1",
+              "title": "151cm",
+              "price": {
+                "amount": "100.00",
+                "currencyCode": "CAD"
+              },
+              "compareAtPrice": null,
+              "sku": "12345",
+              "barcode": null,
+              "quantityAvailable": 10,
+              "availableForSale": true,
+              "weight": 2.3,
+              "weightUnit": "KILOGRAMS",
+              "requireShipping": true,
+              "inventoryPolicy": "DENY",
+              "createdAt": "2021-12-31T19:00:00-05:00",
+              "updatedAt": "2021-12-31T19:00:00-05:00",
+              "image": {
+                "id": "gid://shopify/ProductImage/394",
+                "url": "https://cdn.shopify.com/s/files/1/0262/9117/5446/products/IMG_0022.jpg?v=1675101331",
+                "height": 3024,
+                "width": 4032
+              },
+              "selectedOptions": [
+                {
+                  "name": "Title",
+                  "value": "151cm"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    },
+    "products": null
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/product_feeds/full_sync_finish.json

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a full sync finishes",
+  "name": "product_feeds/full_sync_finish",
+  "related_resource": "",
+  "response": {
+    "metadata": {
+      "action": "CREATE",
+      "type": "FULL",
+      "resource": "PRODUCT",
+      "fullSyncId": "gid://shopify/ProductFullSync/1123511235",
+      "truncatedFields": [],
+      "occurred_at": "2022-01-01T00:00:00.000Z"
+    },
+    "productFeed": {
+      "id": "gid://shopify/ProductFeed/12345",
+      "shop_id": "gid://shopify/Shop/12345",
+      "country": "CA",
+      "language": "EN"
+    },
+    "fullSync": {
+      "createdAt": "2021-12-31 19:00:00 -0500",
+      "errorCode": null,
+      "status": "completed",
+      "count": 12,
+      "url": null
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/product_feeds/incremental_sync.json

@@ -0,0 +1,110 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product publication is created, updated or removed for a product feed",
+  "name": "product_feeds/incremental_sync",
+  "related_resource": "",
+  "response": {
+    "metadata": {
+      "action": "CREATE",
+      "type": "INCREMENTAL",
+      "resource": "PRODUCT",
+      "truncatedFields": [],
+      "occured_at": "2021-12-31T19:00:00-05:00"
+    },
+    "productFeed": {
+      "id": "gid://shopify/ProductFeed/12345",
+      "shop_id": "gid://shopify/Shop/12345",
+      "country": "CA",
+      "language": "EN"
+    },
+    "product": {
+      "id": "gid://shopify/Product/12345",
+      "title": "Coffee",
+      "description": "The best coffee in the world",
+      "onlineStoreUrl": "https://example.com/products/coffee",
+      "createdAt": "2021-12-31T19:00:00-05:00",
+      "updatedAt": "2021-12-31T19:00:00-05:00",
+      "isPublished": true,
+      "publishedAt": "2021-12-31T19:00:00-05:00",
+      "productType": "Coffee",
+      "vendor": "Cawfee Inc",
+      "handle": "",
+      "images": {
+        "edges": [
+          {
+            "node": {
+              "id": "gid://shopify/ProductImage/394",
+              "url": "https://cdn.shopify.com/s/files/1/0262/9117/5446/products/IMG_0022.jpg?v=1675101331",
+              "height": 3024,
+              "width": 4032
+            }
+          }
+        ]
+      },
+      "options": [
+        {
+          "name": "Title",
+          "values": [
+            "151cm",
+            "155cm",
+            "158cm"
+          ]
+        }
+      ],
+      "seo": {
+        "title": "seo title",
+        "description": "seo description"
+      },
+      "tags": [
+        "tag1",
+        "tag2"
+      ],
+      "variants": {
+        "edges": [
+          {
+            "node": {
+              "id": "gid://shopify/ProductVariant/1",
+              "title": "151cm",
+              "price": {
+                "amount": "100.00",
+                "currencyCode": "CAD"
+              },
+              "compareAtPrice": null,
+              "sku": "12345",
+              "barcode": null,
+              "quantityAvailable": 10,
+              "availableForSale": true,
+              "weight": 2.3,
+              "weightUnit": "KILOGRAMS",
+              "requireShipping": true,
+              "inventoryPolicy": "DENY",
+              "createdAt": "2021-12-31T19:00:00-05:00",
+              "updatedAt": "2021-12-31T19:00:00-05:00",
+              "image": {
+                "id": "gid://shopify/ProductImage/394",
+                "url": "https://cdn.shopify.com/s/files/1/0262/9117/5446/products/IMG_0022.jpg?v=1675101331",
+                "height": 3024,
+                "width": 4032
+              },
+              "selectedOptions": [
+                {
+                  "name": "Title",
+                  "value": "151cm"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    },
+    "products": null
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when product feed is updated",
+  "name": "product_feeds/update",
+  "related_resource": "ProductFeed",
+  "response": {
+    "id": "gid://shopify/ProductFeed/",
+    "country": "CA",
+    "language": "EN",
+    "status": ""
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/product_listings/add.json

@@ -0,0 +1,105 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an active product is listed on a channel.",
+  "name": "product_listings/add",
+  "related_resource": "ProductListing",
+  "response": {
+    "product_listing": {
+      "product_id": 788032119674292900,
+      "created_at": null,
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "body_html": "An example T-Shirt",
+      "handle": "example-t-shirt",
+      "product_type": "Shirts",
+      "title": "Example T-Shirt",
+      "vendor": "Acme",
+      "available": true,
+      "tags": "example, mens, t-shirt",
+      "published_at": "2021-12-31T19:00:00-05:00",
+      "variants": [
+        {
+          "id": 642667041472714000,
+          "title": "Small",
+          "option_values": [
+            {
+              "option_id": 527050010214937800,
+              "name": "Title",
+              "value": "Small"
+            }
+          ],
+          "price": "19.99",
+          "formatted_price": "$19.99",
+          "compare_at_price": "24.99",
+          "grams": 0,
+          "requires_shipping": true,
+          "sku": null,
+          "barcode": null,
+          "taxable": true,
+          "position": 1,
+          "available": true,
+          "inventory_policy": "deny",
+          "inventory_quantity": 75,
+          "inventory_management": null,
+          "fulfillment_service": "manual",
+          "weight": 0,
+          "weight_unit": "lb",
+          "image_id": null,
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-30T19:00:00-05:00"
+        },
+        {
+          "id": 757650484644203900,
+          "title": "Medium",
+          "option_values": [
+            {
+              "option_id": 527050010214937800,
+              "name": "Title",
+              "value": "Medium"
+            }
+          ],
+          "price": "19.99",
+          "formatted_price": "$19.99",
+          "compare_at_price": "24.99",
+          "grams": 0,
+          "requires_shipping": true,
+          "sku": null,
+          "barcode": null,
+          "taxable": true,
+          "position": 2,
+          "available": true,
+          "inventory_policy": "deny",
+          "inventory_quantity": 50,
+          "inventory_management": null,
+          "fulfillment_service": "manual",
+          "weight": 0,
+          "weight_unit": "lb",
+          "image_id": null,
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-31T19:00:00-05:00"
+        }
+      ],
+      "images": [],
+      "options": [
+        {
+          "id": 527050010214937800,
+          "name": "Title",
+          "product_id": 788032119674292900,
+          "position": 1,
+          "values": [
+            "Small",
+            "Medium"
+          ]
+        }
+      ]
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/product_listings/remove.json

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product listing is removed from the channel.",
+  "name": "product_listings/remove",
+  "related_resource": "ProductListing",
+  "response": {
+    "product_listing": {
+      "product_id": 788032119674292900
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,105 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product publication is updated.",
+  "name": "product_listings/update",
+  "related_resource": "ProductListing",
+  "response": {
+    "product_listing": {
+      "product_id": 788032119674292900,
+      "created_at": null,
+      "updated_at": "2021-12-31T19:00:00-05:00",
+      "body_html": "An example T-Shirt",
+      "handle": "example-t-shirt",
+      "product_type": "Shirts",
+      "title": "Example T-Shirt",
+      "vendor": "Acme",
+      "available": true,
+      "tags": "example, mens, t-shirt",
+      "published_at": "2021-12-31T19:00:00-05:00",
+      "variants": [
+        {
+          "id": 642667041472714000,
+          "title": "Small",
+          "option_values": [
+            {
+              "option_id": 527050010214937800,
+              "name": "Title",
+              "value": "Small"
+            }
+          ],
+          "price": "19.99",
+          "formatted_price": "$19.99",
+          "compare_at_price": "24.99",
+          "grams": 0,
+          "requires_shipping": true,
+          "sku": null,
+          "barcode": null,
+          "taxable": true,
+          "position": 1,
+          "available": true,
+          "inventory_policy": "deny",
+          "inventory_quantity": 75,
+          "inventory_management": null,
+          "fulfillment_service": "manual",
+          "weight": 0,
+          "weight_unit": "lb",
+          "image_id": null,
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-30T19:00:00-05:00"
+        },
+        {
+          "id": 757650484644203900,
+          "title": "Medium",
+          "option_values": [
+            {
+              "option_id": 527050010214937800,
+              "name": "Title",
+              "value": "Medium"
+            }
+          ],
+          "price": "19.99",
+          "formatted_price": "$19.99",
+          "compare_at_price": "24.99",
+          "grams": 0,
+          "requires_shipping": true,
+          "sku": null,
+          "barcode": null,
+          "taxable": true,
+          "position": 2,
+          "available": true,
+          "inventory_policy": "deny",
+          "inventory_quantity": 50,
+          "inventory_management": null,
+          "fulfillment_service": "manual",
+          "weight": 0,
+          "weight_unit": "lb",
+          "image_id": null,
+          "created_at": "2021-12-29T19:00:00-05:00",
+          "updated_at": "2021-12-31T19:00:00-05:00"
+        }
+      ],
+      "images": [],
+      "options": [
+        {
+          "id": 527050010214937800,
+          "name": "Title",
+          "product_id": 788032119674292900,
+          "position": 1,
+          "values": [
+            "Small",
+            "Medium"
+          ]
+        }
+      ]
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/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/2025-04/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/2025-04/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/2025-04/products/create.json

@@ -0,0 +1,93 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "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": {
+    "admin_graphql_api_id": "gid://shopify/Product/788032119674292922",
+    "body_html": "An example T-Shirt",
+    "created_at": null,
+    "handle": "example-t-shirt",
+    "id": 788032119674292900,
+    "product_type": "Shirts",
+    "published_at": "2021-12-31T19:00:00-05:00",
+    "template_suffix": null,
+    "title": "Example T-Shirt",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "vendor": "Acme",
+    "status": "active",
+    "published_scope": "web",
+    "tags": "example, mens, t-shirt",
+    "variants": [
+      {
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
+        "barcode": null,
+        "compare_at_price": "24.99",
+        "created_at": "2021-12-29T19:00:00-05:00",
+        "id": 642667041472714000,
+        "inventory_policy": "deny",
+        "position": 1,
+        "price": "19.99",
+        "product_id": 788032119674292900,
+        "sku": null,
+        "taxable": true,
+        "title": "Small",
+        "updated_at": "2021-12-30T19:00:00-05:00",
+        "option1": "Small",
+        "option2": null,
+        "option3": null,
+        "image_id": null,
+        "inventory_item_id": null,
+        "inventory_quantity": 75,
+        "old_inventory_quantity": 75
+      },
+      {
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962",
+        "barcode": null,
+        "compare_at_price": "24.99",
+        "created_at": "2021-12-29T19:00:00-05:00",
+        "id": 757650484644203900,
+        "inventory_policy": "deny",
+        "position": 2,
+        "price": "19.99",
+        "product_id": 788032119674292900,
+        "sku": null,
+        "taxable": true,
+        "title": "Medium",
+        "updated_at": "2021-12-31T19:00:00-05:00",
+        "option1": "Medium",
+        "option2": null,
+        "option3": null,
+        "image_id": null,
+        "inventory_item_id": null,
+        "inventory_quantity": 50,
+        "old_inventory_quantity": 50
+      }
+    ],
+    "options": [],
+    "images": [],
+    "image": null,
+    "media": [],
+    "variant_gids": [
+      {
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/757650484644203962",
+        "updated_at": "2022-01-01T00:00:00.000Z"
+      },
+      {
+        "admin_graphql_api_id": "gid://shopify/ProductVariant/642667041472713922",
+        "updated_at": "2021-12-31T00:00:00.000Z"
+      }
+    ],
+    "has_variants_that_requires_components": false,
+    "category": null
+  },
+  "shop_feature": false
+}