Skip to content

Commit 2e7230a

Browse files
authored
DEVDOCS-5997: International Enhancements for MSF, update properties field for channel locale only (#352)
1 parent f94d2f4 commit 2e7230a

File tree

5 files changed

+11
-10
lines changed

5 files changed

+11
-10
lines changed

docs/integrations/webhooks/events/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ Payload objects with the following scopes take the form that follows:
444444

445445
| Name / Scope | Description |
446446
|:-------------------------|:------------|
447-
| store/modifier/updated | Fires when you edit attributes for a local or shared modifier. Updates to the global store and channel locale as an override triggers the webhook. The `context` fields are present for only override updates. |
447+
| store/modifier/updated | Fires when you edit attributes for a local or shared modifier. Updates to the global store and channel locale as an override triggers the webhook.<br /><br />The `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview. |
448448

449449
The payload object takes the form that follows:
450450

@@ -475,7 +475,7 @@ Consult the [notifications section of the Channel Webhooks Guide](/docs/integrat
475475

476476
| Name / Scope | Description |
477477
|:-------------------------|:------------|
478-
| store/option/updated | Fires when you edit attributes for a local or shared variant option, including its display name and option values. Updates to the global store and channel locale as an override triggers the webhook. The `context` fields are present for only override updates. |
478+
| store/option/updated | Fires when you edit attributes for a local or shared variant option, including its display name and option values. Updates to the global store and channel locale as an override triggers the webhook.<br /><br />The `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview. |
479479

480480
The payload object takes the form that follows:
481481

@@ -804,7 +804,7 @@ Consult the [product assignment section of the Channel Webhooks Guide](/docs/int
804804
| store/product/* | Fires for all store/product events. |
805805
| store/product/deleted| Fires when a product is deleted.|
806806
| store/product/created | Fires when a new product is created. |
807-
| store/product/updated | Fires when you edit product attributes globally or for a channel locale as an override. For a full list of product fields that trigger an updated event, see the [product updated events](#product-update-events) that follow. The `context` fields are present for only override updates. |
807+
| store/product/updated | Fires when you edit product attributes globally or for a channel locale as an override. For a full list of product fields that trigger an updated event, see the [product updated events](#product-update-events) that follow.<br /><br />The `properties` and `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview. |
808808
| store/product/inventory/updated | Fires when inventory levels change for a _base product_. For products without variants, the webhook fires regardless of how you track inventory. <br /><br />For products with variants, the webhook only fires when the product's inventory properties are configured to track by _product_ and the _product-level_ inventory changes. <br /><br />Inventory updates made in the control panel and by API trigger the webhook. This includes changes made by apps. In the control panel, you can bulk import inventory updates or make inventory updates to single products on the **Products > View** page. |
809809
| store/product/inventory/order/updated | Fires when _base product_ inventory levels change in response to the order-related events configured in [Inventory settings](/docs/rest-management/settings/inventory#get-inventory-settings). For example, stock levels can change when you either place or complete/ship an order. Stock levels can also change when an order status changes to cancelled or refunded, but not partially refunded. Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). The settings for a channel apply when inventory changes through an order in a channel.<br /><br />The webhook always fires for products without variants. For products with variants, the webhook only fires when you configure the product's inventory properties to track by _product_. |
810810
| store/product/metafield/* | Fires for all store/product/metafield events. |

docs/webhooks/callbacks/_all.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,13 +272,13 @@ properties:
272272
allOf:
273273
- $ref: https://raw.githubusercontent.com/bigcommerce/docs/main/docs/webhooks/callbacks/store_metafield_updated.yml
274274
store/modifier/updated:
275-
description: Fires when product modifier overrides are edited.
275+
description: Fires when product modifier are edited. The `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.
276276
type: object
277277
properties:
278278
allOf:
279279
- $ref: https://raw.githubusercontent.com/bigcommerce/docs/main/docs/webhooks/callbacks/store_modifier_updated.yml
280280
store/option/updated:
281-
description: Fires when product options overrides are edited.
281+
description: Fires when product options are edited. The `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.
282282

283283
type: object
284284
properties:
@@ -401,7 +401,7 @@ properties:
401401
allOf:
402402
- $ref: https://raw.githubusercontent.com/bigcommerce/docs/main/docs/webhooks/callbacks/store_product_metafield_updated.yml
403403
store/product/updated:
404-
description: Fires when product details are edited. `attributes` and `context` fields are present for only override updates. For a full list of product fields that trigger an updated event, see the product updated events that follow.
404+
description: Fires when product details are edited. The `properties` and `context` fields are present for only updates to overrides, not the global store. For a full list of product fields that trigger an updated event, see the product updated events that follow. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.
405405
type: object
406406
properties:
407407
allOf:

docs/webhooks/callbacks/store_modifier_updated.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ type: object
22
properties:
33
store/modifier/updated:
44
description: |
5-
Fires when you edit attributes for a local or shared modifier. Updates to the global store and channel locale as an override triggers the webhook. The `context` fields are present for only override updates.
5+
Fires when you edit attributes for a local or shared modifier. Updates to the global store and channel locale as an override triggers the webhook. The `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.
66
77
For shared modifiers, the maximum number of product IDs in a payload is 100. If a shared modifier is assigned to more than 100 products, the payload includes a link to the API so you can query all the event data.
88
type: object

docs/webhooks/callbacks/store_option_updated.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ type: object
22
properties:
33
store/option/updated:
44
description: |
5-
Fires when you edit attributes for a local or shared variant option. Updates to the global store and channel locale as an override triggers the webhook. The `context` fields are present for only override updates.
5+
Fires when you edit attributes for a local or shared variant option. Updates to the global store and channel locale as an override triggers the webhook. The `context` fields are present for only updates to overrides, not the global store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.
66
77
For shared options, the maximum number of product IDs in a payload is 100. If a shared modifier is assigned to more than 100 products, the payload includes a link to the API so you can query all the event data.
88
type: object

docs/webhooks/callbacks/store_product_updated.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ properties:
44
description: |
55
Fires when you edit product attributes globally or for a channel locale as an override. For a full list of product fields that trigger an updated event, see the product updated events that follow.
66
7-
The `context` fields are present for only override updates.
7+
The `properties` and `context` fields are present for only updates to overrides, not global updates for the store. For information on updating overrides, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.
88
type: object
99
properties:
1010
scope:
@@ -16,7 +16,8 @@ properties:
1616
properties:
1717
type:
1818
type: string
19-
enum: product
19+
enum:
20+
- product
2021
id:
2122
type: integer
2223
properties:

0 commit comments

Comments
 (0)