Merge branch 'main' into revert-712-DEVDOCS-4028-1

bigcommerce · Dec 23, 2024 · f5406d6 · f5406d6
2 parents b91c0af + 3ee14f8
commit f5406d6
Show file tree

Hide file tree

Showing 7 changed files with 335 additions and 33 deletions.
diff --git a/docs/integrations/webhooks/events/index.mdx b/docs/integrations/webhooks/events/index.mdx
@@ -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.  
 

diff --git a/docs/storefront/cart-checkout/guide/add-to-cart-url.mdx b/docs/storefront/cart-checkout/guide/add-to-cart-url.mdx
@@ -26,6 +26,7 @@ URLs constructed with these parameters allow you to:
 
 Below is a table of common scenarios and example URLs.
 
+
 | **Scenario**                                                 | **URL**                                                              |
 |--|-|
 | Select a specific SKU on Product Detail page                 |`https://{{domain}}/{{page}}?sku={{sku}}`                             |
@@ -34,6 +35,10 @@ Below is a table of common scenarios and example URLs.
 | Add product to cart by product id and set quantity           |`https://{{domain}}/cart.php?action=add&product_id={{id}}&qty={{qty}}`|
 | Add product to cart and set coupon code                      |`https://{{domain}}/cart.php?action=add&product_id={{id}}&couponcode={{code}}`          |
 
+ <Callout type="info">
+  It is required to have a product ID or a sku within the URL to add a coupon code.
+ </Callout>
+
 Once constructed, a URL can be inserted directly as text or as an HTML link:
 
 ```html showLineNumbers copy

diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml
@@ -2665,6 +2665,10 @@ components:
           type: number
           format: double
           readOnly: true
+        display_name:
+          type: string
+          description: Display name of the coupon.
+          example: 20% Off
       required:
         - code
     AppliedDiscount:

diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml
@@ -284,8 +284,11 @@ paths:
         Adds a new *Consignment* to *Checkout*.
 
         Perform the following two steps to define the fulfillment of the items in the cart.
-        ### For **shipping** consignments:
+        
+        ### For shipping consignments:
+        
           1. Add a new Consignment to Checkout.
+          
               * Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs.
               * Provide a full valid customer address before placing the order. If provided, the order placement will succeed. 
               * As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response.
@@ -296,8 +299,10 @@ paths:
               
           2. Update the Consignment with Shipping Options using the [REST Storefront API](/docs/rest-storefront/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).
                 
-        ### For **pickup** consignments:
-          1. Create a new consignment object. 
+        ### For pickup consignments:
+        
+          Create a new consignment object. 
+          
               - Send a `POST` request to `/consignments` with line item IDs and quantities.
               - Provide a `pickupMethodId`. This is the `id` of the Pickup Method provided in the response body of the Storefront Pickup Options API.
               - Required Fields:
@@ -1102,7 +1107,7 @@ components:
           description: the coupon code
         displayName:
           type: string
-          description: The coupon title based on different types provided in control panel section.
+          description: The coupon name displayed on the storefront.
         couponType:
           type: string
           description: Key name to identify the type of coupon.
@@ -1131,7 +1136,7 @@ components:
           description: the coupon code
         displayName:
           type: string
-          description: The coupon title based on different types provided in control panel section.
+          description: The coupon name displayed on the storefront.
         couponType:
           type: integer
           description: |-