shopify-webhook-schemas 0.1.6 → 0.1.8

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

@@ -0,0 +1,36 @@
+{
+  "access_scopes": [
+    "returns",
+    "marketplace_returns",
+    "buyer_membership_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a return is updated.",
+  "name": "returns/update",
+  "related_resource": "Order",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/Return/123134564567890",
+    "return_line_items": {
+      "removals": [
+        {
+          "admin_graphql_api_id": "gid://shopify/ReturnLineItem/987654321",
+          "delta": 2
+        }
+      ]
+    },
+    "restocking_fees": {
+      "updates": [],
+      "removals": []
+    },
+    "return_shipping_fees": {
+      "updates": [],
+      "removals": []
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/reverse_deliveries/attach_deliverable.json

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "returns",
+    "marketplace_returns"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a deliverable is attached to a reverse delivery.\nThis occurs when a reverse delivery is created or updated with delivery metadata.\nMetadata includes the delivery method, label, and tracking information associated with a reverse delivery.\n",
+  "name": "reverse_deliveries/attach_deliverable",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "ReverseDelivery",
+  "response": {
+    "id": 9080907654321,
+    "admin_graphql_api_id": "gid://shopify/ReverseDelivery/9080907654321",
+    "return": {
+      "id": 123134564567890,
+      "admin_graphql_api_id": "gid://shopify/Return/123134564567890"
+    },
+    "shipping_deliverable": {
+      "tracking": {
+        "carrier_name": "USPS",
+        "tracking_number": "123345345",
+        "tracking_url": null
+      },
+      "label": {
+        "public_file_url": null,
+        "created_at": null
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-04/reverse_fulfillment_orders/dispose.json

@@ -0,0 +1,48 @@
+{
+  "access_scopes": [
+    "returns",
+    "marketplace_returns"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a disposition is made on a reverse fulfillment order.\nThis includes dispositions made on reverse deliveries that are associated with the reverse fulfillment order.\n",
+  "name": "reverse_fulfillment_orders/dispose",
+  "related_resource": "ReverseFulfillmentOrder",
+  "response": {
+    "id": 11111111,
+    "admin_graphql_api_id": "gid://shopify/ReverseFulfillmentOrder/11111111",
+    "dispositions": [
+      {
+        "reverse_fulfillment_order_line_item": {
+          "id": 2222222,
+          "admin_graphql_api_id": "gid://shopify/ReverseFulfillmentOrderLineItem/2222222"
+        },
+        "reverse_delivery_line_item": null,
+        "type": "restocked",
+        "location": {
+          "id": 3333333,
+          "admin_graphql_api_id": "gid://shopify/Location/3333333"
+        },
+        "quantity": 1
+      },
+      {
+        "reverse_fulfillment_order_line_item": {
+          "id": 2222223,
+          "admin_graphql_api_id": "gid://shopify/ReverseFulfillmentOrderLineItem/2222223"
+        },
+        "reverse_delivery_line_item": null,
+        "type": "restocked",
+        "location": {
+          "id": 3333333,
+          "admin_graphql_api_id": "gid://shopify/Location/3333333"
+        },
+        "quantity": 1
+      }
+    ],
+    "total_dispositions": 2
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,105 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product is scheduled to be published.",
+  "name": "scheduled_product_listings/add",
+  "related_resource": "ProductListing",
+  "response": {
+    "scheduled_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",
+      "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"
+        }
+      ],
+      "publish_at": null,
+      "images": [],
+      "options": [
+        {
+          "id": 527050010214937800,
+          "name": "Title",
+          "product_id": 788032119674292900,
+          "position": 1,
+          "values": [
+            "Small",
+            "Medium"
+          ]
+        }
+      ]
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,20 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product is no longer scheduled to be published.",
+  "name": "scheduled_product_listings/remove",
+  "related_resource": "ProductListing",
+  "response": {
+    "scheduled_product_listing": {
+      "product_id": 788032119674292900
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,105 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a product's scheduled availability date changes.",
+  "name": "scheduled_product_listings/update",
+  "related_resource": "ProductListing",
+  "response": {
+    "scheduled_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",
+      "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"
+        }
+      ],
+      "publish_at": null,
+      "images": [],
+      "options": [
+        {
+          "id": 527050010214937800,
+          "name": "Title",
+          "product_id": 788032119674292900,
+          "position": 1,
+          "values": [
+            "Small",
+            "Medium"
+          ]
+        }
+      ]
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a segment is created.",
+  "name": "segments/create",
+  "related_resource": "Payload",
+  "response": {
+    "id": 1,
+    "name": "Customers who have one order",
+    "query": "number_of_orders = 1",
+    "creationDate": "2022-01-01T00:00:00.000Z",
+    "lastEditDate": "2022-01-01T00:00:00.000Z"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,17 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a segment is deleted.",
+  "name": "segments/delete",
+  "related_resource": "Payload",
+  "response": {
+    "id": 1
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "customers"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a segment is updated.",
+  "name": "segments/update",
+  "related_resource": "Payload",
+  "response": {
+    "id": 1,
+    "name": "Customers who have one order",
+    "query": "number_of_orders = 1",
+    "creationDate": "2005-05-05T07:00:00.000Z",
+    "lastEditDate": "2022-01-01T00:00:00.000Z"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,55 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Notifies when a SellingPlanGroup is created.",
+  "name": "selling_plan_groups/create",
+  "related_resource": "SellingPlanGroup",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SellingPlanGroup/1039518902",
+    "id": 1039518902,
+    "name": "Subscribe & Save",
+    "merchant_code": "sub-n-save",
+    "admin_graphql_api_app": "gid://shopify/App/2525000003",
+    "app_id": null,
+    "description": null,
+    "options": [
+      "Delivery every"
+    ],
+    "position": null,
+    "summary": "1 delivery frequency,  discount",
+    "selling_plans": [
+      {
+        "name": "Pay every month deliver every month",
+        "options": [
+          "month"
+        ],
+        "position": null,
+        "description": null,
+        "billing_policy": {
+          "interval": "month",
+          "interval_count": 1,
+          "min_cycles": null,
+          "max_cycles": null
+        },
+        "delivery_policy": {
+          "interval": "month",
+          "interval_count": 1,
+          "anchors": [],
+          "cutoff": null,
+          "pre_anchor_behavior": "asap"
+        },
+        "pricing_policies": []
+      }
+    ],
+    "product_variants": [],
+    "products": []
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Notifies when a SellingPlanGroup is deleted.",
+  "name": "selling_plan_groups/delete",
+  "related_resource": "SellingPlanGroup",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SellingPlanGroup/1039518917",
+    "id": 1039518917
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,55 @@
+{
+  "access_scopes": [
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Notifies when a SellingPlanGroup is updated.",
+  "name": "selling_plan_groups/update",
+  "related_resource": "SellingPlanGroup",
+  "response": {
+    "admin_graphql_api_id": "gid://shopify/SellingPlanGroup/1039518916",
+    "id": 1039518916,
+    "name": "Subscribe & Save",
+    "merchant_code": "sub-n-save",
+    "admin_graphql_api_app": "gid://shopify/App/2525000003",
+    "app_id": null,
+    "description": null,
+    "options": [
+      "Delivery every"
+    ],
+    "position": null,
+    "summary": "1 delivery frequency,  discount",
+    "selling_plans": [
+      {
+        "name": "Pay every month deliver every month",
+        "options": [
+          "month"
+        ],
+        "position": null,
+        "description": null,
+        "billing_policy": {
+          "interval": "month",
+          "interval_count": 1,
+          "min_cycles": null,
+          "max_cycles": null
+        },
+        "delivery_policy": {
+          "interval": "month",
+          "interval_count": 1,
+          "anchors": [],
+          "cutoff": null,
+          "pre_anchor_behavior": "asap"
+        },
+        "pricing_policies": []
+      }
+    ],
+    "product_variants": [],
+    "products": []
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "shipping"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": true,
+  "description": "Occurs whenever a shipping address is created.",
+  "name": "shipping_addresses/create",
+  "related_resource": "ShippingAddress",
+  "response": {},
+  "shop_feature": false
+}

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

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "shipping"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": true,
+  "description": "Occurs whenever a shipping address is updated.",
+  "name": "shipping_addresses/update",
+  "related_resource": "ShippingAddress",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2025-04/shop/redact.json

@@ -0,0 +1,15 @@
+{
+  "available_on": [
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "48 hours after a store owner uninstalls your app, Shopify sends a payload on the shop/redact topic. This webhook provides the store's shop_id and shop_domain so that you can erase data for that store from your database.\n\nWhile testing with this topic in development, note that the corresponding event on your test shop will not result in a webhook triggering immediately. shop/redact webhooks are emitted no earlier than 48 hours after uninstalling the app, and they do not fire if the app has been re-installed again.",
+  "name": "shop/redact",
+  "privacy_compliance_topic": true,
+  "related_resource": "Shop",
+  "response": {
+    "shop_id": 954889,
+    "shop_domain": "{shop}.myshopify.com"
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,70 @@
+{
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a shop is updated.",
+  "name": "shop/update",
+  "related_resource": "Shop",
+  "response": {
+    "id": 548380009,
+    "name": "Super Toys",
+    "email": "super@supertoys.com",
+    "domain": null,
+    "province": "Tennessee",
+    "country": "US",
+    "address1": "190 MacLaren Street",
+    "zip": "37178",
+    "city": "Houston",
+    "source": null,
+    "phone": "3213213210",
+    "latitude": null,
+    "longitude": null,
+    "primary_locale": "en",
+    "address2": null,
+    "created_at": null,
+    "updated_at": null,
+    "country_code": "US",
+    "country_name": "United States",
+    "currency": "USD",
+    "customer_email": "super@supertoys.com",
+    "timezone": "(GMT-05:00) Eastern Time (US & Canada)",
+    "iana_timezone": null,
+    "shop_owner": "John Smith",
+    "money_format": "${{amount}}",
+    "money_with_currency_format": "${{amount}} USD",
+    "weight_unit": "kg",
+    "province_code": "TN",
+    "taxes_included": null,
+    "auto_configure_tax_inclusivity": null,
+    "tax_shipping": null,
+    "county_taxes": null,
+    "plan_display_name": "Shopify Plus",
+    "plan_name": "enterprise",
+    "has_discounts": false,
+    "has_gift_cards": true,
+    "myshopify_domain": null,
+    "google_apps_domain": null,
+    "google_apps_login_enabled": null,
+    "money_in_emails_format": "${{amount}}",
+    "money_with_currency_in_emails_format": "${{amount}} USD",
+    "eligible_for_payments": true,
+    "requires_extra_payments_agreement": false,
+    "password_enabled": null,
+    "has_storefront": true,
+    "finances": true,
+    "primary_location_id": 655441491,
+    "checkout_api_supported": true,
+    "multi_location_enabled": true,
+    "setup_required": false,
+    "pre_launch_enabled": false,
+    "enabled_presentment_currencies": [
+      "USD"
+    ],
+    "marketing_sms_consent_enabled_at_checkout": false,
+    "transactional_sms_disabled": false
+  },
+  "shop_feature": false
+}