From cc6a25a687dbfac102df7380e971619178929fe5 Mon Sep 17 00:00:00 2001 From: Tom Arbesser-Rastburg Date: Sat, 28 Mar 2026 12:16:34 +1100 Subject: [PATCH] DEVDOCS-6658 Fix various issues in integrations docs --- .../apps/guide/best-practices.mdx | 2 +- .../buy-online-pick-up-in-store/api-guide.mdx | 24 ++++++++--------- .../end-to-end-guide/configuration.mdx | 26 +++++++++---------- .../guide/extending-existing-apps.mdx | 2 +- .../channels/guide/requirements.mdx | 2 +- docs/integrations/hosted-analytics.mdx | 2 +- docs/integrations/subscriptions.mdx | 2 +- .../webhooks/https-webhook-overview.mdx | 2 +- 8 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/integrations/apps/guide/best-practices.mdx b/docs/integrations/apps/guide/best-practices.mdx index 2e3bffdf4..bd8ddd5f1 100644 --- a/docs/integrations/apps/guide/best-practices.mdx +++ b/docs/integrations/apps/guide/best-practices.mdx @@ -21,7 +21,7 @@ Review the following best practices before submitting your app to the [App Marke * Provide mechanisms that make it easy for end-users to confirm the authenticity of your app. * Implement CSRF protection on redirect URI. -For details, see [Security Considerations in RC6749](https://tools.ietf.org/html/rfc6749#section-10). For a list of the top web application security risks and best practices to avoid them, see [OWASP Top Ten](https://owasp.org/www-project-top-ten/). +For details, see [Security Considerations in RFC 6749](https://tools.ietf.org/html/rfc6749#section-10). For a list of the top web application security risks and best practices to avoid them, see [OWASP Top Ten](https://owasp.org/www-project-top-ten/). ## API requests diff --git a/docs/integrations/buy-online-pick-up-in-store/api-guide.mdx b/docs/integrations/buy-online-pick-up-in-store/api-guide.mdx index e2824bf99..0ee2fadb9 100644 --- a/docs/integrations/buy-online-pick-up-in-store/api-guide.mdx +++ b/docs/integrations/buy-online-pick-up-in-store/api-guide.mdx @@ -86,7 +86,7 @@ You start by first creating a location. Customers can pick up their orders from "state": "TX", "zip": "78726", "country_code": "US", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -97.849560, "latitude": 30.404500 @@ -113,7 +113,7 @@ You start by first creating a location. Customers can pick up their orders from ```json filename="Example response: Create locations" showLineNumbers copy { - "transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efbv" + "transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efb0" } ``` @@ -173,7 +173,7 @@ Once a location has been created, you may choose to update its details. "state": "TX", "zip": "78726", "country_code": "US", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -97.849560, "latitude": 30.404500 @@ -200,7 +200,7 @@ Once a location has been created, you may choose to update its details. ```json filename="Example response: Update locations" showLineNumbers copy { - "transaction_id": "d3f9c9df-8d35-403c-8f9f-d1v1b3302efbv" + "transaction_id": "d3f9c9df-8d35-403c-8f9f-d1a1b3302efb0" } ``` @@ -281,11 +281,11 @@ At this point, you may have created multiple locations and want to check on all "state": "TX", "zip": "78726", "email": "jane.doe@bigcommerce.com", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -97.849560, "latitude": 30.404500 - } + }, "country_code": "US" }, "storefront_visibility": true, @@ -303,7 +303,7 @@ At this point, you may have created multiple locations and want to check on all }, { "id": 3, - "code": "UPTOWN_MAYFAIR)LANE", + "code": "UPTOWN_MAYFAIR_LANE", "label": "Uptown Location - Mayfair Lane", "description": "Customer-facing additional details about this location.", "managed_by_external_source": false, @@ -356,11 +356,11 @@ At this point, you may have created multiple locations and want to check on all "state": "TX", "zip": "78726", "email": "jane.doe@bigcommerce.com", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -120.123456, "latitude": 60.987654 - } + }, "country_code": "US" }, "storefront_visibility": true, @@ -541,7 +541,7 @@ You can make relative adjustments for inventory tracked by variant. ```json filename="Example response: Relative adjustment to inventory" showLineNumbers copy { - "transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efbv" + "transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efb0" } ``` @@ -687,7 +687,7 @@ At this point you may want to view inventory by location. "variant_id": 79, "product_id": 112 }, - "available_to_sell": , + "available_to_sell": 5, "total_inventory_onhand": 5, "settings": { "safety_stock": 0, @@ -916,7 +916,7 @@ Once you have assigned the pickup methods to the location(s), you can check what "collection_instructions": "See our staff member outside of the store", "collection_time_description": "Wait for a pickup confirmation and visit in business hours" } - ] + ], "meta": {} } ``` diff --git a/docs/integrations/buy-online-pick-up-in-store/end-to-end-guide/configuration.mdx b/docs/integrations/buy-online-pick-up-in-store/end-to-end-guide/configuration.mdx index 6b24620fd..db37b7589 100644 --- a/docs/integrations/buy-online-pick-up-in-store/end-to-end-guide/configuration.mdx +++ b/docs/integrations/buy-online-pick-up-in-store/end-to-end-guide/configuration.mdx @@ -72,7 +72,7 @@ Create one or more locations using the [Create locations](/docs/rest-management/ "state": "TX", "zip": "78726", "country_code": "US", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -97.849560, "latitude": 30.404500 @@ -99,7 +99,7 @@ Create one or more locations using the [Create locations](/docs/rest-management/ ```json filename="Example response: Create locations" showLineNumbers copy { - "transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efbv" + "transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efb0" } ``` @@ -159,7 +159,7 @@ After you create a location, you can update its details using the [Update locati "state": "TX", "zip": "78726", "country_code": "US", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -97.849560, "latitude": 30.404500 @@ -186,7 +186,7 @@ After you create a location, you can update its details using the [Update locati ```json filename="Example response: Update locations" showLineNumbers copy { - "transaction_id": "d3f9c9df-8d35-403c-8f9f-d1v1b3302efbv" + "transaction_id": "d3f9c9df-8d35-403c-8f9f-d1a1b3302efb0" } ``` @@ -267,11 +267,11 @@ After you create one or more locations, use the [Get locations](/docs/rest-manag "state": "TX", "zip": "78726", "email": "jane.doe@bigcommerce.com", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -97.849560, "latitude": 30.404500 - } + }, "country_code": "US" }, "storefront_visibility": true, @@ -289,7 +289,7 @@ After you create one or more locations, use the [Get locations](/docs/rest-manag }, { "id": 3, - "code": "UPTOWN_MAYFAIR)LANE", + "code": "UPTOWN_MAYFAIR_LANE", "label": "Uptown Location - Mayfair Lane", "description": "Customer-facing additional details about this location.", "managed_by_external_source": false, @@ -342,11 +342,11 @@ After you create one or more locations, use the [Get locations](/docs/rest-manag "state": "TX", "zip": "78726", "email": "jane.doe@bigcommerce.com", - "phone": "+15128654500", + "phone": "+15125550100", "geo_coordinates": { "longitude": -120.123456, "latitude": 60.987654 - } + }, "country_code": "US" }, "storefront_visibility": true, @@ -377,7 +377,7 @@ _Buy Online, Pick up in Store_ uses the [Inventory API](/docs/rest-management/in * **Relative quantity** adjusts a product or variant's inventory quantity by adding to or subtracting from the existing quantity. Before setting inventory quantity to a location, check the inventory tracking configurations that have been enabled. There are three inventory tracking configurations: -* **Inventory is tracked by product** - This setting is used if your product has no variations. For example, champagne glasses or . +* **Inventory is tracked by product** - This setting is used if your product has no variations. For example, champagne glasses or coffee mugs. * **Inventory is tracked by variant** - This setting is used if your product has different attributes (variations), e.g. a shirt has various sizes and colors. * **Inventory is not tracked** - This setting is used if you do not have a need to track inventory quantity, e.g. you may sell a digital asset like a PDF or digital music title. When inventory is not tracked, the product will always be considered available to sell on your storefront, even if it may not be in your physical storage location. @@ -528,7 +528,7 @@ You can also make relative adjustments to inventory tracked by variant. ```json filename="Example response: Relative adjustment to inventory" showLineNumbers copy { - "transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efbv" + "transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efb0" } ``` @@ -676,7 +676,7 @@ At this point you may want to view inventory by location. To do so, send a reque "variant_id": 79, "product_id": 112 }, - "available_to_sell": , + "available_to_sell": 5, "total_inventory_onhand": 5, "settings": { "safety_stock": 0, @@ -908,7 +908,7 @@ Once you have assigned the pickup methods to the location(s), you can check what "collection_instructions": "See our staff member outside the store.", "collection_time_description": "Wait for a pickup confirmation and visit during business hours." } - ] + ], "meta": {} } ``` diff --git a/docs/integrations/channels/guide/extending-existing-apps.mdx b/docs/integrations/channels/guide/extending-existing-apps.mdx index 64f4fe291..864063082 100644 --- a/docs/integrations/channels/guide/extending-existing-apps.mdx +++ b/docs/integrations/channels/guide/extending-existing-apps.mdx @@ -145,4 +145,4 @@ For a high-level overview and more information on Channels Toolkit, see [Channel ### Endpoints - [Channels API Reference](/docs/rest-management/channels) -- [Sites and Rites API Reference](/docs/rest-management/sites) +- [Sites and Routes API Reference](/docs/rest-management/sites) diff --git a/docs/integrations/channels/guide/requirements.mdx b/docs/integrations/channels/guide/requirements.mdx index 8f46b0553..208fbe7a6 100644 --- a/docs/integrations/channels/guide/requirements.mdx +++ b/docs/integrations/channels/guide/requirements.mdx @@ -56,4 +56,4 @@ All Partners: ### Endpoints - [Channels API Reference](/docs/rest-management/channels) -- [Sites and Rites API Reference](/docs/rest-management/sites) +- [Sites and Routes API Reference](/docs/rest-management/sites) diff --git a/docs/integrations/hosted-analytics.mdx b/docs/integrations/hosted-analytics.mdx index 22b7ff3e6..3e7a3eae4 100644 --- a/docs/integrations/hosted-analytics.mdx +++ b/docs/integrations/hosted-analytics.mdx @@ -139,7 +139,7 @@ When the shopper clicks a button to remove a product from the cart, the followin | `event_id` | string | Unique ID for each event instance. | Unique event ID generated by BigCommerce. | | `product_value` | number | Item price multiplied by quantity. Product default price or, if applicable, the sale price configured in the admin panel, before discounts and coupons are applied. | [Get a cart](/docs/rest-storefront/carts#get-a-cart)
`lineItems.physicalItems.listPrice` or
`lineItems.digitalItems.listPrice`| | `channel_id` | string | The BigCommerce channel ID. Channel ID of the channel where checkout is taking place. | [Get all channels](/docs/rest-management/channels#get-all-channels)
`data.id` | -| `currency` | string | [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html) of the order. | [Get a checkout](/docs/rest-storefront/checkouts#gset-a-checkout)
`data.cart.currency.code` | +| `currency` | string | [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html) of the order. | [Get a checkout](/docs/rest-storefront/checkouts#get-a-checkout)
`data.cart.currency.code` | | `line_items[]` | array of `line_item` objects | Items removed from the cart. | See [line_item](#line_item-object-schema) object for event fields | ### Start checkout diff --git a/docs/integrations/subscriptions.mdx b/docs/integrations/subscriptions.mdx index 730727bc2..a7a73fe11 100644 --- a/docs/integrations/subscriptions.mdx +++ b/docs/integrations/subscriptions.mdx @@ -252,7 +252,7 @@ To use an alternate SQL database (e.g., SQLite), complete the following steps: 1. Update the `/prisma/schema.prisma` file with a `provider` other than `Postgresql`. For a list of options, read [Prisma's reference docs](https://www.prisma.io/docs/concepts/components/prisma-schema/data-sources). ``` -databse db { +datasource db { provider = "sqlite" url = env("DATABASE_URL") ``` diff --git a/docs/integrations/webhooks/https-webhook-overview.mdx b/docs/integrations/webhooks/https-webhook-overview.mdx index 0fac53dbe..135fd2c7c 100644 --- a/docs/integrations/webhooks/https-webhook-overview.mdx +++ b/docs/integrations/webhooks/https-webhook-overview.mdx @@ -20,7 +20,7 @@ Accept: application/json "destination": "https://yourapp.example.com/webhooks", // custom ports are not supported "is_active": true, "headers": { - "username": "My-Custom-Header" + "username": "My-Custom-Header", "value": "My custom header value" } }