shopify-webhook-schemas 0.2.2 → 0.2.3

package/metadatas/2024-04/app/scopes_update.json

@@ -1,23 +0,0 @@
-{
-  "available_on": [
-    "graphql",
-    "rest",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs whenever the access scopes of any installation are modified. Allows apps to keep track of the granted access scopes of their installations.",
-  "name": "app/scopes_update",
-  "related_resource": "Shop",
-  "response": {
-    "id": 1,
-    "previous": [
-      "read_products"
-    ],
-    "current": [
-      "read_products",
-      "write_products"
-    ],
-    "updated_at": "2024-06-25T00:00:00.000Z"
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/checkout_and_accounts_configurations/update.json

@@ -1,22 +0,0 @@
-{
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "The event occurs whenever a published checkout and account configuration is updated.",
-  "name": "checkout_and_accounts_configurations/update",
-  "related_resource": "Payload",
-  "response": {
-    "admin_graphql_api_id": "gid://shopify/CheckoutProfile/1",
-    "name": "Sample Checkout Profile",
-    "created_at": "2021-12-31T19:00:00-05:00",
-    "edited_at": "2021-12-31T19:00:00-05:00",
-    "updated_at": "2021-12-31T19:00:00-05:00",
-    "is_published": true,
-    "settings": {
-      "typ_osp_pages_enabled": false
-    }
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/customer.joined_segment.json

@@ -1,18 +0,0 @@
-{
-  "access_scopes": [
-    "customers"
-  ],
-  "available_on": [
-    "graphql"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a customer joins a segment.",
-  "name": "customer.joined_segment",
-  "related_resource": "JoinedSegment",
-  "response": {
-    "shop_id": "gid://shopify/Shop/1",
-    "customer_id": "gid://shopify/Customer/2",
-    "segment_id": "gid://shopify/Segment/3"
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/customer.left_segment.json

@@ -1,18 +0,0 @@
-{
-  "access_scopes": [
-    "customers"
-  ],
-  "available_on": [
-    "graphql"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a customer leaves a segment.",
-  "name": "customer.left_segment",
-  "related_resource": "LeftSegment",
-  "response": {
-    "shop_id": "gid://shopify/Shop/1",
-    "customer_id": "gid://shopify/Customer/2",
-    "segment_id": "gid://shopify/Segment/3"
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/customer_account_settings/update.json

@@ -1,17 +0,0 @@
-{
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Triggers when merchants change customer account setting.",
-  "name": "customer_account_settings/update",
-  "related_resource": "CustomerSettingsRecord",
-  "response": {
-    "url": null,
-    "customer_accounts_version": "classic",
-    "login_required_at_checkout": true,
-    "login_links_visible_on_storefront_and_checkout": true
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/customers/purchasing_summary.json

@@ -1,27 +0,0 @@
-{
-  "access_scopes": [
-    "customers"
-  ],
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs when a customer sales history change.",
-  "name": "customers/purchasing_summary",
-  "pii": [
-    "customer"
-  ],
-  "related_resource": "Payload",
-  "response": {
-    "customerId": "gid://shopify/Customer/1",
-    "numberOfOrders": 1,
-    "amountSpent": {
-      "amount": "100.00",
-      "currencyCode": "USD"
-    },
-    "lastOrderId": "gid://shopify/Order/1",
-    "occurredAt": "2005-05-05T04:00:00.000Z"
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/delivery_promise_settings/update.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "shipping"
-  ],
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs when a promise setting is updated.",
-  "name": "delivery_promise_settings/update",
-  "related_resource": "PromiseSetting",
-  "response": {
-    "shop_id": "gid://shopify/Shop/548380009",
-    "processing_time": "P2D",
-    "delivery_dates_enabled": true
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/finance_app_staff_member/delete.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "financial_kyc_information"
-  ],
-  "available_on": [
-    "graphql",
-    "rest",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a staff with access to all or some finance app has been removed.",
-  "name": "finance_app_staff_member/delete",
-  "related_resource": "User",
-  "response": {},
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "read_financial_kyc_information"
-  ]
-}

package/metadatas/2024-04/finance_app_staff_member/grant.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "financial_kyc_information"
-  ],
-  "available_on": [
-    "graphql",
-    "rest",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a staff is granted access to all or some finance app.",
-  "name": "finance_app_staff_member/grant",
-  "related_resource": "User",
-  "response": {},
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "read_financial_kyc_information"
-  ]
-}

package/metadatas/2024-04/finance_app_staff_member/revoke.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "financial_kyc_information"
-  ],
-  "available_on": [
-    "graphql",
-    "rest",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a staff's access to all or some finance app has been revoked.",
-  "name": "finance_app_staff_member/revoke",
-  "related_resource": "User",
-  "response": {},
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "read_financial_kyc_information"
-  ]
-}

package/metadatas/2024-04/finance_app_staff_member/update.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "financial_kyc_information"
-  ],
-  "available_on": [
-    "graphql",
-    "rest",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a staff's information has been updated.",
-  "name": "finance_app_staff_member/update",
-  "related_resource": "User",
-  "response": {},
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "read_financial_kyc_information"
-  ]
-}

package/metadatas/2024-04/finance_kyc_information/update.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "financial_kyc_information"
-  ],
-  "available_on": [
-    "graphql",
-    "rest",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs whenever shop's finance KYC information was updated",
-  "name": "finance_kyc_information/update",
-  "related_resource": "FinanceKycInformation",
-  "response": {},
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "read_financial_kyc_information"
-  ]
-}

package/metadatas/2024-04/fulfillment_holds/added.json

@@ -1,32 +0,0 @@
-{
-  "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/2024-04/fulfillment_holds/released.json

@@ -1,32 +0,0 @@
-{
-  "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/2024-04/markets_backup_region/update.json

@@ -1,18 +0,0 @@
-{
-  "access_scopes": [
-    "markets"
-  ],
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs when a backup region is updated.",
-  "name": "markets_backup_region/update",
-  "related_resource": "Region",
-  "response": {
-    "admin_graphql_api_id": "gid://shopify/MarketRegion/238945671234567891",
-    "code": "US"
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/metafield_definitions/create.json

@@ -1,47 +0,0 @@
-{
-  "access_scopes": [
-    "content"
-  ],
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs when a metafield definition is created.",
-  "name": "metafield_definitions/create",
-  "related_resource": "MetafieldDefinition",
-  "response": {
-    "id": null,
-    "shop_id": 548380009,
-    "namespace": "example-type",
-    "key": "example-key",
-    "name": "Example Field",
-    "description": null,
-    "owner_type": "Customer",
-    "deleting": false,
-    "type_name": "single_line_text_field",
-    "options": [],
-    "api_client_id": null,
-    "created_at": null,
-    "updated_at": null,
-    "validation_status": "all_valid",
-    "pinned_position": 0,
-    "standard_template_id": null,
-    "access": "unrestricted",
-    "merchant_writeable": null,
-    "storefront_readable": null,
-    "app_admin_access": null,
-    "customer_access": null,
-    "namespace_owner_api_client_id": null,
-    "unique_values": false,
-    "smart_collection_condition": false,
-    "option_linkable": false,
-    "admin_filterable": false,
-    "admin_filterable_status": null,
-    "app_config_managed": false,
-    "access_only": false,
-    "admin_filter_status": "not_filterable",
-    "use_as_collection_condition": false
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/metafield_definitions/delete.json

@@ -1,19 +0,0 @@
-{
-  "access_scopes": [
-    "content"
-  ],
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs when a metafield definition is deleted.",
-  "name": "metafield_definitions/delete",
-  "related_resource": "MetafieldDefinition",
-  "response": {
-    "id": "gid://shopify/MetafieldDefinition/1",
-    "type": "ShopifyMetafields::Types::SingleLineTextFieldType",
-    "created_by_app_id": null
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/metafield_definitions/update.json

@@ -1,47 +0,0 @@
-{
-  "access_scopes": [
-    "content"
-  ],
-  "available_on": [
-    "graphql",
-    "toml"
-  ],
-  "deprecated": false,
-  "description": "Occurs when a metafield definition is updated.",
-  "name": "metafield_definitions/update",
-  "related_resource": "MetafieldDefinition",
-  "response": {
-    "id": null,
-    "shop_id": 548380009,
-    "namespace": "example-type",
-    "key": "example-key",
-    "name": "Example Field",
-    "description": null,
-    "owner_type": "Customer",
-    "deleting": false,
-    "type_name": "single_line_text_field",
-    "options": [],
-    "api_client_id": null,
-    "created_at": null,
-    "updated_at": null,
-    "validation_status": "all_valid",
-    "pinned_position": 0,
-    "standard_template_id": null,
-    "access": "unrestricted",
-    "merchant_writeable": null,
-    "storefront_readable": null,
-    "app_admin_access": null,
-    "customer_access": null,
-    "namespace_owner_api_client_id": null,
-    "unique_values": false,
-    "smart_collection_condition": false,
-    "option_linkable": false,
-    "admin_filterable": false,
-    "admin_filterable_status": null,
-    "app_config_managed": false,
-    "access_only": false,
-    "admin_filter_status": "not_filterable",
-    "use_as_collection_condition": false
-  },
-  "shop_feature": false
-}

package/metadatas/2024-04/product_feeds/full_sync_finish.json

@@ -1,37 +0,0 @@
-{
-  "access_scopes": [
-    "product_listings"
-  ],
-  "available_on": [
-    "graphql",
-    "rest"
-  ],
-  "deprecated": false,
-  "description": "Triggers when a full sync finishes",
-  "name": "product_feeds/full_sync_finish",
-  "related_resource": "",
-  "response": {
-    "metadata": {
-      "action": "CREATE",
-      "type": "FULL",
-      "resource": "PRODUCT",
-      "fullSyncId": "gid://shopify/ProductFullSync/1123511235",
-      "truncatedFields": [],
-      "occurred_at": "2022-01-01T00:00:00.000Z"
-    },
-    "productFeed": {
-      "id": "gid://shopify/ProductFeed/12345",
-      "shop_id": "gid://shopify/Shop/12345",
-      "country": "CA",
-      "language": "EN"
-    },
-    "fullSync": {
-      "createdAt": "2021-12-31 19:00:00 -0500",
-      "errorCode": null,
-      "status": "completed",
-      "count": 12,
-      "url": null
-    }
-  },
-  "shop_feature": false
-}

package/schemas/2024-04/app/scopes_update.json

@@ -1,31 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "properties": {
-    "current": {
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "id": {
-      "type": "integer"
-    },
-    "previous": {
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "updated_at": {
-      "format": "date-time",
-      "type": "string"
-    }
-  },
-  "required": [
-    "current",
-    "id",
-    "previous",
-    "updated_at"
-  ],
-  "type": "object"
-}

package/schemas/2024-04/checkout_and_accounts_configurations/update.json

@@ -1,48 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "properties": {
-    "admin_graphql_api_id": {
-      "format": "uri",
-      "type": "string"
-    },
-    "created_at": {
-      "format": "date-time",
-      "type": "string"
-    },
-    "edited_at": {
-      "format": "date-time",
-      "type": "string"
-    },
-    "is_published": {
-      "type": "boolean"
-    },
-    "name": {
-      "type": "string"
-    },
-    "settings": {
-      "properties": {
-        "typ_osp_pages_enabled": {
-          "type": "boolean"
-        }
-      },
-      "required": [
-        "typ_osp_pages_enabled"
-      ],
-      "type": "object"
-    },
-    "updated_at": {
-      "format": "date-time",
-      "type": "string"
-    }
-  },
-  "required": [
-    "admin_graphql_api_id",
-    "created_at",
-    "edited_at",
-    "is_published",
-    "name",
-    "settings",
-    "updated_at"
-  ],
-  "type": "object"
-}

package/schemas/2024-04/customer.joined_segment.json

@@ -1,23 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "properties": {
-    "customer_id": {
-      "format": "uri",
-      "type": "string"
-    },
-    "segment_id": {
-      "format": "uri",
-      "type": "string"
-    },
-    "shop_id": {
-      "format": "uri",
-      "type": "string"
-    }
-  },
-  "required": [
-    "customer_id",
-    "segment_id",
-    "shop_id"
-  ],
-  "type": "object"
-}

package/schemas/2024-04/customer.left_segment.json

@@ -1,23 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "properties": {
-    "customer_id": {
-      "format": "uri",
-      "type": "string"
-    },
-    "segment_id": {
-      "format": "uri",
-      "type": "string"
-    },
-    "shop_id": {
-      "format": "uri",
-      "type": "string"
-    }
-  },
-  "required": [
-    "customer_id",
-    "segment_id",
-    "shop_id"
-  ],
-  "type": "object"
-}

package/schemas/2024-04/customer_account_settings/update.json

@@ -1,28 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "properties": {
-    "customer_accounts_version": {
-      "type": "string"
-    },
-    "login_links_visible_on_storefront_and_checkout": {
-      "type": "boolean"
-    },
-    "login_required_at_checkout": {
-      "type": "boolean"
-    },
-    "url": {
-      "format": "uri",
-      "type": [
-        "null",
-        "string"
-      ]
-    }
-  },
-  "required": [
-    "customer_accounts_version",
-    "login_links_visible_on_storefront_and_checkout",
-    "login_required_at_checkout",
-    "url"
-  ],
-  "type": "object"
-}