Skip to content

Commit

Permalink
DEVDOCS-6159 - Improve accuracy of attributes that trigger a product/…
Browse files Browse the repository at this point in the history
…updated webhook (#686)

Updated list to reflect all attributes that trigger the webhook.

<!-- Ticket number or summary of work -->
# [DEVDOCS-6159]


## What changed?
Documentation:
https://developer.bigcommerce.com/docs/integrations/webhooks/events#product-update-events
* Is Featured was removed (duplicate)
* SKU was added
* Weight was added
* Condition nested list was added
* Condition Visibility was added
* Pricing nested list was added
* Cost Price was added
* Retail Price was added
* Sale Price was added
* Is Price Hidden was added
* Price-hidden Label was added
* Tax Price was changed to Tax Class
* Inventory was removed
* Inventory nested list was added
* Inventory Tracking was added
* Current Stock Level (only if Inventory Tracking is enabled) was added
* Number of Reviews was added
* Shipping Details nested list was added
* Fixed Shipping Price was added
* Is Free Shipping was added
* Related Products was added
* Template Layout File was added
* Availability nested list was added
* Availability Description was added
* Preorder nested list was added
* Is Preorder Only was added
* UPC/EAN was added
* Order Quantity Minimum was added
* Order Quantity Maximum was added
* Open Graph nested list was added
* Type was added into Open Graph
* Title was added into Open Graph
* Description was added into Open Graph
* Use Product Name was added into Open Graph
* Use Meta Description was added into Open Graph
* Use Image was added into Open Graph

## Release notes draft
* Re-work for the Product Update Events documentation to be more
explicit about product attributes.

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {@bc-traciporter}


[DEVDOCS-6159]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6159?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: Traci Porter <[email protected]>
  • Loading branch information
Lucki2501 and bc-traciporter authored Dec 17, 2024
1 parent eeea69c commit 3477c65
Showing 1 changed file with 45 additions and 11 deletions.
56 changes: 45 additions & 11 deletions docs/integrations/webhooks/events/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -861,29 +861,63 @@ Payload objects with the following scopes take the form that follows:

A change to any of the following fields triggers a `store/product/updated` event:

* Availability
* Category
* Brand
* Condition
* Availability:
* Availability
* Availability Description
* Categories
* Brand ID
* Condition:
* Condition
* Is Condition Shown
* Description
* Dimensions
* Featured
* Inventory
* Dimensions:
* Depth
* Height
* Width
* Inventory:
* Inventory Tracking
* Inventory Level (only if Inventory Tracking is enabled)
* Is Featured
* Meta Description
* Modifier - deleted
* Name
* Number Sold
* Order Quantity Minimum
* Order Quantity Maximum
* Open Graph:
* Type
* Title
* Description
* Use Product Name
* Use Meta Description
* Use Image
* Page Title
* Pre-order Message
* Price
* Pre-order:
* Is Preorder Only
* Preorder Message
* Pricing:
* Price
* Cost Price
* Retail Price
* Sale Price
* Is Price Hidden
* Price-hidden Label
* Product Type
* Related Products
* Review Count
* Search Keywords
* Shipping Details:
* Fixed Cost Shipping Price
* Is Free Shipping
* SKU
* Sort Order
* Tax Price
* Tax Class ID
* Layout File
* Thumbnail - new images only*
* Total Sold
* UPC
* Visibility
* Warranty
* Weight

A change to the following field triggers the `store/product/updated` event only if the change is made for a _channel locale_. For more information, see the [International Enhancements for Multi-Storefront](/docs/store-operations/catalog/msf-international-enhancements) overview.

Expand Down

0 comments on commit 3477c65

Please sign in to comment.