shopify-webhook-schemas 0.1.0

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

@@ -0,0 +1,23 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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."
+  }
+}

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

@@ -0,0 +1,23 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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."
+  }
+}

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

@@ -0,0 +1,32 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "buyer_membership_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

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

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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."
+  }
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a fulfillment order hold is released.",
+  "name": "fulfillment_orders/hold_released",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "open"
+    }
+  }
+}

package/metadatas/2023-10/fulfillment_orders/line_items_prepared_for_local_delivery.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"
+  ],
+  "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"
+      }
+    }
+  }
+}

package/metadatas/2023-10/fulfillment_orders/line_items_prepared_for_pickup.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"
+  ],
+  "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"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,37 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

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

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "buyer_membership_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

package/metadatas/2023-10/fulfillment_orders/placed_on_hold.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"
+  ],
+  "description": "Occurs when a fulfillment order is placed on hold.",
+  "name": "fulfillment_orders/placed_on_hold",
+  "related_resource": "FulfillmentOrder",
+  "response": {
+    "fulfillment_order": {
+      "id": "gid://shopify/FulfillmentOrder/1",
+      "status": "on_hold",
+      "fulfillment_holds": [
+        {
+          "reason": "other",
+          "reason_notes": "example"
+        }
+      ]
+    },
+    "remaining_fulfillment_order": null,
+    "held_fulfillment_order_line_items": []
+  }
+}

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

@@ -0,0 +1,22 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

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

@@ -0,0 +1,21 @@
+{
+  "access_scopes": [
+    "merchant_managed_fulfillment_orders",
+    "assigned_fulfillment_orders",
+    "third_party_fulfillment_orders",
+    "marketplace_fulfillment_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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"
+    }
+  }
+}

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

@@ -0,0 +1,182 @@
+{
+  "access_scopes": [
+    "fulfillments",
+    "marketplace_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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": 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": 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": []
+      }
+    ],
+    "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"
+  }
+}

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

@@ -0,0 +1,182 @@
+{
+  "access_scopes": [
+    "fulfillments",
+    "marketplace_orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "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": 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": 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": []
+      }
+    ],
+    "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"
+  }
+}