shopify-webhook-schemas 0.1.0

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

@@ -0,0 +1,95 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs when a cart is updated in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are updated in a custom storefront.",
+  "name": "carts/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Cart",
+  "response": {
+    "id": "eeafa272cebfd4b22385bc4b645e762c",
+    "token": "eeafa272cebfd4b22385bc4b645e762c",
+    "line_items": [
+      {
+        "id": 704912205188288500,
+        "properties": {},
+        "quantity": 3,
+        "variant_id": 704912205188288500,
+        "key": "704912205188288575:33f11f7a1ec7d93b826de33bb54de37b",
+        "discounted_price": "19.99",
+        "discounts": [],
+        "gift_card": false,
+        "grams": 200,
+        "line_price": "59.97",
+        "original_line_price": "59.97",
+        "original_price": "19.99",
+        "price": "19.99",
+        "product_id": 788032119674292900,
+        "sku": "example-shirt-s",
+        "taxable": true,
+        "title": "Example T-Shirt",
+        "total_discount": "0.00",
+        "vendor": "Acme",
+        "discounted_price_set": {
+          "shop_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          }
+        },
+        "line_price_set": {
+          "shop_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          }
+        },
+        "original_line_price_set": {
+          "shop_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "59.97",
+            "currency_code": "USD"
+          }
+        },
+        "price_set": {
+          "shop_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "19.99",
+            "currency_code": "USD"
+          }
+        },
+        "total_discount_set": {
+          "shop_money": {
+            "amount": "0.0",
+            "currency_code": "USD"
+          },
+          "presentment_money": {
+            "amount": "0.0",
+            "currency_code": "USD"
+          }
+        }
+      }
+    ],
+    "note": null,
+    "updated_at": "2022-01-01T00:00:00.000Z",
+    "created_at": "2022-01-01T00:00:00.000Z"
+  }
+}

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

@@ -0,0 +1,266 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a checkout is created.",
+  "name": "checkouts/create",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Checkout",
+  "response": {
+    "id": 981820079255243500,
+    "token": "123123123",
+    "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
+    "email": "example@email.com",
+    "gateway": null,
+    "buyer_accepts_marketing": false,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "landing_site": null,
+    "note": null,
+    "note_attributes": [],
+    "referring_site": null,
+    "shipping_lines": [],
+    "taxes_included": false,
+    "total_weight": 1133,
+    "currency": "USD",
+    "completed_at": null,
+    "closed_at": null,
+    "user_id": null,
+    "location_id": null,
+    "source_identifier": null,
+    "source_url": null,
+    "device_id": null,
+    "phone": null,
+    "customer_locale": null,
+    "line_items": [
+      {
+        "applied_discounts": [],
+        "discount_allocations": [],
+        "key": "b30e29b2270a257219423c6a01d44f8b",
+        "destination_location_id": 938998225,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 567,
+        "origin_location_id": 938998224,
+        "presentment_title": "IPod Nano - 8GB",
+        "presentment_variant_title": "Pink",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+          {
+            "price": "11.94",
+            "position": 1,
+            "rate": 0.06,
+            "title": "Tax",
+            "source": "Shopify",
+            "zone": "province",
+            "jurisdiction_id": null,
+            "jurisdiction_type": null,
+            "jurisdiction_source": null,
+            "reporting_taxable_amount": null,
+            "reporting_non_taxable_amount": null,
+            "reporting_exempt_amount": null,
+            "reporting_jurisdiction_name": null,
+            "reporting_jurisdiction_type": null,
+            "reporting_jurisdiction_code": null,
+            "tax_api_client_id": null,
+            "tax_calculation_price": "11.94",
+            "compare_at": 0.06,
+            "channel_liable": false
+          }
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "variant_price": "199.00",
+        "vendor": "Apple",
+        "user_id": null,
+        "unit_price_measurement": {
+          "measured_type": null,
+          "quantity_value": null,
+          "quantity_unit": null,
+          "reference_value": null,
+          "reference_unit": null
+        },
+        "rank": null,
+        "compare_at_price": null,
+        "line_price": "199.00",
+        "price": "199.00"
+      },
+      {
+        "applied_discounts": [],
+        "discount_allocations": [],
+        "key": "b30e29b2270a257219423c6a01d44f8b",
+        "destination_location_id": 938998225,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 567,
+        "origin_location_id": 938998224,
+        "presentment_title": "IPod Nano - 8GB",
+        "presentment_variant_title": "Pink",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+          {
+            "price": "11.94",
+            "position": 1,
+            "rate": 0.06,
+            "title": "Tax",
+            "source": "Shopify",
+            "zone": "province",
+            "jurisdiction_id": null,
+            "jurisdiction_type": null,
+            "jurisdiction_source": null,
+            "reporting_taxable_amount": null,
+            "reporting_non_taxable_amount": null,
+            "reporting_exempt_amount": null,
+            "reporting_jurisdiction_name": null,
+            "reporting_jurisdiction_type": null,
+            "reporting_jurisdiction_code": null,
+            "tax_api_client_id": null,
+            "tax_calculation_price": "11.94",
+            "compare_at": 0.06,
+            "channel_liable": false
+          }
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "variant_price": "199.00",
+        "vendor": "Apple",
+        "user_id": null,
+        "unit_price_measurement": {
+          "measured_type": null,
+          "quantity_value": null,
+          "quantity_unit": null,
+          "reference_value": null,
+          "reference_unit": null
+        },
+        "rank": null,
+        "compare_at_price": null,
+        "line_price": "199.00",
+        "price": "199.00"
+      }
+    ],
+    "name": "#981820079255243537",
+    "source": null,
+    "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/123123123/recover?key=example-secret-token",
+    "discount_codes": [],
+    "tax_lines": [
+      {
+        "price": "23.88",
+        "rate": 0.06,
+        "title": "Tax",
+        "channel_liable": false
+      }
+    ],
+    "source_name": "web",
+    "presentment_currency": "USD",
+    "buyer_accepts_sms_marketing": false,
+    "sms_marketing_phone": null,
+    "total_discounts": "0.00",
+    "total_line_items_price": "398.00",
+    "total_price": "421.88",
+    "total_tax": "23.88",
+    "subtotal_price": "398.00",
+    "total_duties": null,
+    "billing_address": {
+      "first_name": "Bob",
+      "address1": "123 Billing Street",
+      "phone": "555-555-BILL",
+      "city": "Billtown",
+      "zip": "K2P0B0",
+      "province": "Kentucky",
+      "country": "United States",
+      "last_name": "Biller",
+      "address2": null,
+      "company": "My Company",
+      "latitude": null,
+      "longitude": null,
+      "name": "Bob Biller",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "shipping_address": {
+      "first_name": "Steve",
+      "address1": "123 Shipping Street",
+      "phone": "555-555-SHIP",
+      "city": "Shippington",
+      "zip": "K2P0S0",
+      "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"
+    },
+    "customer": {
+      "id": 603851970716743400,
+      "email": "john@example.com",
+      "created_at": null,
+      "updated_at": null,
+      "first_name": "John",
+      "last_name": "Smith",
+      "orders_count": 0,
+      "state": "disabled",
+      "total_spent": "0.00",
+      "last_order_id": null,
+      "note": null,
+      "verified_email": true,
+      "multipass_identifier": null,
+      "tax_exempt": false,
+      "tags": "",
+      "last_order_name": null,
+      "currency": "USD",
+      "phone": null,
+      "accepts_marketing": false,
+      "accepts_marketing_updated_at": null,
+      "marketing_opt_in_level": null,
+      "tax_exemptions": [],
+      "email_marketing_consent": {
+        "state": "not_subscribed",
+        "opt_in_level": null,
+        "consent_updated_at": null
+      },
+      "sms_marketing_consent": null,
+      "admin_graphql_api_id": "gid://shopify/Customer/603851970716743426",
+      "default_address": {
+        "id": null,
+        "customer_id": 603851970716743400,
+        "first_name": null,
+        "last_name": null,
+        "company": null,
+        "address1": "123 Elm St.",
+        "address2": null,
+        "city": "Ottawa",
+        "province": "Ontario",
+        "country": "Canada",
+        "zip": "K2H7A8",
+        "phone": "123-123-1234",
+        "name": "",
+        "province_code": "ON",
+        "country_code": "CA",
+        "country_name": "Canada",
+        "default": true
+      }
+    }
+  }
+}

package/metadatas/2023-10/checkouts/delete.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a checkout is deleted.",
+  "name": "checkouts/delete",
+  "related_resource": "Checkout",
+  "response": {
+    "id": 981820079255243500,
+    "presentment_currency": "USD",
+    "buyer_accepts_sms_marketing": false,
+    "sms_marketing_phone": null,
+    "total_discounts": "0.00",
+    "total_line_items_price": "398.00",
+    "total_price": "421.88",
+    "total_tax": "23.88",
+    "subtotal_price": "398.00",
+    "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
+    "total_duties": null
+  }
+}

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

@@ -0,0 +1,266 @@
+{
+  "access_scopes": [
+    "orders"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a checkout is updated.",
+  "name": "checkouts/update",
+  "pii": [
+    "customer"
+  ],
+  "related_resource": "Checkout",
+  "response": {
+    "id": 981820079255243500,
+    "token": "123123123",
+    "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
+    "email": "example@email.com",
+    "gateway": null,
+    "buyer_accepts_marketing": false,
+    "created_at": "2021-12-31T19:00:00-05:00",
+    "updated_at": "2021-12-31T19:00:00-05:00",
+    "landing_site": null,
+    "note": null,
+    "note_attributes": [],
+    "referring_site": null,
+    "shipping_lines": [],
+    "taxes_included": false,
+    "total_weight": 1133,
+    "currency": "USD",
+    "completed_at": null,
+    "closed_at": null,
+    "user_id": null,
+    "location_id": null,
+    "source_identifier": null,
+    "source_url": null,
+    "device_id": null,
+    "phone": null,
+    "customer_locale": null,
+    "line_items": [
+      {
+        "applied_discounts": [],
+        "discount_allocations": [],
+        "key": "c9b2116099dcca681979901a4ad2875c",
+        "destination_location_id": 938998231,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 567,
+        "origin_location_id": 938998230,
+        "presentment_title": "IPod Nano - 8GB",
+        "presentment_variant_title": "Pink",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+          {
+            "price": "11.94",
+            "position": 1,
+            "rate": 0.06,
+            "title": "Tax",
+            "source": "Shopify",
+            "zone": "province",
+            "jurisdiction_id": null,
+            "jurisdiction_type": null,
+            "jurisdiction_source": null,
+            "reporting_taxable_amount": null,
+            "reporting_non_taxable_amount": null,
+            "reporting_exempt_amount": null,
+            "reporting_jurisdiction_name": null,
+            "reporting_jurisdiction_type": null,
+            "reporting_jurisdiction_code": null,
+            "tax_api_client_id": null,
+            "tax_calculation_price": "11.94",
+            "compare_at": 0.06,
+            "channel_liable": false
+          }
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "variant_price": "199.00",
+        "vendor": "Apple",
+        "user_id": null,
+        "unit_price_measurement": {
+          "measured_type": null,
+          "quantity_value": null,
+          "quantity_unit": null,
+          "reference_value": null,
+          "reference_unit": null
+        },
+        "rank": null,
+        "compare_at_price": null,
+        "line_price": "199.00",
+        "price": "199.00"
+      },
+      {
+        "applied_discounts": [],
+        "discount_allocations": [],
+        "key": "c9b2116099dcca681979901a4ad2875c",
+        "destination_location_id": 938998231,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 567,
+        "origin_location_id": 938998230,
+        "presentment_title": "IPod Nano - 8GB",
+        "presentment_variant_title": "Pink",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+          {
+            "price": "11.94",
+            "position": 1,
+            "rate": 0.06,
+            "title": "Tax",
+            "source": "Shopify",
+            "zone": "province",
+            "jurisdiction_id": null,
+            "jurisdiction_type": null,
+            "jurisdiction_source": null,
+            "reporting_taxable_amount": null,
+            "reporting_non_taxable_amount": null,
+            "reporting_exempt_amount": null,
+            "reporting_jurisdiction_name": null,
+            "reporting_jurisdiction_type": null,
+            "reporting_jurisdiction_code": null,
+            "tax_api_client_id": null,
+            "tax_calculation_price": "11.94",
+            "compare_at": 0.06,
+            "channel_liable": false
+          }
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "variant_price": "199.00",
+        "vendor": "Apple",
+        "user_id": null,
+        "unit_price_measurement": {
+          "measured_type": null,
+          "quantity_value": null,
+          "quantity_unit": null,
+          "reference_value": null,
+          "reference_unit": null
+        },
+        "rank": null,
+        "compare_at_price": null,
+        "line_price": "199.00",
+        "price": "199.00"
+      }
+    ],
+    "name": "#981820079255243537",
+    "source": null,
+    "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/123123123/recover?key=example-secret-token",
+    "discount_codes": [],
+    "tax_lines": [
+      {
+        "price": "23.88",
+        "rate": 0.06,
+        "title": "Tax",
+        "channel_liable": false
+      }
+    ],
+    "source_name": "web",
+    "presentment_currency": "USD",
+    "buyer_accepts_sms_marketing": false,
+    "sms_marketing_phone": null,
+    "total_discounts": "0.00",
+    "total_line_items_price": "398.00",
+    "total_price": "421.88",
+    "total_tax": "23.88",
+    "subtotal_price": "398.00",
+    "total_duties": null,
+    "billing_address": {
+      "first_name": "Bob",
+      "address1": "123 Billing Street",
+      "phone": "555-555-BILL",
+      "city": "Billtown",
+      "zip": "K2P0B0",
+      "province": "Kentucky",
+      "country": "United States",
+      "last_name": "Biller",
+      "address2": null,
+      "company": "My Company",
+      "latitude": null,
+      "longitude": null,
+      "name": "Bob Biller",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "shipping_address": {
+      "first_name": "Steve",
+      "address1": "123 Shipping Street",
+      "phone": "555-555-SHIP",
+      "city": "Shippington",
+      "zip": "K2P0S0",
+      "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"
+    },
+    "customer": {
+      "id": 603851970716743400,
+      "email": "john@example.com",
+      "created_at": null,
+      "updated_at": null,
+      "first_name": "John",
+      "last_name": "Smith",
+      "orders_count": 0,
+      "state": "disabled",
+      "total_spent": "0.00",
+      "last_order_id": null,
+      "note": null,
+      "verified_email": true,
+      "multipass_identifier": null,
+      "tax_exempt": false,
+      "tags": "",
+      "last_order_name": null,
+      "currency": "USD",
+      "phone": null,
+      "accepts_marketing": false,
+      "accepts_marketing_updated_at": null,
+      "marketing_opt_in_level": null,
+      "tax_exemptions": [],
+      "email_marketing_consent": {
+        "state": "not_subscribed",
+        "opt_in_level": null,
+        "consent_updated_at": null
+      },
+      "sms_marketing_consent": null,
+      "admin_graphql_api_id": "gid://shopify/Customer/603851970716743426",
+      "default_address": {
+        "id": null,
+        "customer_id": 603851970716743400,
+        "first_name": null,
+        "last_name": null,
+        "company": null,
+        "address1": "123 Elm St.",
+        "address2": null,
+        "city": "Ottawa",
+        "province": "Ontario",
+        "country": "Canada",
+        "zip": "K2H7A8",
+        "phone": "123-123-1234",
+        "name": "",
+        "province_code": "ON",
+        "country_code": "CA",
+        "country_name": "Canada",
+        "default": true
+      }
+    }
+  }
+}

package/metadatas/2023-10/collection_listings/add.json

@@ -0,0 +1,25 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a collection listing is added.",
+  "name": "collection_listings/add",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "collection_listing": {
+      "collection_id": 408372092144951400,
+      "updated_at": null,
+      "body_html": "<b>Some HTML</b>",
+      "default_product_image": null,
+      "handle": "mynewcollection",
+      "image": null,
+      "title": "My New Collection",
+      "sort_order": null,
+      "published_at": "2021-12-31T19:00:00-05:00"
+    }
+  }
+}

package/metadatas/2023-10/collection_listings/remove.json

@@ -0,0 +1,17 @@
+{
+  "access_scopes": [
+    "product_listings"
+  ],
+  "available_on": [
+    "graphql",
+    "rest"
+  ],
+  "description": "Occurs whenever a collection listing is removed.",
+  "name": "collection_listings/remove",
+  "related_resource": "CollectionPublication",
+  "response": {
+    "collection_listing": {
+      "collection_id": 408372092144951400
+    }
+  }
+}