shopify-webhook-schemas 0.2.7 → 0.2.8

package/metadatas/2025-10/fulfillments/create.json

@@ -0,0 +1,232 @@
+{
+  "access_scopes": [
+    "fulfillments",
+    "marketplace_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a fulfillment is created.",
+  "name": "fulfillments/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Fulfillment",
+  "response": {
+    "id": 123456,
+    "order_id": 820982911946154500,
+    "status": "pending",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "service": null,
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "tracking_company": "UPS",
+    "shipment_status": null,
+    "location_id": null,
+    "origin_address": null,
+    "email": "jon@example.com",
+    "destination": {
+      "first_name": "Steve",
+      "address1": "123 Shipping Street",
+      "phone": "555-555-SHIP",
+      "city": "Shippington",
+      "zip": "40003",
+      "province": "Kentucky",
+      "country": "United States",
+      "last_name": "Shipper",
+      "address2": null,
+      "company": "Shipping Company",
+      "latitude": null,
+      "longitude": null,
+      "name": "Steve Shipper",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "line_items": [
+      {
+        "id": 487817672276298560,
+        "variant_id": null,
+        "title": "Aviator sunglasses",
+        "quantity": 1,
+        "sku": "SKU2006-001",
+        "variant_title": null,
+        "vendor": null,
+        "fulfillment_service": "manual",
+        "product_id": 788032119674292900,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "name": "Aviator sunglasses",
+        "variant_inventory_management": null,
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 1,
+        "grams": 100,
+        "price": "89.99",
+        "total_discount": "0.00",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "89.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "89.99",
+            "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/487817672276298554",
+        "tax_lines": []
+      },
+      {
+        "id": 976318377106520300,
+        "variant_id": null,
+        "title": "Mid-century lounger",
+        "quantity": 1,
+        "sku": "SKU2006-020",
+        "variant_title": null,
+        "vendor": null,
+        "fulfillment_service": "manual",
+        "product_id": 788032119674292900,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "name": "Mid-century lounger",
+        "variant_inventory_management": null,
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 1,
+        "grams": 1000,
+        "price": "159.99",
+        "total_discount": "5.00",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "159.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "159.99",
+            "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/976318377106520349",
+        "tax_lines": []
+      },
+      {
+        "id": 315789986012684400,
+        "variant_id": null,
+        "title": "Coffee table",
+        "quantity": 1,
+        "sku": "SKU2006-035",
+        "variant_title": null,
+        "vendor": null,
+        "fulfillment_service": "manual",
+        "product_id": 788032119674292900,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "name": "Coffee table",
+        "variant_inventory_management": null,
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 1,
+        "grams": 500,
+        "price": "119.99",
+        "total_discount": "0.00",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "119.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "119.99",
+            "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/315789986012684393",
+        "tax_lines": []
+      }
+    ],
+    "tracking_number": "1z827wk74630",
+    "tracking_numbers": [
+      "1z827wk74630"
+    ],
+    "tracking_url": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1z827wk74630",
+    "tracking_urls": [
+      "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1z827wk74630"
+    ],
+    "receipt": {},
+    "name": "#9999.1",
+    "admin_graphql_api_id": "gid://shopify/Fulfillment/123456"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillments/update.json

@@ -0,0 +1,232 @@
+{
+  "access_scopes": [
+    "fulfillments",
+    "marketplace_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a fulfillment is updated.",
+  "name": "fulfillments/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Fulfillment",
+  "response": {
+    "id": 123456,
+    "order_id": 820982911946154500,
+    "status": "pending",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "service": null,
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "tracking_company": "UPS",
+    "shipment_status": null,
+    "location_id": null,
+    "origin_address": null,
+    "email": "jon@example.com",
+    "destination": {
+      "first_name": "Steve",
+      "address1": "123 Shipping Street",
+      "phone": "555-555-SHIP",
+      "city": "Shippington",
+      "zip": "40003",
+      "province": "Kentucky",
+      "country": "United States",
+      "last_name": "Shipper",
+      "address2": null,
+      "company": "Shipping Company",
+      "latitude": null,
+      "longitude": null,
+      "name": "Steve Shipper",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "line_items": [
+      {
+        "id": 487817672276298560,
+        "variant_id": null,
+        "title": "Aviator sunglasses",
+        "quantity": 1,
+        "sku": "SKU2006-001",
+        "variant_title": null,
+        "vendor": null,
+        "fulfillment_service": "manual",
+        "product_id": 788032119674292900,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "name": "Aviator sunglasses",
+        "variant_inventory_management": null,
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 1,
+        "grams": 100,
+        "price": "89.99",
+        "total_discount": "0.00",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "89.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "89.99",
+            "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/487817672276298554",
+        "tax_lines": []
+      },
+      {
+        "id": 976318377106520300,
+        "variant_id": null,
+        "title": "Mid-century lounger",
+        "quantity": 1,
+        "sku": "SKU2006-020",
+        "variant_title": null,
+        "vendor": null,
+        "fulfillment_service": "manual",
+        "product_id": 788032119674292900,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "name": "Mid-century lounger",
+        "variant_inventory_management": null,
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 1,
+        "grams": 1000,
+        "price": "159.99",
+        "total_discount": "5.00",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "159.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "159.99",
+            "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/976318377106520349",
+        "tax_lines": []
+      },
+      {
+        "id": 315789986012684400,
+        "variant_id": null,
+        "title": "Coffee table",
+        "quantity": 1,
+        "sku": "SKU2006-035",
+        "variant_title": null,
+        "vendor": null,
+        "fulfillment_service": "manual",
+        "product_id": 788032119674292900,
+        "requires_shipping": true,
+        "taxable": true,
+        "gift_card": false,
+        "name": "Coffee table",
+        "variant_inventory_management": null,
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 1,
+        "grams": 500,
+        "price": "119.99",
+        "total_discount": "0.00",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "119.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "119.99",
+            "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/315789986012684393",
+        "tax_lines": []
+      }
+    ],
+    "tracking_number": "1z827wk74630",
+    "tracking_numbers": [
+      "1z827wk74630"
+    ],
+    "tracking_url": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1z827wk74630",
+    "tracking_urls": [
+      "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1z827wk74630"
+    ],
+    "receipt": {},
+    "name": "#9999.1",
+    "admin_graphql_api_id": "gid://shopify/Fulfillment/123456"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_items/create.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "inventory",
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory item is created.",
+  "name": "inventory_items/create",
+  "related_resource": "InventoryItem",
+  "response": {
+    "id": 271878346596884000,
+    "sku": "example-sku",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "requires_shipping": true,
+    "cost": null,
+    "country_code_of_origin": null,
+    "province_code_of_origin": null,
+    "harmonized_system_code": null,
+    "tracked": true,
+    "country_harmonized_system_codes": [],
+    "weight_value": 0,
+    "weight_unit": "lb",
+    "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_items/delete.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "inventory",
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory item is deleted.",
+  "name": "inventory_items/delete",
+  "related_resource": "InventoryItem",
+  "response": {
+    "id": 271878346596884000,
+    "country_code_of_origin": null,
+    "province_code_of_origin": null,
+    "harmonized_system_code": null,
+    "country_harmonized_system_codes": [],
+    "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_items/update.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "inventory",
+    "products"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory item is updated.",
+  "name": "inventory_items/update",
+  "related_resource": "InventoryItem",
+  "response": {
+    "id": 271878346596884000,
+    "sku": "example-sku",
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "requires_shipping": true,
+    "cost": null,
+    "country_code_of_origin": null,
+    "province_code_of_origin": null,
+    "harmonized_system_code": null,
+    "tracked": true,
+    "country_harmonized_system_codes": [],
+    "weight_value": 0,
+    "weight_unit": "lb",
+    "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_levels/connect.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory level is connected.",
+  "name": "inventory_levels/connect",
+  "related_resource": "InventoryLevel",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_levels/disconnect.json

@@ -0,0 +1,19 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory level is disconnected.",
+  "name": "inventory_levels/disconnect",
+  "related_resource": "InventoryLevel",
+  "response": {
+    "inventory_item_id": 271878346596884000,
+    "location_id": 24826418
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_levels/update.json

@@ -0,0 +1,16 @@
+{
+  "access_scopes": [
+    "inventory"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever an inventory level is updated.",
+  "name": "inventory_levels/update",
+  "related_resource": "InventoryLevel",
+  "response": {},
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/add_items.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever items are added to a shipment.",
+  "name": "inventory_shipments/add_items",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "items_added": [
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/82243",
+        "quantity": 10
+      },
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/57116",
+        "quantity": 7
+      }
+    ],
+    "happened_at": "2023-09-01T08:19:56-04:00"
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/inventory_shipments/create.json

@@ -0,0 +1,35 @@
+{
+  "access_scopes": [
+    "inventory_shipments"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a shipment is created.",
+  "name": "inventory_shipments/create",
+  "related_resource": "Shipment",
+  "response": {
+    "id": "gid://shopify/InventoryShipment/3921201",
+    "status": "DRAFT",
+    "happened_at": "2023-09-01T08:19:56-04:00",
+    "tracking": {
+      "arrives_at": "2023-10-02T03:24:44-04:00",
+      "tracking_number": "8375692728",
+      "tracking_url": "https://exampletracking.shopify.com/track/8375692728",
+      "company": "Purolator"
+    },
+    "line_items": [
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/82243",
+        "quantity": 10
+      },
+      {
+        "id": "gid://shopify/InventoryShipmentLineItem/57116",
+        "quantity": 7
+      }
+    ]
+  },
+  "shop_feature": false
+}