diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index f9c57562d..a6d88e506 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1111,7 +1111,8 @@ paths: type: string - name: product_id in: query - description: 'A comma-separated list of IDs of products whose variants were requested. For example:`?product_id=:id``?product_id:in=77,80,81`' + description: |- + A comma-separated list of IDs of products whose variants were requested. For example:`?product_id:in=77,80,81` schema: type: string responses: diff --git a/reference/pages.v3.yml b/reference/pages.v3.yml index bcf6a2943..853d3354c 100644 --- a/reference/pages.v3.yml +++ b/reference/pages.v3.yml @@ -632,7 +632,7 @@ components: Include a header parameter called `X-Auth-Token` and pass it the `access_token` provided with your store API account or generated with your app's `/auth` callback. - ```http title="Security header example" + ```http filename="Security header example" X-Auth-Token: example_access_token ``` diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index c30bd7a3c..970c65c54 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -2786,7 +2786,7 @@ components: description: The price list with which the price record is associated. Either `variant_id` or `sku` is required. sku: type: string - description: The SKU for the variant with which this price record is associated. Either `sku`` or `variant_id is required. + description: The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required. currency: type: string description: The 3-letter country code with which this price record is associated. @@ -2863,10 +2863,10 @@ components: description: The Price List with which this price record is associated. variant_id: type: integer - description: The variant with which this price record is associated. Either `variant_id`` or `sku` is required. + description: The variant with which this price record is associated. Either `variant_id` or `sku` is required. sku: type: string - description: The variant with which this price record is associated. Either `sku`` or `variant_id`` is required. + description: The variant with which this price record is associated. Either `sku` or `variant_id` is required. currency: type: string description: The 3-letter currency code with which this price set is associated. diff --git a/reference/shipping.v2.yml b/reference/shipping.v2.yml index ca760bc1f..cf585cd16 100644 --- a/reference/shipping.v2.yml +++ b/reference/shipping.v2.yml @@ -2111,7 +2111,6 @@ components: title: Shipping Provider type: string enum: - - '``' - fedex - auspost - canadapost diff --git a/reference/webhooks.v3.yml b/reference/webhooks.v3.yml index c1dc0237b..7b3465e18 100644 --- a/reference/webhooks.v3.yml +++ b/reference/webhooks.v3.yml @@ -696,7 +696,7 @@ components: Cart creation also fires the `store/cart/updated` webhook. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -748,7 +748,7 @@ components: * Quantity * Item Price - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -789,7 +789,7 @@ components: Fires when a cart is deleted. Carts are deleted in two ways; when all items are removed from a cart, and when an API consumer explicitly removes the cart using a `DELETE` request. Cart deletion ends the cart lifecycle. The `store/cart/updated` webhook also fires when the last item is removed. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -829,7 +829,7 @@ components: description: |- Fires when a new coupon code is applied to a cart. The webhook request body includes the ID of the coupon code. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -875,7 +875,7 @@ components: This webhook fires after a cart is abandoned. BigCommerce considers a cart abandoned when it has no activity for at least one hour. This webhook is available for all store plans, regardless of whether the Abandoned Cart Saver feature is enabled. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -919,7 +919,7 @@ components: Fires when a cart/checkout is converted into an order, which is typically after the checkout payment step on the storefront. At this point, the cart is automatically deleted and no longer accessible. This webhook returns both the cart/checkout ID and order ID for correlation purposes. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -964,7 +964,7 @@ components: description: |- This webhook subscribes to all cart line item events. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1005,7 +1005,7 @@ components: description: |- Fires when a new item is added to the cart. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1054,7 +1054,7 @@ components: * Quantity * Item Price - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1099,7 +1099,7 @@ components: description: |- Fires when an item is deleted from the cart. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1154,7 +1154,7 @@ components: description: |- Fires when a category is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1198,7 +1198,7 @@ components: * Enable Google Shopping - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1237,7 +1237,7 @@ components: description: |- Fires when a category is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1284,7 +1284,7 @@ components: description: |- Fires when a channel is created in the control panel or by API. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1335,7 +1335,7 @@ components: * config_meta - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1386,7 +1386,7 @@ components: description: |- Fires when a new customer is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1429,7 +1429,7 @@ components: This webhook is triggered when a customer is updated. In addition, this webhook is triggered when a shopper initially enters custom form field values within the account sign-up form. Please note that neither changing existing data in customer form fields nor changing a customer's address will trigger the webhook. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1471,7 +1471,7 @@ components: description: |- This webhook is triggered when a customer is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1512,7 +1512,7 @@ components: description: |- Fires when a customer address is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1562,7 +1562,7 @@ components: description: |- Fires when a customer address is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1612,7 +1612,7 @@ components: description: |- Fires when a customer address is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1662,7 +1662,7 @@ components: description: |- Fires when a customer default payment instrument is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1708,7 +1708,7 @@ components: description: |- This webhook is triggered when an order is created in the control panel, using an app, or by API. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1769,7 +1769,7 @@ components: * Release Date * Remove pre-order status on this date - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1810,7 +1810,7 @@ components: description: |- Fires when an order is archived. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1850,7 +1850,7 @@ components: description: |- This webhook is triggered when an order status changes; for example, from `Pending` to `Awaiting Payment`. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1905,7 +1905,7 @@ components: description: |- This webhook is triggered when an order message is created by a customer or in the control panel. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -1955,7 +1955,7 @@ components: description: |- This webhook is triggered when a refund is submitted against an order. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2010,7 +2010,7 @@ components: description: |- This webhook is triggered when a product is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2051,7 +2051,7 @@ components: description: |- Fires when a new product is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2144,7 +2144,7 @@ components: * Product Files * Customs Information - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2193,7 +2193,7 @@ components: * Inventory Low Stock - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2261,7 +2261,7 @@ components: Changes to the following fields trigger this event: * Quantity - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2331,7 +2331,7 @@ components: description: |- Fires when a shipment is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2379,7 +2379,7 @@ components: Changes to the following fields trigger this event: * Shipping Tracking Number - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2424,7 +2424,7 @@ components: description: |- This webhook is triggered when a shipment is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2474,7 +2474,7 @@ components: description: |- This webhook is triggered when a new SKU is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2529,7 +2529,7 @@ components: description: |- Fires when a SKU is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2584,7 +2584,7 @@ components: description: |- Fires when a SKU is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2639,7 +2639,7 @@ components: description: |- Fires when a SKU is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2712,7 +2712,7 @@ components: Changes to the following fields trigger this event: * Quantity - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2782,7 +2782,7 @@ components: description: |- Fires when a client store is canceled and uninstalled from the platform. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2825,7 +2825,7 @@ components: * Email * Phone - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2865,7 +2865,7 @@ components: description: |- Fires when a subscriber is created. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2905,7 +2905,7 @@ components: description: |- The webhook fires when a subscriber is updated. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646", @@ -2945,7 +2945,7 @@ components: description: |- This webhook is triggered when a subscriber is deleted. - ```json title="Example callback object" lineNumbers + ```json filename="Example callback object" showLineNumbers { "created_at": 1561482670, "store_id": "1025646",