shopify-webhook-schemas 0.1.6 → 0.1.8

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

@@ -0,0 +1,18 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "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/2025-04/products/update.json

@@ -0,0 +1,93 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "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": {
+    "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
+}

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

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "shipping",
+    "assigned_shipping"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a delivery profile is created",
+  "name": "profiles/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "DeliveryProfile",
+  "response": {
+    "id": 1
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "shipping",
+    "assigned_shipping"
+  ],
+  "available_on": [
+    "graphql",
+    "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/2025-04/profiles/update.json

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "shipping",
+    "assigned_shipping"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a delivery profile is updated",
+  "name": "profiles/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "DeliveryProfile",
+  "response": {
+    "id": 1
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,299 @@
+{
+  "access_scopes": [
+    "orders",
+    "marketplace_orders",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a new refund is created without errors on an order, independent from the movement of money.",
+  "name": "refunds/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Refund",
+  "response": {
+    "id": 890088186047892400,
+    "order_id": 820982911946154500,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "note": "Things were damaged",
+    "user_id": 548380009,
+    "processed_at": "2021-12-31T19:00:00-05:00",
+    "duties": [],
+    "total_duties_set": {
+      "shop_money": {
+        "amount": "0.00",
+        "currency_code": "USD"
+      },
+      "presentment_money": {
+        "amount": "0.00",
+        "currency_code": "USD"
+      }
+    },
+    "return": null,
+    "restock": false,
+    "refund_shipping_lines": [],
+    "admin_graphql_api_id": "gid://shopify/Refund/890088186047892319",
+    "order_adjustments": [],
+    "refund_line_items": [
+      {
+        "id": 866550311766439000,
+        "quantity": 1,
+        "line_item_id": 866550311766439000,
+        "location_id": null,
+        "restock_type": "no_restock",
+        "subtotal": 199,
+        "total_tax": 0,
+        "subtotal_set": {
+          "shop_money": {
+            "amount": "199.00",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "199.00",
+            "currency_code": "USD"
+          }
+        },
+        "total_tax_set": {
+          "shop_money": {
+            "amount": "0.00",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "0.00",
+            "currency_code": "USD"
+          }
+        },
+        "line_item": {
+          "id": 866550311766439000,
+          "variant_id": 808950810,
+          "title": "IPod Nano - 8GB",
+          "quantity": 1,
+          "sku": "IPOD2008PINK",
+          "variant_title": null,
+          "vendor": null,
+          "fulfillment_service": "manual",
+          "product_id": 632910392,
+          "requires_shipping": true,
+          "taxable": true,
+          "gift_card": false,
+          "name": "IPod Nano - 8GB",
+          "variant_inventory_management": "shopify",
+          "properties": [],
+          "product_exists": true,
+          "fulfillable_quantity": 1,
+          "grams": 567,
+          "price": "199.00",
+          "total_discount": "0.00",
+          "fulfillment_status": null,
+          "price_set": {
+            "shop_money": {
+              "amount": "199.00",
+              "currency_code": "USD"
+            },
+            "presentment_money": {
+              "amount": "199.00",
+              "currency_code": "USD"
+            }
+          },
+          "total_discount_set": {
+            "shop_money": {
+              "amount": "0.00",
+              "currency_code": "USD"
+            },
+            "presentment_money": {
+              "amount": "0.00",
+              "currency_code": "USD"
+            }
+          },
+          "discount_allocations": [],
+          "duties": [],
+          "admin_graphql_api_id": "gid://shopify/LineItem/866550311766439020",
+          "tax_lines": []
+        }
+      },
+      {
+        "id": 141249953214523040,
+        "quantity": 1,
+        "line_item_id": 141249953214522980,
+        "location_id": null,
+        "restock_type": "no_restock",
+        "subtotal": 199,
+        "total_tax": 0,
+        "subtotal_set": {
+          "shop_money": {
+            "amount": "199.00",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "199.00",
+            "currency_code": "USD"
+          }
+        },
+        "total_tax_set": {
+          "shop_money": {
+            "amount": "0.00",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "0.00",
+            "currency_code": "USD"
+          }
+        },
+        "line_item": {
+          "id": 141249953214522980,
+          "variant_id": 808950810,
+          "title": "IPod Nano - 8GB",
+          "quantity": 1,
+          "sku": "IPOD2008PINK",
+          "variant_title": null,
+          "vendor": null,
+          "fulfillment_service": "manual",
+          "product_id": 632910392,
+          "requires_shipping": true,
+          "taxable": true,
+          "gift_card": false,
+          "name": "IPod Nano - 8GB",
+          "variant_inventory_management": "shopify",
+          "properties": [],
+          "product_exists": true,
+          "fulfillable_quantity": 1,
+          "grams": 567,
+          "price": "199.00",
+          "total_discount": "5.00",
+          "fulfillment_status": null,
+          "price_set": {
+            "shop_money": {
+              "amount": "199.00",
+              "currency_code": "USD"
+            },
+            "presentment_money": {
+              "amount": "199.00",
+              "currency_code": "USD"
+            }
+          },
+          "total_discount_set": {
+            "shop_money": {
+              "amount": "5.00",
+              "currency_code": "USD"
+            },
+            "presentment_money": {
+              "amount": "5.00",
+              "currency_code": "USD"
+            }
+          },
+          "discount_allocations": [
+            {
+              "amount": "5.00",
+              "discount_application_index": 0,
+              "amount_set": {
+                "shop_money": {
+                  "amount": "5.00",
+                  "currency_code": "USD"
+                },
+                "presentment_money": {
+                  "amount": "5.00",
+                  "currency_code": "USD"
+                }
+              }
+            },
+            {
+              "amount": "5.00",
+              "discount_application_index": 2,
+              "amount_set": {
+                "shop_money": {
+                  "amount": "5.00",
+                  "currency_code": "USD"
+                },
+                "presentment_money": {
+                  "amount": "5.00",
+                  "currency_code": "USD"
+                }
+              }
+            }
+          ],
+          "duties": [],
+          "admin_graphql_api_id": "gid://shopify/LineItem/141249953214522974",
+          "tax_lines": []
+        }
+      }
+    ],
+    "transactions": [
+      {
+        "id": 245135271310201180,
+        "order_id": 820982911946154500,
+        "kind": "refund",
+        "gateway": "bogus",
+        "status": "success",
+        "message": "This is a refund",
+        "created_at": "2019-12-31T19:00:00-05:00",
+        "test": false,
+        "authorization": null,
+        "location_id": null,
+        "user_id": null,
+        "parent_id": null,
+        "processed_at": null,
+        "device_id": null,
+        "error_code": null,
+        "source_name": "web",
+        "receipt": {},
+        "amount": "75.00",
+        "currency": null,
+        "payment_id": "#9999.",
+        "total_unsettled_set": {
+          "presentment_money": {
+            "amount": "0.0",
+            "currency": "XXX"
+          },
+          "shop_money": {
+            "amount": "0.0",
+            "currency": "XXX"
+          }
+        },
+        "manual_payment_gateway": false,
+        "amount_rounding": null,
+        "admin_graphql_api_id": "gid://shopify/OrderTransaction/245135271310201194"
+      },
+      {
+        "id": 839212141605670500,
+        "order_id": 820982911946154500,
+        "kind": "refund",
+        "gateway": "bogus",
+        "status": "success",
+        "message": null,
+        "created_at": "2020-01-01T19:00:00-05:00",
+        "test": false,
+        "authorization": null,
+        "location_id": null,
+        "user_id": null,
+        "parent_id": null,
+        "processed_at": null,
+        "device_id": null,
+        "error_code": null,
+        "source_name": "web",
+        "receipt": {},
+        "amount": "10.00",
+        "currency": null,
+        "payment_id": "#9999.",
+        "total_unsettled_set": {
+          "presentment_money": {
+            "amount": "0.0",
+            "currency": "XXX"
+          },
+          "shop_money": {
+            "amount": "0.0",
+            "currency": "XXX"
+          }
+        },
+        "manual_payment_gateway": false,
+        "amount_rounding": null,
+        "admin_graphql_api_id": "gid://shopify/OrderTransaction/839212141605670573"
+      }
+    ]
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/returns/approve.json

@@ -0,0 +1,52 @@
+{
+  "access_scopes": [
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a return is approved. This means `Return.status` is `OPEN`.",
+  "name": "returns/approve",
+  "related_resource": "Return",
+  "response": {
+    "id": 123134564567890,
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "status": "open",
+    "order": {
+      "id": 4783296544821,
+      "admin_graphql_api_id": "gid://shopify/Order/4783296544821"
+    },
+    "total_return_line_items": 2,
+    "name": null,
+    "return_line_items": [],
+    "return_shipping_fees": [
+      {
+        "id": 987654321547866,
+        "admin_graphql_api_id": "gid://shopify/ReturnShippingFee/987654321547866",
+        "price": {
+          "shop_money": {
+            "amount": "10.0",
+            "currency_code": "XXX"
+          },
+          "presentment_money": {
+            "amount": "10.0",
+            "currency_code": "XXX"
+          }
+        }
+      }
+    ],
+    "exchange_line_items": [
+      {
+        "id": 987654321283476,
+        "admin_graphql_api_id": "gid://shopify/ExchangeLineItem/987654321283476",
+        "line_item": null
+      }
+    ],
+    "total_exchange_line_items": 1
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/returns/cancel.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "orders",
+    "marketplace_orders",
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a return is canceled.",
+  "name": "returns/cancel",
+  "related_resource": "Return",
+  "response": {
+    "id": 123134564567890,
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "order_id": 4783296544821,
+    "status": "canceled"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/returns/close.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "orders",
+    "marketplace_orders",
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a return is closed.",
+  "name": "returns/close",
+  "related_resource": "Return",
+  "response": {
+    "id": 123134564567890,
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "order_id": 4783296544821,
+    "status": "closed"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/returns/decline.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a return is declined. This means `Return.status` is `DECLINED`.",
+  "name": "returns/decline",
+  "related_resource": "Return",
+  "response": {
+    "id": 123134564567890,
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "status": "declined",
+    "decline": {
+      "reason": "return_period_ended",
+      "note": "As discussed on the phone, the 30-day return window has ended."
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/returns/reopen.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "orders",
+    "marketplace_orders",
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a closed return is reopened.",
+  "name": "returns/reopen",
+  "related_resource": "Return",
+  "response": {
+    "id": 123134564567890,
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "order_id": 4783296544821,
+    "status": "open"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/returns/request.json

@@ -0,0 +1,31 @@
+{
+  "access_scopes": [
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a return is requested. This means `Return.status` is `REQUESTED`.",
+  "name": "returns/request",
+  "related_resource": "Return",
+  "response": {
+    "id": 123134564567890,
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "status": "requested",
+    "order": {
+      "id": 4783296544821,
+      "admin_graphql_api_id": "gid://shopify/Order/4783296544821"
+    },
+    "total_return_line_items": 2,
+    "name": null,
+    "return_line_items": [],
+    "return_shipping_fees": [],
+    "exchange_line_items": [],
+    "total_exchange_line_items": 0
+  },
+  "shop_feature": false
+}