shopify-webhook-schemas 0.2.6 → 0.2.8

package/metadatas/2025-10/fulfillment_holds/added.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs each time that a hold is added to a fulfillment order.\n\nFor cases where multiple holds are applied to a fulfillment order, this webhook will trigger after each hold is applied.\n",
+  "name": "fulfillment_holds/added",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1"
+    },
+    "fulfillment_hold": {
+      "id": "gid://shopify/FulfillmentHold/1",
+      "reason": "other",
+      "reason_notes": "Waiting for some more details from the customer before this can be fulfilled.",
+      "held_by_requesting_app": false,
+      "handle": "test_handle",
+      "held_by_app": {
+        "id": "gid://shopify/App/12345"
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_holds/released.json

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs each time that a hold is released from a fulfillment order.\nFor cases where multiple holds are released from a fulfillment order a the same time, this webhook will trigger for each released hold.\n",
+  "name": "fulfillment_holds/released",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1"
+    },
+    "fulfillment_hold": {
+      "id": "gid://shopify/FulfillmentHold/1",
+      "reason": "other",
+      "reason_notes": "Waiting for some more details from the customer before this can be fulfilled.",
+      "held_by_requesting_app": false,
+      "handle": "fulfillment_hold_1",
+      "held_by_app": {
+        "id": "gid://shopify/App/12345"
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/cancellation_request_accepted.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a 3PL accepts a fulfillment cancellation request, received from a merchant.",
+  "name": "fulfillment_orders/cancellation_request_accepted",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "closed"
+    },
+    "message": "Order has not been shipped yet."
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/cancellation_request_rejected.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a 3PL rejects a fulfillment cancellation request, received from a merchant.",
+  "name": "fulfillment_orders/cancellation_request_rejected",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "in_progress",
+      "request_status": "cancellation_rejected"
+    },
+    "message": "Order has already been shipped."
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/cancellation_request_submitted.json

@@ -0,0 +1,29 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a merchant requests a fulfillment request to be cancelled after that request was approved by a 3PL.",
+  "name": "fulfillment_orders/cancellation_request_submitted",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "in_progress",
+      "request_status": "cancellation_request"
+    },
+    "fulfillment_order_merchant_request": {
+      "id": "gid://shopify/FulfillmentOrderMerchantRequest/1",
+      "message": "Customer cancelled their order"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/cancelled.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a fulfillment order is cancelled.",
+  "name": "fulfillment_orders/cancelled",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "cancelled"
+    },
+    "replacement_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/2",
+      "status": "open"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/fulfillment_request_accepted.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a fulfillment service accepts a request to fulfill a fulfillment order.",
+  "name": "fulfillment_orders/fulfillment_request_accepted",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "in_progress",
+      "request_status": "accepted"
+    },
+    "message": "We will ship the item tomorrow."
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/fulfillment_request_rejected.json

@@ -0,0 +1,26 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a 3PL rejects a fulfillment request that was sent by a merchant.",
+  "name": "fulfillment_orders/fulfillment_request_rejected",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open",
+      "request_status": "rejected"
+    },
+    "message": "Can't fulfill due to no inventory on product."
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/fulfillment_request_submitted.json

@@ -0,0 +1,34 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a merchant submits a fulfillment request to a 3PL.",
+  "name": "fulfillment_orders/fulfillment_request_submitted",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "original_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open",
+      "request_status": "unsubmitted"
+    },
+    "submitted_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open",
+      "request_status": "unsubmitted"
+    },
+    "fulfillment_order_merchant_request": {
+      "id": "gid://shopify/FulfillmentOrderMerchantRequest/1",
+      "message": "Fragile"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/fulfillment_service_failed_to_complete.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a fulfillment service intends to close an in_progress fulfillment order.",
+  "name": "fulfillment_orders/fulfillment_service_failed_to_complete",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "closed"
+    },
+    "message": "We broke the last item."
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/hold_released.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a fulfillment order is released and is no longer on hold.\n\nIf a fulfillment order has multiple holds then this webhook will only be triggered once when the last hold is released and the status of the fulfillment order is no longer `ON_HOLD`.\n",
+  "name": "fulfillment_orders/hold_released",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/line_items_prepared_for_local_delivery.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a fulfillment order's line items are prepared for local delivery.",
+  "name": "fulfillment_orders/line_items_prepared_for_local_delivery",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open",
+      "preparable": true,
+      "delivery_method": {
+        "method_type": "local"
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/line_items_prepared_for_pickup.json

@@ -0,0 +1,28 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when one or more of the line items for a fulfillment order are prepared for pickup",
+  "name": "fulfillment_orders/line_items_prepared_for_pickup",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open",
+      "preparable": true,
+      "delivery_method": {
+        "method_type": "pickup"
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/merged.json

@@ -0,0 +1,45 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when multiple fulfillment orders are merged into a single fulfillment order.",
+  "name": "fulfillment_orders/merged",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "merge_intents": [
+      {
+        "fulfillment_order_id": 1,
+        "fulfillment_order_line_items": [
+          {
+            "id": 1,
+            "quantity": 1
+          }
+        ]
+      },
+      {
+        "fulfillment_order_id": 2,
+        "fulfillment_order_line_items": [
+          {
+            "id": 2,
+            "quantity": 1
+          }
+        ]
+      }
+    ],
+    "fulfillment_order_merges": {
+      "fulfillment_order": {
+        "id": "gid://shopify/FulfillmentOrder/1",
+        "status": "open"
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/moved.json

@@ -0,0 +1,40 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever the location which is assigned to fulfill one or more fulfillment order line items is changed.\n\n* `original_fulfillment_order` - The final state of the original fulfillment order.\n* `moved_fulfillment_order` - The fulfillment order which now contains the re-assigned line items.\n* `source_location` - The original location which was assigned to fulfill the line items (available as of the `2023-04` API version).\n* `destination_location_id` - The ID of the location which is now responsible for fulfilling the line items.\n\n**Note:** The [assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation)\nof the `original_fulfillment_order` might be changed by the move operation.\nIf you need to determine the originally assigned location, then you should refer to the `source_location`.\n\n[Learn more about moving line items](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentOrderMove).\n",
+  "name": "fulfillment_orders/moved",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "original_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "closed",
+      "assigned_location_id": "gid://shopify/Location/0"
+    },
+    "moved_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/2",
+      "status": "open",
+      "assigned_location_id": "gid://shopify/Location/1"
+    },
+    "destination_location_id": "gid://shopify/Location/1",
+    "fulfillment_order_line_items_requested": [
+      {
+        "id": "gid://shopify/FulfillmentOrderLineItem/1",
+        "quantity": 1
+      }
+    ],
+    "source_location": {
+      "id": "gid://shopify/Location/0"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/order_routing_complete.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "buyer_membership_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when an order has finished being routed and it's fulfillment orders assigned to a fulfillment service's location.",
+  "name": "fulfillment_orders/order_routing_complete",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/placed_on_hold.json

@@ -0,0 +1,66 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a fulfillment order transitions to the `ON_HOLD` status\n\nFor cases where multiple holds are applied to a fulfillment order, this webhook will only trigger once when the first hold is applied and the fulfillment order status changes to `ON_HOLD`.\n",
+  "name": "fulfillment_orders/placed_on_hold",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "on_hold",
+      "fulfillment_holds": [
+        {
+          "id": "gid://shopify/FulfillmentHold/1",
+          "reason": "other",
+          "reason_notes": "example",
+          "held_by_requesting_app": false,
+          "handle": "example-hold-1",
+          "held_by_app": {
+            "id": "gid://shopify/App/12345"
+          }
+        },
+        {
+          "id": "gid://shopify/FulfillmentHold/2",
+          "reason": "inventory_out_of_stock",
+          "reason_notes": "Stacked hold",
+          "held_by_requesting_app": false,
+          "handle": "example-hold-2",
+          "held_by_app": {
+            "id": "gid://shopify/App/12345"
+          }
+        }
+      ]
+    },
+    "remaining_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/2",
+      "status": "open"
+    },
+    "held_fulfillment_order_line_items": [
+      {
+        "id": "gid://shopify/FulfillmentOrderLineItem/3",
+        "quantity": 4
+      }
+    ],
+    "created_fulfillment_hold": {
+      "id": "gid://shopify/FulfillmentHold/1",
+      "reason": "other",
+      "reason_notes": "example",
+      "held_by_requesting_app": false,
+      "handle": "example-hold-1",
+      "held_by_app": {
+        "id": "gid://shopify/App/12345"
+      }
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/rescheduled.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Triggers when a fulfillment order is rescheduled.\n\nFulfillment orders may be merged if they have the same `fulfillAt` datetime.\nIf the fulfillment order is merged then the resulting fulfillment order will be indicated in the webhook body.\nOtherwise it will be the original fulfillment order with an updated `fulfill_at` datetime.\n",
+  "name": "fulfillment_orders/rescheduled",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "scheduled",
+      "fulfill_at": "2021-12-31T19:00:00-05:00"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/scheduled_fulfillment_order_ready.json

@@ -0,0 +1,24 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs whenever a fulfillment order which was scheduled becomes due.",
+  "name": "fulfillment_orders/scheduled_fulfillment_order_ready",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open"
+    }
+  },
+  "shop_feature": false
+}

package/metadatas/2025-10/fulfillment_orders/split.json

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest",
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Occurs when a fulfillment order is split into multiple fulfillment orders.",
+  "name": "fulfillment_orders/split",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "split_line_items": [
+      {
+        "id": "gid://shopify/FulfillmentOrderLineItem/1",
+        "quantity": 1
+      }
+    ],
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open"
+    },
+    "remaining_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/2",
+      "status": "open"
+    },
+    "replacement_fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/3",
+      "status": "open"
+    }
+  },
+  "shop_feature": false
+}