shopify-webhook-schemas 0.1.4 → 0.1.5

package/metadatas/2024-07/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/2024-07/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/2024-07/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/2024-07/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/2024-07/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
+}

package/metadatas/2024-07/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/2024-07/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/2024-07/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/2024-07/scheduled_product_listings/add.json

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a product is scheduled to be published.",
   "name": "scheduled_product_listings/add",
   "related_resource": "ProductListing",
@@ -19,12 +21,12 @@
       "product_type": "Shirts",
       "title": "Example T-Shirt",
       "vendor": "Acme",
-      "available": false,
+      "available": true,
       "tags": "example, mens, t-shirt",
       "variants": [
         {
           "id": 642667041472714000,
-          "title": "",
+          "title": "Small",
           "option_values": [
             {
               "option_id": 527050010214937800,
@@ -35,26 +37,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,
@@ -65,22 +67,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"
         }
       ],
       "publish_at": null,
@@ -98,5 +100,6 @@
         }
       ]
     }
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a product is no longer scheduled to be published.",
   "name": "scheduled_product_listings/remove",
   "related_resource": "ProductListing",
@@ -13,5 +15,6 @@
     "scheduled_product_listing": {
       "product_id": 788032119674292900
     }
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,8 +4,10 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "rest",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a product's scheduled availability date changes.",
   "name": "scheduled_product_listings/update",
   "related_resource": "ProductListing",
@@ -19,12 +21,12 @@
       "product_type": "Shirts",
       "title": "Example T-Shirt",
       "vendor": "Acme",
-      "available": false,
+      "available": true,
       "tags": "example, mens, t-shirt",
       "variants": [
         {
           "id": 642667041472714000,
-          "title": "",
+          "title": "Small",
           "option_values": [
             {
               "option_id": 527050010214937800,
@@ -35,26 +37,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,
@@ -65,22 +67,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"
         }
       ],
       "publish_at": null,
@@ -98,5 +100,6 @@
         }
       ]
     }
-  }
+  },
+  "shop_feature": false
 }

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

@@ -3,8 +3,10 @@
     "customers"
   ],
   "available_on": [
-    "graphql"
+    "graphql",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a segment is created.",
   "name": "segments/create",
   "related_resource": "Payload",
@@ -14,5 +16,6 @@
     "query": "number_of_orders = 1",
     "creationDate": "2022-01-01T00:00:00.000Z",
     "lastEditDate": "2022-01-01T00:00:00.000Z"
-  }
+  },
+  "shop_feature": false
 }

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

@@ -3,12 +3,15 @@
     "customers"
   ],
   "available_on": [
-    "graphql"
+    "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/2024-07/segments/update.json

@@ -3,8 +3,10 @@
     "customers"
   ],
   "available_on": [
-    "graphql"
+    "graphql",
+    "toml"
   ],
+  "deprecated": false,
   "description": "Occurs whenever a segment is updated.",
   "name": "segments/update",
   "related_resource": "Payload",
@@ -14,5 +16,6 @@
     "query": "number_of_orders = 1",
     "creationDate": "2005-05-05T00:00:00.000Z",
     "lastEditDate": "2022-01-01T00:00:00.000Z"
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,14 +4,16 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "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/1039518983",
-    "id": 1039518983,
+    "admin_graphql_api_id": "gid://shopify/SellingPlanGroup/1039518907",
+    "id": 1039518907,
     "name": "Subscribe & Save",
     "merchant_code": "sub-n-save",
     "admin_graphql_api_app": "gid://shopify/App/2525000003",
@@ -48,5 +50,6 @@
     ],
     "product_variants": [],
     "products": []
-  }
+  },
+  "shop_feature": false
 }

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

@@ -4,13 +4,16 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "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/1039518995",
-    "id": 1039518995
-  }
+    "admin_graphql_api_id": "gid://shopify/SellingPlanGroup/1039518908",
+    "id": 1039518908
+  },
+  "shop_feature": false
 }

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

@@ -4,14 +4,16 @@
   ],
   "available_on": [
     "graphql",
-    "rest"
+    "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/1039518985",
-    "id": 1039518985,
+    "admin_graphql_api_id": "gid://shopify/SellingPlanGroup/1039518913",
+    "id": 1039518913,
     "name": "Subscribe & Save",
     "merchant_code": "sub-n-save",
     "admin_graphql_api_app": "gid://shopify/App/2525000003",
@@ -48,5 +50,6 @@
     ],
     "product_variants": [],
     "products": []
-  }
+  },
+  "shop_feature": false
 }

package/metadatas/2024-07/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/2024-07/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
+}