From d3a3167021d800df02259cad4da2014cb53307c0 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Fri, 20 Oct 2023 12:22:36 -0500 Subject: [PATCH 01/11] replace links v1 --- reference/abandoned_cart_emails.v3.yaml | 4 ++-- reference/abandoned_carts.v3.yml | 4 ++-- reference/carts.sf.yml | 4 ++-- reference/carts.v3.yml | 4 ++-- reference/catalog/brands_catalog.v3.yml | 6 +++--- reference/catalog/categories_catalog.v3.yml | 8 ++++---- reference/catalog/category-trees_catalog.v3.yml | 6 +++--- reference/catalog/product-modifiers_catalog.v3.yml | 6 +++--- .../catalog/product-variant-options_catalog.v3.yml | 6 +++--- reference/catalog/product-variants_catalog.v3.yml | 6 +++--- reference/catalog/products_catalog.v3.yml | 8 ++++---- reference/channels.v3.yml | 10 +++++----- reference/checkouts.sf.yml | 8 ++++---- reference/checkouts.v3.yml | 8 ++++---- reference/consent.sf.yml | 4 ++-- reference/currencies.v2.yml | 6 +++--- reference/current_customer.yml | 4 ++-- reference/custom-template-associations.v3.yml | 6 +++--- reference/customer_login.yml | 4 ++-- reference/customers.sf.yml | 2 +- reference/customers.v2.yml | 10 +++++----- reference/customers.v3.yml | 6 +++--- reference/email_templates.v3.yml | 4 ++-- reference/form_fields.sf.yml | 2 +- reference/geography.v2.yml | 4 ++-- reference/marketing.v2.yml | 4 ++-- reference/orders.sf.yml | 2 +- reference/orders.v2.oas2.yml | 8 ++++---- reference/orders.v3.yml | 4 ++-- reference/payments/accepted-methods_payments.v3.yml | 8 ++++---- reference/payments/access-tokens_payments.v3.yml | 8 ++++---- reference/payments/methods_payments.v2.yml | 8 ++++---- reference/payments/process_payments.yml | 6 +++--- reference/price_lists.v3.yml | 8 ++++---- reference/pricing.sf.yml | 4 ++-- reference/redirects.v3.yml | 4 ++-- reference/scripts.v3.yml | 6 +++--- reference/settings.v3.yml | 4 ++-- reference/shipping.v2.yml | 4 ++-- reference/shipping.v3.yml | 6 +++--- reference/shipping_provider.yml | 2 +- reference/sites.v3.yml | 8 ++++---- reference/store_content.v2.yml | 4 ++-- reference/store_information.v2.yml | 4 ++-- reference/store_logs.v3.yml | 4 ++-- reference/storefront_tokens.v3.yml | 6 +++--- reference/subscribers.v3.yml | 4 ++-- reference/subscriptions.sf.yml | 6 +++--- reference/tax.v3.yml | 6 +++--- reference/tax_classes.v2.yml | 4 ++-- reference/tax_properties.v3.yml | 4 ++-- reference/tax_provider.yml | 2 +- reference/tax_rates_zones.v3.yml | 4 ++-- reference/tax_settings.v3.yml | 4 ++-- reference/themes.v3.yml | 4 ++-- reference/webhooks.v3.yml | 8 ++++---- reference/widgets.v3.yml | 12 ++++++------ reference/wishlists.v3.yml | 4 ++-- 58 files changed, 157 insertions(+), 157 deletions(-) diff --git a/reference/abandoned_cart_emails.v3.yaml b/reference/abandoned_cart_emails.v3.yaml index eb8a5efc4..55cf61f01 100644 --- a/reference/abandoned_cart_emails.v3.yaml +++ b/reference/abandoned_cart_emails.v3.yaml @@ -506,7 +506,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -514,7 +514,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/abandoned_carts.v3.yml b/reference/abandoned_carts.v3.yml index 96fbecec9..e7cca1669 100644 --- a/reference/abandoned_carts.v3.yml +++ b/reference/abandoned_carts.v3.yml @@ -336,7 +336,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -344,7 +344,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/carts.sf.yml b/reference/carts.sf.yml index 47bbf9a4b..7bde363e3 100644 --- a/reference/carts.sf.yml +++ b/reference/carts.sf.yml @@ -5,7 +5,7 @@ info: description: |- Manage cart operations and data using frontend JavaScript on BigCommerce Stencil-powered storefronts. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). servers: @@ -164,7 +164,7 @@ paths: description: |- Updates a *Cart* line item. Updates an existing, single line item quantity and the price of custom items in a cart. - If a modified product or variant needs to be changed or updated, you can remove and re-add the product to the cart with the correct variants using the [Delete Cart Line Item](/docs/rest-storefront/carts/cart-items#delete-cart-line-item) and the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoints. You can also use carts mutations that are part of the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout). + If a modified product or variant needs to be changed or updated, you can remove and re-add the product to the cart with the correct variants using the [Delete Cart Line Item](/docs/rest-storefront/carts/cart-items#delete-cart-line-item) and the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoints. You can also use carts mutations that are part of the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). > #### Note diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 9b92b187a..2edaf200a 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3349,7 +3349,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -3357,6 +3357,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 6c56cea55..f28af6f09 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Brands description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Brands endpoints let you [create individual brands](/docs/rest-catalog/brands#create-a-brand) and [modify the brands](/docs/rest-catalog/brands#update-a-brand) associated with a store's products, along with [deleting brands](/docs/rest-catalog/brands#delete-a-brand). @@ -1902,7 +1902,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1910,6 +1910,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index cf1b78b3e..c346c2d14 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Categories description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Categories endpoints let you [create individual categories](/docs/rest-catalog/categories#create-a-category) and [modify categories](/docs/rest-catalog/categories#update-a-category) that organize a store's products, as well as [delete categories](/docs/rest-catalog/categories#delete-a-category). @@ -12,7 +12,7 @@ info: This API family also contains endpoints to [update product sort order](/docs/rest-catalog/categories/sort-order#update-product-sort-order) within a category. - These endpoints are primarily useful in applications for single storefront stores. To work with categories for an [MSF-enabled store](/api-docs/multi-storefront/overview), see [Category Trees](/docs/rest-catalog/category-trees). + These endpoints are primarily useful in applications for single storefront stores. To work with categories for an [MSF-enabled store](/docs/storefront/multi-storefront), see [Category Trees](/docs/rest-catalog/category-trees). > To learn more about authenticating Catalog endpoints, locate the **Authentication** section at the top of each endpoint, then click **Show Details**. @@ -2327,7 +2327,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2335,6 +2335,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/category-trees_catalog.v3.yml b/reference/catalog/category-trees_catalog.v3.yml index 6fa10f42b..19984ba3f 100644 --- a/reference/catalog/category-trees_catalog.v3.yml +++ b/reference/catalog/category-trees_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Category Trees description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Category Trees endpoints are the more modern and performant counterparts to the [Categories endpoints](/docs/rest-catalog/categories). Although the Category Trees endpoints and objects are designed to center an MSF-compatible, [multi-tenant category tree architecture](#categories), the endpoints work just as well in a single storefront context. @@ -1119,7 +1119,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1127,6 +1127,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/product-modifiers_catalog.v3.yml b/reference/catalog/product-modifiers_catalog.v3.yml index f86def38e..8e4b523f6 100644 --- a/reference/catalog/product-modifiers_catalog.v3.yml +++ b/reference/catalog/product-modifiers_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Product Modifiers description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Product Modifiers represent choices that the shopper can make to change how the merchant customizes or adds on to the product. Examples include shipping insurance, monograms, custom inseam length, and a color selection for an unfinished product. @@ -2825,7 +2825,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2833,6 +2833,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/product-variant-options_catalog.v3.yml b/reference/catalog/product-variant-options_catalog.v3.yml index 0c366ac94..171bcb37e 100644 --- a/reference/catalog/product-variant-options_catalog.v3.yml +++ b/reference/catalog/product-variant-options_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Product Variant Options description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Product Variant Options represent the different facets of a product. For example, size, color, fabric. Variant Option values are the actual sizes, colors, fabrics, that are available. [Product Variants]() consist of combinations of Variant Option values. @@ -2456,7 +2456,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2464,6 +2464,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index ae22eae88..323184d34 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Catalog - Product Variants description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). A Product Variant is a version of a product that has its own SKU. For example, a catalog might model a particular style of high-top sneakers that come in both red and blue as one product - high-tops - with two variants - red and blue. From a storefront point of view, Product Variants are often what shoppers seek. They are also the object that maps to SKUs and tracks inventory. A Product with one only Variant is a _base variant_. @@ -2415,7 +2415,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2423,6 +2423,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 9fcb84746..9612eb603 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -2,11 +2,11 @@ openapi: '3.0.3' info: title: Catalog - Products description: |- - > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/api-docs/store-management/catalog/products-overview). + > The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the [Catalog Overview](/docs/store-operations/catalog). Our Catalog Products endpoints let you [create products](/docs/rest-catalog/products#create-a-product), perform [batch operations on existing products](/docs/rest-catalog/products#update-products-batch) and work with [reviews](/docs/rest-catalog/products/reviews), [images](/docs/rest-catalog/products/images), and [videos](/docs/rest-catalog/products/videos). Note that after a product is created initially, you can manage the nuances of its variations using the [Product Modifier](/docs/rest-catalog/product-modifiers), [Product Variant](/docs/rest-catalog/product-variants), and [Product Variant Options](/docs/rest-catalog/product-variant-options) endpoints. - Other core product endpoints focus on [bulk pricing](/docs/rest-catalog/products/bulk-pricing-rules), [complex rules](/docs/rest-catalog/products/complex-rules), [custom fields](/docs/rest-catalog/products/custom-fields), and [metafields](/docs/rest-catalog/products/metafields). Product Variant objects also contain [their own metafields](/docs/rest-catalog/product-variants/metafields). For [MSF-enabled](/api-docs/multi-storefront/overview) stores, the product object also contains product [channel assignments](/docs/rest-catalog/products/channel-assignments) and [category assignments](/docs/rest-catalog/products/category-assignments); read more about [products in the MSF context](/api-docs/multi-storefront/api-guide#products). + Other core product endpoints focus on [bulk pricing](/docs/rest-catalog/products/bulk-pricing-rules), [complex rules](/docs/rest-catalog/products/complex-rules), [custom fields](/docs/rest-catalog/products/custom-fields), and [metafields](/docs/rest-catalog/products/metafields). Product Variant objects also contain [their own metafields](/docs/rest-catalog/product-variants/metafields). For [MSF-enabled](/docs/storefront/multi-storefront) stores, the product object also contains product [channel assignments](/docs/rest-catalog/products/channel-assignments) and [category assignments](/docs/rest-catalog/products/category-assignments); read more about [products in the MSF context](/api-docs/multi-storefront/api-guide#products). This API family also contains an endpoint to [Get a catalog summary](/docs/rest-catalog/products/summary). @@ -8709,7 +8709,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -8717,6 +8717,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index 801be2bae..a27f89cb9 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -8,7 +8,7 @@ info: email: support@bigcommerce.com title: Channels description: |- - Create and manage sales [channels](/api-docs/channels/overview), their [sites](/docs/rest-management/channels/channel-site), and their [product listings](/docs/rest-management/channels/channel-listings). + Create and manage sales [channels](/docs/integrations/channels), their [sites](/docs/rest-management/channels/channel-site), and their [product listings](/docs/rest-management/channels/channel-listings). ## Channels @@ -83,7 +83,7 @@ info: * [Sites and Routes API Reference](/docs/rest-management/sites) * [Building Channels Overview](/api-docs/channels/overview) * [Building Channel Apps](/api-docs/channels/building-channel-apps) - * [Channels Toolkit Reference](/api-docs/channels/channels-toolkit-reference) + * [Channels Toolkit Reference](/docs/integrations/channels/toolkit-reference) servers: - url: 'https://api.bigcommerce.com/stores/{store_hash}/v3' variables: @@ -2022,7 +2022,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2030,7 +2030,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -2313,7 +2313,7 @@ components: properties: id: type: integer - description: 'The unique `id` given to an app registered in [DevTools](https://devtools.bigcommerce.com/); used to create links to the app in channel manager. `app.id` is optional; however, if youʼre building an app that creates or manages a channel, we recommend including it to ensure the user interface in the control panel works properly. Select partners who are promoted in the Channel Manager must build an app, and include the app ID in the create channel request. [Learn how to find an Appʼs ID](/api-docs/apps/tutorials/id).' + description: 'The unique `id` given to an app registered in [DevTools](https://devtools.bigcommerce.com/); used to create links to the app in channel manager. `app.id` is optional; however, if youʼre building an app that creates or manages a channel, we recommend including it to ensure the user interface in the control panel works properly. Select partners who are promoted in the Channel Manager must build an app, and include the app ID in the create channel request. [Learn how to find an Appʼs ID](/docs/integrations/apps/guide/id).' sections: type: array description: 'Sections are now deprecated under config_meta. The new /channel-menus endpoints should be used instead. If set, when the app is loaded within the control panel, the navigation `sections` will be directly embedded in the control panel navigation.' diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index 2d2744bb0..11de704c8 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -5,7 +5,7 @@ info: Manage checkout operations and data using front-end JavaScript on BigCommerce Stencil-powered storefronts. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). version: '' @@ -373,7 +373,7 @@ paths: description: |- Updates a *Checkout Line Item*. Updates an existing, single line item in the cart. - If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout). + If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). > #### Note > * Substitute your storefront domain for `yourstore.example.com`. @@ -1211,7 +1211,7 @@ paths: * `pickupOption` * `lineItems` - To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/api-docs/storefront/tutorials/carts). + To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/docs/storefront/cart-checkout/guide/rest-storefront). > #### Note > * Substitute your storefront domain for `yourstore.example.com`. @@ -1379,7 +1379,7 @@ paths: * `shippingOptionId` or `pickupOptionId` * `lineItems` - To learn more about creating a Checkout Consignment see [Checkout Consignment API](/api-docs/checkouts/checkout-consignment). + To learn more about creating a Checkout Consignment see [Checkout Consignment API](/docs/storefront/cart-checkout/guide/consignments). > #### Note > * You cannot pass both an `address` and a `shippingOptionId` because the shipping option may not be available for the new address diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index dd397f98c..40a017825 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Checkouts description: |- - For more information on authenticating BigCommerce APIs, see [Authentication](/api-docs/getting-started/authentication). + For more information on authenticating BigCommerce APIs, see [Authentication](/docs/start/authentication). Create and manage checkouts from existing carts using BigCommerce checkout logic. version: '3.0' @@ -3934,7 +3934,7 @@ paths: description: |- Adds a new consignment to a checkout. - For more information about working with consignments, see [Checkout consignment](/api-docs/checkouts/checkout-consignment). + For more information about working with consignments, see [Checkout consignment](/docs/storefront/cart-checkout/guide/consignments). Though the only required `address` properties to create a consignment are `email` and `country_code`, to successfully [create an order](/docs/rest-management/checkouts/checkout-orders#create-an-order) the `address` requires the following properties: * `first_name` @@ -9700,7 +9700,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -9708,6 +9708,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/consent.sf.yml b/reference/consent.sf.yml index 010aa62dc..2838bfbb4 100644 --- a/reference/consent.sf.yml +++ b/reference/consent.sf.yml @@ -10,7 +10,7 @@ info: description: |- Specify shopper cookie consent preferences. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). version: Storefront @@ -73,7 +73,7 @@ components: 3 - Analytics 4 - Targeting; Advertising - For further definition of these categories, see [Scripts API](/api-docs/store-management/scripts). + For further definition of these categories, see [Scripts API](/docs/integrations/scripts). properties: allow: type: array diff --git a/reference/currencies.v2.yml b/reference/currencies.v2.yml index 2d1fffcde..df56be493 100644 --- a/reference/currencies.v2.yml +++ b/reference/currencies.v2.yml @@ -26,7 +26,7 @@ info: ## Resources - - [How Currencies Work](/api-docs/multi-currency/guide/how-currencies-work) + - [How Currencies Work](/docs/store-operations/currencies/guide) - [Price List API Reference](/docs/rest-management/price-lists) - [Using Price Lists (Help Center)](https://support.bigcommerce.com/s/article/Price-Lists) - [Managing Currencies (Help Center)](https://support.bigcommerce.com/s/article/Managing-Currencies-Beta) @@ -390,7 +390,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -398,6 +398,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/current_customer.yml b/reference/current_customer.yml index 4f36e79be..8c73ca11b 100644 --- a/reference/current_customer.yml +++ b/reference/current_customer.yml @@ -4,9 +4,9 @@ info: description: |- Identify logged-in customers securely via JavaScript. - [Learn more about the current customer API](/api-docs/customers/current-customer-api). + [Learn more about the current customer API](/docs/start/authentication/current-customer). - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#client-id). diff --git a/reference/custom-template-associations.v3.yml b/reference/custom-template-associations.v3.yml index d44236052..dcc5c6af1 100644 --- a/reference/custom-template-associations.v3.yml +++ b/reference/custom-template-associations.v3.yml @@ -109,7 +109,7 @@ info: * [Get Channel Active Theme](/docs/rest-management/channels/channel-active-theme#get-a-channel-active-theme) * [Get Available Custom Templates](/docs/rest-content/themes/theme-custom-templates#get-custom-templates) - * [Catalog API](/docs/rest-management/catalog) + * [Catalog API](/docs/rest-catalog) * [Pages API](/docs/rest-content/pages) * [Channels API](/docs/rest-management/channels) termsOfService: 'https://www.bigcommerce.com/terms' @@ -477,7 +477,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -485,6 +485,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/customer_login.yml b/reference/customer_login.yml index de2d3cc73..e5dae4306 100644 --- a/reference/customer_login.yml +++ b/reference/customer_login.yml @@ -4,9 +4,9 @@ info: description: |- Enable single sign-on for shoppers on BigCommerce hosted storefronts. - [Learn more about the customer login API](/api-docs/customers/customer-login-api). + [Learn more about the customer login API](/docs/start/authentication/customer-login). - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#user-generated-jwts). termsOfService: 'https://www.bigcommerce.com/terms' diff --git a/reference/customers.sf.yml b/reference/customers.sf.yml index 190877e28..8bfc5736c 100644 --- a/reference/customers.sf.yml +++ b/reference/customers.sf.yml @@ -5,7 +5,7 @@ info: description: |- Manage customers and data via front-end JavaScript on BigCommerce Stencil-powered storefronts. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). servers: diff --git a/reference/customers.v2.yml b/reference/customers.v2.yml index d5b5d7a17..2d80c74e1 100644 --- a/reference/customers.v2.yml +++ b/reference/customers.v2.yml @@ -2,7 +2,7 @@ openapi: '3.0.1' info: title: Customers V2 description: |- - Create and Manage Customers, Customer Addresses, and Customer Groups. Additionally, validate customer passwords. To learn more about Customers see [here](/api-docs/customers/customers-subscribers-overview). + Create and Manage Customers, Customer Addresses, and Customer Groups. Additionally, validate customer passwords. To learn more about Customers see [here](/docs/store-operations/customers/customers-subscribers-overview). ## Available Endpoints | Resource / Endpoint | Description | @@ -22,8 +22,8 @@ info: * A customer and a subscriber can be the same. If a shopper checks out on the storefront, creates an account and opts into the newsletter, they are a customer and a subscriber. ## Resources ### Related APIs / Endpoints - - [Customer Login API](/api-docs/customers/customer-login-api) - - [Current Customer API](/api-docs/customers/current-customer-api) + - [Customer Login API](/docs/start/authentication/customer-login) + - [Current Customer API](/docs/start/authentication/current-customer) - [Customers API (v3)](/docs/rest-management/customers) - [Subscribers API](/docs/rest-management/subscribers) ### Webhooks @@ -1737,7 +1737,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1745,7 +1745,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 6162c5490..094ca6f48 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -6,7 +6,7 @@ info: Create and manage customers. ## Resources - * [Customer and Subscribers Overview](/api-docs/store-management/customers). + * [Customer and Subscribers Overview](/docs/store-operations/customers/customers-subscribers-overview). termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -2487,7 +2487,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2495,7 +2495,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/email_templates.v3.yml b/reference/email_templates.v3.yml index a1d216c8a..27170d188 100644 --- a/reference/email_templates.v3.yml +++ b/reference/email_templates.v3.yml @@ -341,7 +341,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -349,7 +349,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/form_fields.sf.yml b/reference/form_fields.sf.yml index e01e77a24..318181614 100644 --- a/reference/form_fields.sf.yml +++ b/reference/form_fields.sf.yml @@ -4,7 +4,7 @@ info: description: |- Read form fields on a BigCommerce hosted storefront. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). diff --git a/reference/geography.v2.yml b/reference/geography.v2.yml index 4ae54b6dd..bd5c7d046 100644 --- a/reference/geography.v2.yml +++ b/reference/geography.v2.yml @@ -379,7 +379,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -387,7 +387,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/marketing.v2.yml b/reference/marketing.v2.yml index 106871a60..cfb2e859b 100644 --- a/reference/marketing.v2.yml +++ b/reference/marketing.v2.yml @@ -1574,7 +1574,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1582,7 +1582,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/orders.sf.yml b/reference/orders.sf.yml index 174d2cfb6..7b5c334df 100644 --- a/reference/orders.sf.yml +++ b/reference/orders.sf.yml @@ -4,7 +4,7 @@ info: description: |- Get order data immediately after an order is placed on the storefront. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). version: '' diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index 1d15b7b6a..d2749f527 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -7,7 +7,7 @@ info: ## Order - The Order object contains a record of the purchase agreement between a shopper and a merchant. To learn more about creating orders, see [Orders API Guide](/api-docs/orders/orders-api-overview). + The Order object contains a record of the purchase agreement between a shopper and a merchant. To learn more about creating orders, see [Orders API Guide](/docs/store-operations/orders). ### Currency Fields @@ -628,7 +628,7 @@ paths: 3. Supply a custom `tracking_link`: By providing a value for the `tracking_link` property, you can use your own tracking link within the BigCommerce control panel and in customer-facing emails. The API response will return your supplied tracking link as part of the `tracking_link` property in the response. In situations when there isn't a `generated_tracking_link`, the property in the API response will remain empty. - Acceptable values for `shipping_provider` include an empty string (`""`), `auspost`, `carrier_{your_carrier_id}` (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)), `canadapost`, `endicia`, `usps`, `fedex`, `royalmail`, `ups`, `upsready`, `upsonline`, or `shipperhq`. + Acceptable values for `shipping_provider` include an empty string (`""`), `auspost`, `carrier_{your_carrier_id}` (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)), `canadapost`, `endicia`, `usps`, `fedex`, `royalmail`, `ups`, `upsready`, `upsonline`, or `shipperhq`. Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid [tracking-carrier values](https://github.com/bigcommerce/dev-docs/blob/master/assets/csv/tracking_carrier_values.csv). summary: Create Order Shipment @@ -2626,7 +2626,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2634,7 +2634,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index 86b9eca81..f86f1796d 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -3427,7 +3427,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -3435,7 +3435,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header examples: diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index 95e4e43a9..811860846 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -3,7 +3,7 @@ info: version: '' title: Accepted Payment Methods description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). The [Get accepted payment methods](/docs/rest-payments/methods#get-accepted-payment-methods) endpoint returns information about the payment methods each configured payment gateway accepts. This information optimizes your implementation's likelihood of making successful payments requests that return errors solely when payment methods fail, without making API calls to the gateway prior to running the payment. @@ -18,7 +18,7 @@ info: * [Payments Overview](/api-docs/store-management/payments-api-overview) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -482,7 +482,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -490,7 +490,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index 03e3f6561..4e9fecc20 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -3,7 +3,7 @@ info: version: '' title: Payment Access Token description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). BigCommerce payments requests require a Payment Access Token, or _PAT_, which is a single use BigCommerce-generated JWT that's tied to the particular **order** for which the shopper authorizes BigCommerce to submit a payment. @@ -19,7 +19,7 @@ info: * [Payments Overview](/api-docs/store-management/payments-api-overview) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -380,7 +380,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -388,7 +388,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/payments/methods_payments.v2.yml b/reference/payments/methods_payments.v2.yml index 5a2b5e66f..7e7d995fa 100644 --- a/reference/payments/methods_payments.v2.yml +++ b/reference/payments/methods_payments.v2.yml @@ -2,7 +2,7 @@ openapi: '3.0.1' info: title: Payment Methods (Deprecated) description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). This endpoint is deprecated. Use [Get accepted payment methods](/docs/rest-payments/methods#get-accepted-payment-methods) instead. @@ -14,7 +14,7 @@ info: * [Payments Overview](/api-docs/store-management/payments-api-overview) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -140,7 +140,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -148,6 +148,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index fc0a11b8b..62ce7b751 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -3,7 +3,7 @@ info: version: '' title: Payment Processing description: | - > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/api-docs/store-management/payments-api-overview). + > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). The Payment Processing API uses BigCommerce's PCI-compliant payments server and a supported payment gateway to charge customers. The payment portal you choose may support charging stored instruments and/or making refund transactions. For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). @@ -17,7 +17,7 @@ info: * [Payments Overview](/api-docs/store-management/payments-api-overview) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) - * [Orders Overview](/api-docs/store-management/orders-api-overview) + * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -554,7 +554,7 @@ components: For an outline of the Process Payment API call flow and more information about authenticating, see [Authentication and Example Requests](/api-docs/getting-started/authentication#bigcommerce-generated-jwts). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: http scheme: bearer bearerFormat: 'PAT {{PAYMENT_ACCESS_TOKEN}}' diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index ed27d9cc5..8bab404b9 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -10,9 +10,9 @@ info: You can create [Price List Assignments](/docs/rest-management/price-lists/price-lists-assignments#create-price-list-assignments) to assign Price Lists to a specific [channel](/docs/rest-management/channels/channel-listings). Price Lists assigned to a channel apply to all shoppers on that channel, unless there are more specific assignments or customer group discounts set up for the shopper's customer group. If an active Price List does not contain prices for a variant, the catalog pricing will be used. - Price Lists provide overridden price values to the Stencil storefront. You can further customize the final price display using Stencil's [handlebars objects](/theme-objects). + Price Lists provide overridden price values to the Stencil storefront. You can further customize the final price display using Stencil's [handlebars objects](/docs/storefront/stencil/themes/context/object-reference/config). - To learn more about Price Lists, see [Price Lists API](/api-docs/store-management/price-list-overview). + To learn more about Price Lists, see [Price Lists API](/docs/store-operations/pricing/price-lists). ## Price Lists Assignments @@ -3046,7 +3046,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -3054,6 +3054,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/pricing.sf.yml b/reference/pricing.sf.yml index d9ded49a7..134c56f59 100644 --- a/reference/pricing.sf.yml +++ b/reference/pricing.sf.yml @@ -925,7 +925,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -933,6 +933,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/redirects.v3.yml b/reference/redirects.v3.yml index 743614f9f..8cc09ff68 100644 --- a/reference/redirects.v3.yml +++ b/reference/redirects.v3.yml @@ -643,7 +643,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -651,7 +651,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/scripts.v3.yml b/reference/scripts.v3.yml index a63bb89ef..554569f3e 100644 --- a/reference/scripts.v3.yml +++ b/reference/scripts.v3.yml @@ -3,7 +3,7 @@ info: title: Scripts version: '' description: |- - Add client-side code to a BigCommerce storefront page or associate a script with a channel. To learn more about scripts, see the [Scripts API](/api-docs/store-management/scripts) article. + Add client-side code to a BigCommerce storefront page or associate a script with a channel. To learn more about scripts, see the [Scripts API](/docs/integrations/scripts) article. termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -619,7 +619,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -627,7 +627,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index ab4a8eb4f..7a29e28de 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2460,7 +2460,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2468,6 +2468,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/shipping.v2.yml b/reference/shipping.v2.yml index cc1109d59..a29d1cfa3 100644 --- a/reference/shipping.v2.yml +++ b/reference/shipping.v2.yml @@ -2080,7 +2080,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -2088,7 +2088,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/shipping.v3.yml b/reference/shipping.v3.yml index f7dbb125f..a6a8e3c32 100644 --- a/reference/shipping.v3.yml +++ b/reference/shipping.v3.yml @@ -54,7 +54,7 @@ paths: parameters: - in: query name: 'product_id:in' - description: 'A comma-separated list of product IDs. For more information, see [Filtering](/api-docs/getting-started/filtering).' + description: 'A comma-separated list of product IDs. For more information, see [Filtering](/docs/start/about/common-query-params).' style: form explode: false schema: @@ -305,7 +305,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -313,7 +313,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/shipping_provider.yml b/reference/shipping_provider.yml index ef8b188c3..fe547c822 100644 --- a/reference/shipping_provider.yml +++ b/reference/shipping_provider.yml @@ -3,7 +3,7 @@ info: version: '' title: Shipping Providers description: |- - Implement endpoints consumed by BigCommerce for custom shipping integrations. To learn more, see [Shipping Provider API Overview](/api-docs/store-management/shipping/shipping-provider-api). + Implement endpoints consumed by BigCommerce for custom shipping integrations. To learn more, see [Shipping Provider API Overview](/docs/integrations/shipping). ## Authentication diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index 4e2730f30..c4645a6dc 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -7,7 +7,7 @@ info: ## [Sites](/docs/rest-management/sites) - Sites link [headless storefronts](/api-docs/storefronts/developers-guide-headless) to sales [channels](/docs/rest-management/channels). To [create a site](/docs/rest-management/sites#create-a-site), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites`. + Sites link [headless storefronts](/docs/storefront/headless) to sales [channels](/docs/rest-management/channels). To [create a site](/docs/rest-management/sites#create-a-site), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites @@ -111,7 +111,7 @@ info: ### Related resources * [Channels and Listings Reference](/docs/rest-management/channels) - * [Channels Overview](/api-docs/channels/overview) + * [Channels Overview](/docs/integrations/channels) * [Building Headless Storefronts Guide](/api-docs/storefronts/developers-guide-headless) termsOfService: 'https://www.bigcommerce.com/terms' contact: @@ -1260,7 +1260,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1268,7 +1268,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header parameters: diff --git a/reference/store_content.v2.yml b/reference/store_content.v2.yml index b25af3b56..a09d60349 100644 --- a/reference/store_content.v2.yml +++ b/reference/store_content.v2.yml @@ -1654,7 +1654,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1662,6 +1662,6 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/store_information.v2.yml b/reference/store_information.v2.yml index d75c6d8a0..56bfb478e 100644 --- a/reference/store_information.v2.yml +++ b/reference/store_information.v2.yml @@ -197,7 +197,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -205,7 +205,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/store_logs.v3.yml b/reference/store_logs.v3.yml index f27bf4f25..ab7f15be1 100644 --- a/reference/store_logs.v3.yml +++ b/reference/store_logs.v3.yml @@ -220,7 +220,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -228,7 +228,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header tags: diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index 4376fe532..4270a509c 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.1' info: title: Storefront Token description: |- - Get and manage tokens used to authenticate cross-origin requests to the [GraphQL Storefront API](/api-docs/storefront/graphql/graphql-storefront-api-overview). + Get and manage tokens used to authenticate cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). ## [API tokens](/docs/storefront-auth/tokens#create-a-token) @@ -342,7 +342,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -350,7 +350,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). name: X-Auth-Token in: header diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index f0611f1d2..2701912af 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -905,7 +905,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -913,7 +913,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/subscriptions.sf.yml b/reference/subscriptions.sf.yml index d5c1b3202..63f4526ba 100644 --- a/reference/subscriptions.sf.yml +++ b/reference/subscriptions.sf.yml @@ -4,15 +4,15 @@ info: description: |- Manage newsletter and marketing email subscriptions on the storefront. - For info about API accounts, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). + For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). ## Additional Information * [Collecting Newsletter Subscriptions](https://support.bigcommerce.com/s/article/Collecting-Newsletter-Subscriptions) (support.bigcommerce.com) - * [Customers Overview](/api-docs/customers/customers-subscribers-overview) - * [Working with Storefront APIs](/api-docs/cart-and-checkout/working-sf-apis) + * [Customers Overview](/docs/store-operations/customers/customers-subscribers-overview) + * [Working with Storefront APIs](/docs/storefront/cart-checkout/guide/rest-storefront) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index bd2c0e9e9..e993402ee 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.0' info: title: Tax Provider Connection version: '3' - description: 'Manage the connection between a merchantʼs BigCommerce store and a third party tax provider. For more information, see [Tax Provider API Overview](/api-docs/providers/tax).' + description: 'Manage the connection between a merchantʼs BigCommerce store and a third party tax provider. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -179,7 +179,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -187,7 +187,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/tax_classes.v2.yml b/reference/tax_classes.v2.yml index cc42d906e..a18b88435 100644 --- a/reference/tax_classes.v2.yml +++ b/reference/tax_classes.v2.yml @@ -174,7 +174,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -182,7 +182,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header diff --git a/reference/tax_properties.v3.yml b/reference/tax_properties.v3.yml index a2bff3fd8..2684b762d 100644 --- a/reference/tax_properties.v3.yml +++ b/reference/tax_properties.v3.yml @@ -269,7 +269,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -277,7 +277,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index c56b07893..285a476ce 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Tax Provider API version: '1.0' - description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/apps-api/tax#estimate-taxes), [adjust](/docs/apps-api/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/api-docs/providers/tax).' + description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/apps-api/tax#estimate-taxes), [adjust](/docs/apps-api/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce diff --git a/reference/tax_rates_zones.v3.yml b/reference/tax_rates_zones.v3.yml index dbd18f6c0..04e1126cf 100644 --- a/reference/tax_rates_zones.v3.yml +++ b/reference/tax_rates_zones.v3.yml @@ -416,7 +416,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -424,7 +424,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). schemas: Tax_Zone: type: object diff --git a/reference/tax_settings.v3.yml b/reference/tax_settings.v3.yml index a5c30a07d..692f5adfb 100644 --- a/reference/tax_settings.v3.yml +++ b/reference/tax_settings.v3.yml @@ -102,7 +102,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -110,7 +110,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/themes.v3.yml b/reference/themes.v3.yml index fea62d197..86822b7e9 100644 --- a/reference/themes.v3.yml +++ b/reference/themes.v3.yml @@ -726,7 +726,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -734,7 +734,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: diff --git a/reference/webhooks.v3.yml b/reference/webhooks.v3.yml index 0dc0b9bed..6e59c4477 100644 --- a/reference/webhooks.v3.yml +++ b/reference/webhooks.v3.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Webhooks v3 version: '' - description: 'Get notified when specific events occur on a BigCommerce store. For more information, see [Webhooks Overview](/api-docs/store-management/webhooks/overview).' + description: 'Get notified when specific events occur on a BigCommerce store. For more information, see [Webhooks Overview](/docs/integrations/webhooks).' termsOfService: 'https://www.bigcommerce.com/terms' contact: email: support@bigcommerce.com @@ -660,7 +660,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -668,7 +668,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -692,7 +692,7 @@ components: This webhook fires on new cart creation when any of the following occur: * a storefront shopper adds their first product to a cart during a new session * an application makes a successful `POST` request to `/carts` using either the [REST Storefront](/docs/rest-storefront/carts#create-a-cart) API or the [REST Management](/docs/rest-management/carts/carts-single#create-a-cart) API - * a storefront makes a successful call to create a cart using the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout) + * a storefront makes a successful call to create a cart using the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront) Cart creation also fires the `store/cart/updated` webhook. diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index 5e2ea9db2..05b1b8982 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -8,7 +8,7 @@ info: ## Subresources ### Widget templates - [Widget templates](/rest-content/widgets/widget-template) are reusable Handlebars-enabled HTML templates that define the structure of the widget on a page. + [Widget templates](/docs/rest-content/widgets/widget-template) are reusable Handlebars-enabled HTML templates that define the structure of the widget on a page. ### Widgets [Widgets](/docs/rest-content/widgets/widget) are units of content placed on specific pages in a Stencil theme. Widgets consist of a widget configuration and a widget template UUID and render as part of the storefront’s HTML. @@ -21,8 +21,8 @@ info: ## Additional Information - * [Widgets API Overview](/api-docs/store-management/widgets/overview) - * [Widget UI Schema](/stencil-docs/page-builder/widget-ui-schema) + * [Widgets API Overview](/docs/storefront/widgets) + * [Widget UI Schema](/docs/storefront/widgets/input-reference/schema) * [Widget UI Input Types](/stencil-docs/page-builder/schema-settings) termsOfService: 'https://www.bigcommerce.com/terms' contact: @@ -1294,7 +1294,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1302,7 +1302,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header schemas: @@ -1754,7 +1754,7 @@ components: items: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings#alignment) in Theme Docs.' properties: type: type: string diff --git a/reference/wishlists.v3.yml b/reference/wishlists.v3.yml index 3faa8c029..ec62c4b66 100644 --- a/reference/wishlists.v3.yml +++ b/reference/wishlists.v3.yml @@ -1008,7 +1008,7 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| - | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts). | + | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading @@ -1016,7 +1016,7 @@ components: For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). - For a list of API status codes, see [API Status Codes](/api-docs/getting-started/api-status-codes). + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header From 9ee6af6bddd438df68814b62a91294821cb5a740 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 10:56:17 -0500 Subject: [PATCH 02/11] after more redirects --- reference/channels.v3.yml | 4 ++-- reference/checkouts.sf.yml | 2 +- reference/customer_login.yml | 2 +- reference/orders.v2.oas2.yml | 4 ++-- reference/payments/accepted-methods_payments.v3.yml | 2 +- reference/payments/access-tokens_payments.v3.yml | 2 +- reference/payments/methods_payments.v2.yml | 2 +- reference/payments/process_payments.yml | 2 +- reference/shipping_provider.yml | 2 +- reference/sites.v3.yml | 2 +- reference/storefront_tokens.v3.yml | 2 +- reference/tax.v3.yml | 2 +- reference/widgets.v3.yml | 6 +++--- 13 files changed, 17 insertions(+), 17 deletions(-) diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index a27f89cb9..e7c22e7cf 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -81,8 +81,8 @@ info: ## Resources * [Sites and Routes API Reference](/docs/rest-management/sites) - * [Building Channels Overview](/api-docs/channels/overview) - * [Building Channel Apps](/api-docs/channels/building-channel-apps) + * [Building Channels Overview](/docs/integrations/channels) + * [Building Channel Apps](/docs/integrations/channels/guide) * [Channels Toolkit Reference](/docs/integrations/channels/toolkit-reference) servers: - url: 'https://api.bigcommerce.com/stores/{store_hash}/v3' diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index 11de704c8..43311f469 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -1201,7 +1201,7 @@ paths: * Required Fields: * `shipping_address` (deprecated) or `address` * `lineItems` - 2. Update the Consignment with Shipping Options using the [REST Storefront API](/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout). + 2. Update the Consignment with Shipping Options using the [REST Storefront API](/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. diff --git a/reference/customer_login.yml b/reference/customer_login.yml index e5dae4306..3eeb9053f 100644 --- a/reference/customer_login.yml +++ b/reference/customer_login.yml @@ -32,7 +32,7 @@ paths: description: |- The customer login access point URL. - [Learn more about the Customer Login API](/api-docs/customers/customer-login-api). + [Learn more about the Customer Login API](/docs/start/authentication/customer-login). ## Example diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index d2749f527..a83a7002d 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -72,7 +72,7 @@ paths: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/order_id_path' get: - description: Gets an *Order*. To learn more about creating or updating orders, see [Orders Overview](/api-docs/orders/orders-api-overview). + description: Gets an *Order*. To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). summary: Get an Order tags: - Orders @@ -3155,7 +3155,7 @@ components: enum: - auspost - canadapost - - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)) + - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)) - endicia - usps - fedex diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index 811860846..9bef01e58 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -16,7 +16,7 @@ info: ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) + * [Payments Overview](/docs/store-operations/payments) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index 4e9fecc20..592a1e330 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -17,7 +17,7 @@ info: ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) + * [Payments Overview](/docs/store-operations/payments) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) diff --git a/reference/payments/methods_payments.v2.yml b/reference/payments/methods_payments.v2.yml index 7e7d995fa..d305af1a9 100644 --- a/reference/payments/methods_payments.v2.yml +++ b/reference/payments/methods_payments.v2.yml @@ -12,7 +12,7 @@ info: ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) + * [Payments Overview](/docs/store-operations/payments) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index 62ce7b751..1ccc734b1 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -15,7 +15,7 @@ info: ## Resources - * [Payments Overview](/api-docs/store-management/payments-api-overview) + * [Payments Overview](/docs/store-operations/payments) * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) diff --git a/reference/shipping_provider.yml b/reference/shipping_provider.yml index fe547c822..5aa3f9a8e 100644 --- a/reference/shipping_provider.yml +++ b/reference/shipping_provider.yml @@ -25,7 +25,7 @@ info: - [Shipment](/api-docs/store-management/webhooks/webhook-events#shipment) ### Related API Resources - - [Shipping Provider](/docs/apps-api/shipping) + - [Shipping Provider](/docs/rest-contracts/shipping) - [Shipping V2 API](/docs/rest-management/shipping-v2) termsOfService: 'https://www.bigcommerce.com/terms' contact: diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index c4645a6dc..37ac95446 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -43,7 +43,7 @@ info: ## Site routes - [Site routes](/docs/rest-management/sites/site-routes) tell BigCommerce how to link to pages on a [headless storefront](/api-docs/storefronts/developers-guide-headless). To [create a route](/docs/rest-management/sites/site-routes#create-a-site-route) for a [site](#sites), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes`. + [Site routes](/docs/rest-management/sites/site-routes) tell BigCommerce how to link to pages on a [headless storefront](/docs/storefront/headless). To [create a route](/docs/rest-management/sites/site-routes#create-a-site-route) for a [site](#sites), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index 4270a509c..8395d6ff6 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -6,7 +6,7 @@ info: ## [API tokens](/docs/storefront-auth/tokens#create-a-token) - Generate tokens (JWT) for authenticating cross-origin requests to the [GraphQL Storefront API](/api-docs/storefront/graphql/graphql-storefront-api-overview). To [create a token](/docs/storefront-auth/tokens#create-a-token), send a `POST` request to `/stores/{{STORE_HASH}}/v3/storefront/api-token`. + Generate tokens (JWT) for authenticating cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). To [create a token](/docs/storefront-auth/tokens#create-a-token), send a `POST` request to `/stores/{{STORE_HASH}}/v3/storefront/api-token`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/storefront/api-token diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index e993402ee..7963165eb 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -96,7 +96,7 @@ paths: - (optional) Tax provider profile used in customized endpoint urls for tax provider calls. This is only available for tax providers that support this feature. The configured `username`, `password`, and `profile` (if available) is used to authenticate each API request to the Tax Provider from the associated store. - The tax provider's `profile` will be included in the url for [Tax Provider API](/docs/apps-api/tax) endpoints. + The tax provider's `profile` will be included in the url for [Tax Provider API](/docs/rest-contracts/tax) endpoints. > #### Note > * This operation will be logged in [Store Logs](https://support.bigcommerce.com/s/article/Using-Store-Logs) under **Staff Actions**. diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index 05b1b8982..568635550 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -23,7 +23,7 @@ info: * [Widgets API Overview](/docs/storefront/widgets) * [Widget UI Schema](/docs/storefront/widgets/input-reference/schema) - * [Widget UI Input Types](/stencil-docs/page-builder/schema-settings) + * [Widget UI Input Types](/docs/storefront/widgets/input-reference/settings) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -1761,7 +1761,7 @@ components: description: |- The type of setting component to display. You can view the list of elements below to discover which are available to use. - For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs. + For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. enum: - alignment - boolean @@ -1932,7 +1932,7 @@ components: x-internal: false widgetSchema: type: array - description: 'The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/stencil-docs/page-builder/widget-ui-schema). ' + description: 'The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/docs/storefront/widgets/input-reference/schema). ' title: '' items: anyOf: From 5de706aadc554aebc4ff0dbc26e0b0f9827c0536 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:15:12 -0500 Subject: [PATCH 03/11] again --- reference/orders.v2.oas2.yml | 4 ++-- reference/payments/process_payments.yml | 2 +- reference/sites.v3.yml | 2 +- reference/storefront_tokens.v3.yml | 2 +- reference/widgets.v3.yml | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index a83a7002d..bea064445 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -97,7 +97,7 @@ paths: To remove a product from an order, set that product’s `quantity` to `0`. - To learn more about creating or updating orders, see [Orders Overview](/api-docs/orders/orders-api-overview). + To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). summary: Update an Order tags: - Orders @@ -3551,7 +3551,7 @@ components: enum: - auspost - canadapost - - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)) + - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)) - endicia - usps - fedex diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index 1ccc734b1..e5881bbc7 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -55,7 +55,7 @@ paths: tags: - Processing operationId: PaymentsPost - description: 'Process payments for an order. See [Payment Processing](/api-docs/store-management/payments-api-overview) for more information.' + description: 'Process payments for an order. See [Payment Processing](/docs/store-operations/payments) for more information.' parameters: - $ref: '#/components/parameters/AcceptPaymentResponse' - $ref: '#/components/parameters/ContentType' diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index 37ac95446..9e46d5f71 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -112,7 +112,7 @@ info: ### Related resources * [Channels and Listings Reference](/docs/rest-management/channels) * [Channels Overview](/docs/integrations/channels) - * [Building Headless Storefronts Guide](/api-docs/storefronts/developers-guide-headless) + * [Building Headless Storefronts Guide](/docs/storefront/headless) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index 8395d6ff6..0726dfa5a 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -96,7 +96,7 @@ info: ## Additional information - * [GraphQL API Overview](/api-docs/storefront/graphql/graphql-storefront-api-overview) + * [GraphQL API Overview](/docs/storefront/graphql) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index 568635550..62260de66 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -1750,7 +1750,7 @@ components: example: Product settings: type: array - description: 'For examples of schema settings, see [Widget UI Input Types](/stencil-docs/page-builder/schema-settings).' + description: 'For examples of schema settings, see [Widget UI Input Types](/docs/storefront/widgets/input-reference/settings).' items: type: object title: widgetSchemaSetting_Base @@ -1835,7 +1835,7 @@ components: type: string settings: type: array - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' items: $ref: '#/components/schemas/widgetSchemaSetting_Base' x-internal: false From 012797fc057b1eef8ee566b5fdfe38aa35b56455 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:21:12 -0500 Subject: [PATCH 04/11] again --- reference/orders.v2.oas2.yml | 4 ++-- reference/sites.v3.yml | 6 +++--- reference/widgets.v3.yml | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index bea064445..5c2a8fc24 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -246,7 +246,7 @@ paths: operationId: getAllOrders post: description: |- - Creates an *Order*. To learn more about creating or updating orders, see [Orders Overview](/api-docs/orders/orders-api-overview). + Creates an *Order*. To learn more about creating or updating orders, see [Orders Overview](/docs/store-operations/orders). Create an order with an existing catalog product or a custom product. @@ -3606,7 +3606,7 @@ components: enum: - auspost - canadapost - - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/api-docs/providers/shipping)) + - carrier_{your_carrier_id} (only used if the carrier is a [third-party Shipping Provider](/docs/integrations/shipping)) - endicia - usps - fedex diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index 9e46d5f71..c958eb4c7 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -166,13 +166,13 @@ paths: $ref: '#/components/responses/504_GatewayTimeout' tags: - Sites - description: 'Create a site that links a [headless storefront](/api-docs/storefronts/developers-guide-headless) to a sales [channel](/docs/rest-management/channels).' + description: 'Create a site that links a [headless storefront](/docs/storefront/headless) to a sales [channel](/docs/rest-management/channels).' get: responses: '200': $ref: '#/components/responses/site_RespCollection' summary: Get Sites - description: 'Get sites linked to a [headless storefront](/api-docs/storefronts/developers-guide-headless) sales channels.' + description: 'Get sites linked to a [headless storefront](/docs/storefront/headless) sales channels.' tags: - Sites parameters: @@ -332,7 +332,7 @@ paths: tags: - Site Routes description: |- - Create routes that tell BigCommerce how to link to pages on a [headless storefront](/api-docs/storefronts/developers-guide-headless). + Create routes that tell BigCommerce how to link to pages on a [headless storefront](/docs/storefront/headless). ## Usage Notes * For a list of supported route types, see [Route types](/docs/rest-management/sites#route-types). diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index 62260de66..624a241da 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -1879,14 +1879,14 @@ components: widgetSchemaSetting_Base: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' properties: type: type: string description: |- The type of setting component to display. You can view the list of elements below to discover which are available to use. - For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs. + For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. enum: - alignment - boolean @@ -1956,14 +1956,14 @@ components: items: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' properties: type: type: string description: |- The type of setting component to display. You can view the list of elements below to discover which are available to use. - For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings/alignment) in Theme Docs. + For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. enum: - alignment - boolean From a0e23523b4ddea4c699a7e945a772d07a6a72ede Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:27:10 -0500 Subject: [PATCH 05/11] here come the parallel anchors --- reference/abandoned_cart_emails.v3.yaml | 4 ++-- reference/abandoned_carts.v3.yml | 4 ++-- reference/carts.sf.yml | 2 +- reference/carts.v3.yml | 4 ++-- reference/catalog/brands_catalog.v3.yml | 6 +++--- reference/catalog/categories_catalog.v3.yml | 6 +++--- reference/catalog/category-trees_catalog.v3.yml | 6 +++--- reference/catalog/product-modifiers_catalog.v3.yml | 6 +++--- .../catalog/product-variant-options_catalog.v3.yml | 6 +++--- reference/catalog/product-variants_catalog.v3.yml | 8 ++++---- reference/catalog/products_catalog.v3.yml | 12 ++++++------ reference/channels.v3.yml | 8 ++++---- reference/checkouts.sf.yml | 2 +- reference/checkouts.v3.yml | 4 ++-- reference/consent.sf.yml | 2 +- reference/currencies.v2.yml | 4 ++-- reference/current_customer.yml | 2 +- reference/custom-template-associations.v3.yml | 4 ++-- reference/customer_login.yml | 2 +- reference/customers.sf.yml | 2 +- reference/customers.v2.yml | 6 +++--- reference/customers.v3.yml | 4 ++-- reference/email_templates.v3.yml | 4 ++-- reference/form_fields.sf.yml | 2 +- reference/geography.v2.yml | 4 ++-- reference/marketing.v2.yml | 6 +++--- reference/orders.sf.yml | 2 +- reference/orders.v2.oas2.yml | 8 ++++---- reference/orders.v3.yml | 4 ++-- reference/payments/accepted-methods_payments.v3.yml | 6 +++--- reference/payments/access-tokens_payments.v3.yml | 8 ++++---- reference/payments/methods_payments.v2.yml | 4 ++-- reference/payments/process_payments.yml | 4 ++-- reference/price_lists.v3.yml | 8 ++++---- reference/pricing.sf.yml | 4 ++-- reference/redirects.v3.yml | 4 ++-- reference/scripts.v3.yml | 6 +++--- reference/settings.v3.yml | 6 +++--- reference/shipping.v2.yml | 4 ++-- reference/shipping.v3.yml | 6 +++--- reference/shipping_provider.yml | 4 ++-- reference/sites.v3.yml | 4 ++-- reference/store_content.v2.yml | 4 ++-- reference/store_information.v2.yml | 4 ++-- reference/store_logs.v3.yml | 4 ++-- reference/storefront_tokens.v3.yml | 6 +++--- reference/subscribers.v3.yml | 4 ++-- reference/subscriptions.sf.yml | 2 +- reference/tax.v3.yml | 8 ++++---- reference/tax_classes.v2.yml | 4 ++-- reference/tax_properties.v3.yml | 4 ++-- reference/tax_provider.yml | 6 +++--- reference/tax_rates_zones.v3.yml | 4 ++-- reference/tax_settings.v3.yml | 4 ++-- reference/themes.v3.yml | 4 ++-- reference/webhooks.v3.yml | 4 ++-- reference/widgets.v3.yml | 8 ++++---- reference/wishlists.v3.yml | 4 ++-- 58 files changed, 138 insertions(+), 138 deletions(-) diff --git a/reference/abandoned_cart_emails.v3.yaml b/reference/abandoned_cart_emails.v3.yaml index 55cf61f01..7674f9067 100644 --- a/reference/abandoned_cart_emails.v3.yaml +++ b/reference/abandoned_cart_emails.v3.yaml @@ -510,9 +510,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/abandoned_carts.v3.yml b/reference/abandoned_carts.v3.yml index e7cca1669..72722571f 100644 --- a/reference/abandoned_carts.v3.yml +++ b/reference/abandoned_carts.v3.yml @@ -340,9 +340,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/carts.sf.yml b/reference/carts.sf.yml index 7bde363e3..207e9b611 100644 --- a/reference/carts.sf.yml +++ b/reference/carts.sf.yml @@ -7,7 +7,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). servers: - url: 'https://{store_domain}/api/storefront' variables: diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 2edaf200a..85fb098d1 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3353,9 +3353,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index f28af6f09..c8c65e090 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -15,7 +15,7 @@ info: ## Resources ### Webhooks - * [Category](/api-docs/store-management/webhooks/events#category) + * [Category](/docs/integrations/webhooks/events#category) ### Additional Catalog endpoints * [Categories](/docs/rest-catalog/categories) @@ -1906,9 +1906,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index c346c2d14..d548b110b 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -19,7 +19,7 @@ info: ## Resources ### Webhooks - Learn more about [Category webhook events](/api-docs/store-management/webhooks/events#category). + Learn more about [Category webhook events](/docs/integrations/webhooks/events#category). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -2331,9 +2331,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/category-trees_catalog.v3.yml b/reference/catalog/category-trees_catalog.v3.yml index 19984ba3f..3ccc45690 100644 --- a/reference/catalog/category-trees_catalog.v3.yml +++ b/reference/catalog/category-trees_catalog.v3.yml @@ -15,7 +15,7 @@ info: ## Resources ### Webhooks - Learn more about [Category Tree webhook events](/api-docs/channels/guide/webhooks#category-trees). + Learn more about [Category Tree webhook events](/docs/integrations/webhooks/events/channels#category-trees). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -1123,9 +1123,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/product-modifiers_catalog.v3.yml b/reference/catalog/product-modifiers_catalog.v3.yml index 8e4b523f6..d3978eb96 100644 --- a/reference/catalog/product-modifiers_catalog.v3.yml +++ b/reference/catalog/product-modifiers_catalog.v3.yml @@ -17,7 +17,7 @@ info: ## Resources ### Webhooks - Learn more about [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products). + Learn more about [Product webhook events](/docs/integrations/webhooks/events#products). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -2829,9 +2829,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/product-variant-options_catalog.v3.yml b/reference/catalog/product-variant-options_catalog.v3.yml index 171bcb37e..92c1b79fe 100644 --- a/reference/catalog/product-variant-options_catalog.v3.yml +++ b/reference/catalog/product-variant-options_catalog.v3.yml @@ -24,7 +24,7 @@ info: ## Resources ### Webhooks - Learn more about [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products). + Learn more about [Product webhook events](/docs/integrations/webhooks/events#products). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -2460,9 +2460,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 323184d34..a8e550462 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -21,7 +21,7 @@ info: ## Resources ### Webhooks - Learn more about [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products). + Learn more about [Product webhook events](/docs/integrations/webhooks/events#products). ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -1214,7 +1214,7 @@ paths: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). x-nullable: true maximum: 2147483647 inventory_warning_level: @@ -2419,9 +2419,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 9612eb603..b0d8bff6b 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6,7 +6,7 @@ info: Our Catalog Products endpoints let you [create products](/docs/rest-catalog/products#create-a-product), perform [batch operations on existing products](/docs/rest-catalog/products#update-products-batch) and work with [reviews](/docs/rest-catalog/products/reviews), [images](/docs/rest-catalog/products/images), and [videos](/docs/rest-catalog/products/videos). Note that after a product is created initially, you can manage the nuances of its variations using the [Product Modifier](/docs/rest-catalog/product-modifiers), [Product Variant](/docs/rest-catalog/product-variants), and [Product Variant Options](/docs/rest-catalog/product-variant-options) endpoints. - Other core product endpoints focus on [bulk pricing](/docs/rest-catalog/products/bulk-pricing-rules), [complex rules](/docs/rest-catalog/products/complex-rules), [custom fields](/docs/rest-catalog/products/custom-fields), and [metafields](/docs/rest-catalog/products/metafields). Product Variant objects also contain [their own metafields](/docs/rest-catalog/product-variants/metafields). For [MSF-enabled](/docs/storefront/multi-storefront) stores, the product object also contains product [channel assignments](/docs/rest-catalog/products/channel-assignments) and [category assignments](/docs/rest-catalog/products/category-assignments); read more about [products in the MSF context](/api-docs/multi-storefront/api-guide#products). + Other core product endpoints focus on [bulk pricing](/docs/rest-catalog/products/bulk-pricing-rules), [complex rules](/docs/rest-catalog/products/complex-rules), [custom fields](/docs/rest-catalog/products/custom-fields), and [metafields](/docs/rest-catalog/products/metafields). Product Variant objects also contain [their own metafields](/docs/rest-catalog/product-variants/metafields). For [MSF-enabled](/docs/storefront/multi-storefront) stores, the product object also contains product [channel assignments](/docs/rest-catalog/products/channel-assignments) and [category assignments](/docs/rest-catalog/products/category-assignments); read more about [products in the MSF context](/docs/storefront/multi-storefront/guide#products). This API family also contains an endpoint to [Get a catalog summary](/docs/rest-catalog/products/summary). @@ -15,8 +15,8 @@ info: ## Resources ### Webhooks - * [Product webhook events](/api-docs/store-management/webhooks/webhook-events#products) - * [Product assignment webhook events](/api-docs/channels/guide/webhooks#product-assignments) + * [Product webhook events](/docs/integrations/webhooks/events#products) + * [Product assignment webhook events](/docs/integrations/webhooks/events/channels#product-assignments) ### Additional Catalog endpoints * [Brands](/docs/rest-catalog/brands) @@ -6528,7 +6528,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: @@ -8713,9 +8713,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index e7c22e7cf..8e5b6ff44 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -2026,9 +2026,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey @@ -2309,7 +2309,7 @@ components: properties: app: type: object - description: 'A [channel app](/api-docs/channels/overview#channel-apps) config object for optionally configuring the channelʼs user interface in the control panel.' + description: 'A [channel app](/docs/integrations/channels#channel-apps) config object for optionally configuring the channelʼs user interface in the control panel.' properties: id: type: integer @@ -2643,7 +2643,7 @@ components: x-internal: false BigCommerceProtectedAppSections: type: array - description: 'List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the [Building Storefront Channels](/api-docs/channels/tutorials/storefront#protected-ui-sections) tutorial.' + description: 'List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the [Building Storefront Channels](/docs/integrations/channels/guide/storefronts#protected-ui-sections) tutorial.' items: type: string enum: diff --git a/reference/checkouts.sf.yml b/reference/checkouts.sf.yml index 43311f469..736104959 100644 --- a/reference/checkouts.sf.yml +++ b/reference/checkouts.sf.yml @@ -7,7 +7,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: '' termsOfService: 'https://www.bigcommerce.com/terms' contact: diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index 40a017825..0cb11769e 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -9704,9 +9704,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/consent.sf.yml b/reference/consent.sf.yml index 2838bfbb4..a026f8030 100644 --- a/reference/consent.sf.yml +++ b/reference/consent.sf.yml @@ -12,7 +12,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: Storefront tags: - name: Consent diff --git a/reference/currencies.v2.yml b/reference/currencies.v2.yml index df56be493..83063f2bf 100644 --- a/reference/currencies.v2.yml +++ b/reference/currencies.v2.yml @@ -394,9 +394,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/current_customer.yml b/reference/current_customer.yml index 8c73ca11b..a91f0fe60 100644 --- a/reference/current_customer.yml +++ b/reference/current_customer.yml @@ -8,7 +8,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#client-id). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#client-id). > #### Note > * Substitute your storefront domain for `yourstore.example.com`. diff --git a/reference/custom-template-associations.v3.yml b/reference/custom-template-associations.v3.yml index dcc5c6af1..96c1d33ea 100644 --- a/reference/custom-template-associations.v3.yml +++ b/reference/custom-template-associations.v3.yml @@ -481,9 +481,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/customer_login.yml b/reference/customer_login.yml index 3eeb9053f..e147e457b 100644 --- a/reference/customer_login.yml +++ b/reference/customer_login.yml @@ -8,7 +8,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#user-generated-jwts). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#user-generated-jwts). termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce diff --git a/reference/customers.sf.yml b/reference/customers.sf.yml index 8bfc5736c..a4b53ddf2 100644 --- a/reference/customers.sf.yml +++ b/reference/customers.sf.yml @@ -7,7 +7,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). servers: - url: 'https://{store_domain}/api/storefront' variables: diff --git a/reference/customers.v2.yml b/reference/customers.v2.yml index 2d80c74e1..c5d1db1cf 100644 --- a/reference/customers.v2.yml +++ b/reference/customers.v2.yml @@ -27,7 +27,7 @@ info: - [Customers API (v3)](/docs/rest-management/customers) - [Subscribers API](/docs/rest-management/subscribers) ### Webhooks - - [Customers](/api-docs/store-management/webhooks/webhook-events#customer) + - [Customers](/docs/integrations/webhooks/events#customer) termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -1741,9 +1741,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index 094ca6f48..3dcc25669 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -2491,9 +2491,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/email_templates.v3.yml b/reference/email_templates.v3.yml index 27170d188..95b83b424 100644 --- a/reference/email_templates.v3.yml +++ b/reference/email_templates.v3.yml @@ -345,9 +345,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/form_fields.sf.yml b/reference/form_fields.sf.yml index 318181614..b0eef355b 100644 --- a/reference/form_fields.sf.yml +++ b/reference/form_fields.sf.yml @@ -6,7 +6,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). > #### Warning > Breaking changes may be introduced to this endpoint while in beta. diff --git a/reference/geography.v2.yml b/reference/geography.v2.yml index bd5c7d046..ec5976343 100644 --- a/reference/geography.v2.yml +++ b/reference/geography.v2.yml @@ -383,9 +383,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/marketing.v2.yml b/reference/marketing.v2.yml index cfb2e859b..bcb5152d4 100644 --- a/reference/marketing.v2.yml +++ b/reference/marketing.v2.yml @@ -1016,7 +1016,7 @@ components: type: array description: This is a list of shipping-method names. A shipping method must be enabled on the store to use it with a coupon. To check which shipping - methods are enabled, please use the [List Shipping Methods](/api/v2#list-shipping-methods) + methods are enabled, please use the [List Shipping Methods](/archive/store-operations/v2-catalog-products/v2-products#list-shipping-methods) endpoint. items: type: string @@ -1578,9 +1578,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/orders.sf.yml b/reference/orders.sf.yml index 7b5c334df..5f0970acf 100644 --- a/reference/orders.sf.yml +++ b/reference/orders.sf.yml @@ -6,7 +6,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: '' termsOfService: 'https://www.bigcommerce.com/terms' contact: diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml index 5c2a8fc24..086aa98a8 100644 --- a/reference/orders.v2.oas2.yml +++ b/reference/orders.v2.oas2.yml @@ -612,7 +612,7 @@ paths: operationId: getAllOrderShipments post: description: | - Creates an *Order Shipment*. For more details, see [Shipping an Order](/api-docs/orders/orders-api-overview#creating-order-shipments). + Creates an *Order Shipment*. For more details, see [Shipping an Order](/docs/store-operations/orders#creating-order-shipments). **Required Fields** * order_address_id @@ -2630,9 +2630,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey @@ -4389,7 +4389,7 @@ components: description: The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`. type: string default_currency_code: - description: A read-only field displays the currency code of the [transactional currency](/api-docs/multi-currency/guide/introduction#display-vs-transactional) the shopper uses. + description: A read-only field displays the currency code of the [transactional currency](/docs/store-operations/currencies#display-vs-transactional) the shopper uses. type: string readOnly: true discount_amount: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index f86f1796d..bff39ebe4 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -3431,9 +3431,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index 9bef01e58..ed1d105c7 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -8,9 +8,9 @@ info: The [Get accepted payment methods](/docs/rest-payments/methods#get-accepted-payment-methods) endpoint returns information about the payment methods each configured payment gateway accepts. This information optimizes your implementation's likelihood of making successful payments requests that return errors solely when payment methods fail, without making API calls to the gateway prior to running the payment. - For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). + For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/docs/store-operations/payments#compatible-payment-gateways). - This endpoint uses the X-Auth-Token header to authenticate. For an X-Auth-Token example request, see the related section in our [Authentication article](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + This endpoint uses the X-Auth-Token header to authenticate. For an X-Auth-Token example request, see the related section in our [Authentication article](/docs/start/authentication#x-auth-token-header-example-requests). > To learn more about authenticating Payments endpoints, locate the **Authentication** section at the top of each endpoint, then click **Show Details**. @@ -488,7 +488,7 @@ components: For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index 592a1e330..ad174841f 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -7,18 +7,18 @@ info: BigCommerce payments requests require a Payment Access Token, or _PAT_, which is a single use BigCommerce-generated JWT that's tied to the particular **order** for which the shopper authorizes BigCommerce to submit a payment. - To get a valid PAT, submit the order number to the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint. Authenticate using an [API account access token](/api-docs/getting-started/api-accounts#api-accounts) with the [Create payments](/api-docs/getting-started/api-accounts#token-creation-scopes) scope as the value of the X-Auth-Token header. + To get a valid PAT, submit the order number to the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint. Authenticate using an [API account access token](/docs/start/authentication/api-accounts#api-accounts) with the [Create payments](/api-docs/getting-started/api-accounts#token-creation-scopes) scope as the value of the X-Auth-Token header. - You can also generate a PAT during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout#handling-payments). + You can also generate a PAT during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). - For a guide through the API call sequence needed to create a PAT and make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). + For a guide through the API call sequence needed to create a PAT and make charges, see the [Payments Overview](/docs/store-operations/payments#compatible-payment-gateways). > To learn more about authenticating Payments endpoints, locate the **Authentication** section at the top of each endpoint, then click **Show Details**. ## Resources * [Payments Overview](/docs/store-operations/payments) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) ### Webhooks diff --git a/reference/payments/methods_payments.v2.yml b/reference/payments/methods_payments.v2.yml index d305af1a9..7a14c9832 100644 --- a/reference/payments/methods_payments.v2.yml +++ b/reference/payments/methods_payments.v2.yml @@ -13,7 +13,7 @@ info: ## Resources * [Payments Overview](/docs/store-operations/payments) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) ### Webhooks @@ -146,7 +146,7 @@ components: For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index e5881bbc7..08c0731a8 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -5,9 +5,9 @@ info: description: | > The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the [Payments Overview](/docs/store-operations/payments). - The Payment Processing API uses BigCommerce's PCI-compliant payments server and a supported payment gateway to charge customers. The payment portal you choose may support charging stored instruments and/or making refund transactions. For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/api-docs/store-management/payments-api-overview#compatible-payment-gateways). + The Payment Processing API uses BigCommerce's PCI-compliant payments server and a supported payment gateway to charge customers. The payment portal you choose may support charging stored instruments and/or making refund transactions. For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the [Payments Overview](/docs/store-operations/payments#compatible-payment-gateways). - A Payment Access Token (_PAT_) is required to authorize payment processing requests. The X-Auth-Token header is not required in requests to the payment processing endpoint. To generate a PAT, use the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint or the `completeCheckout` mutation in the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout#handling-payments). For a payment processing authentication example request, see the related section in our [Authentication article](/api-docs/getting-started/authentication#bigcommerce-generated-jwts). + A Payment Access Token (_PAT_) is required to authorize payment processing requests. The X-Auth-Token header is not required in requests to the payment processing endpoint. To generate a PAT, use the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint or the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). For a payment processing authentication example request, see the related section in our [Authentication article](/docs/start/authentication#bigcommerce-generated-jwts). Also note that payment processing requests use the BigCommerce Payments Gateway, which uses a different server than our other REST APIs. Please see the server URL for the payment processing endpoint. diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index 8bab404b9..84ba17d99 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -45,8 +45,8 @@ info: ### Webhooks - * [Price list assignments](/api-docs/channels/guide/webhooks#price-list-assignments) - * [Products](/api-docs/store-management/webhooks/events#products) + * [Price list assignments](/docs/integrations/webhooks/events/channels#price-list-assignments) + * [Products](/docs/integrations/webhooks/events#products) * [SKU](/api-docs/store-management/webhooks/events#sku) ### Related endpoints * [Get All Price Lists](/docs/rest-management/price-lists#get-all-price-lists) @@ -3050,9 +3050,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/pricing.sf.yml b/reference/pricing.sf.yml index 134c56f59..4b20d2f21 100644 --- a/reference/pricing.sf.yml +++ b/reference/pricing.sf.yml @@ -929,9 +929,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/redirects.v3.yml b/reference/redirects.v3.yml index 8cc09ff68..18ac4ad1c 100644 --- a/reference/redirects.v3.yml +++ b/reference/redirects.v3.yml @@ -647,9 +647,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/scripts.v3.yml b/reference/scripts.v3.yml index 554569f3e..ab5d6c73b 100644 --- a/reference/scripts.v3.yml +++ b/reference/scripts.v3.yml @@ -122,7 +122,7 @@ paths: * Specify the `html` property. * Do not specify the `src` field. * Each app can have 10 scripts installed. - * Multiple scripts can be created [per call](/api-docs/store-management/scripts#notes). + * Multiple scripts can be created [per call](/docs/integrations/scripts#notes). get: summary: Get All Scripts operationId: getScripts @@ -623,9 +623,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index 7a29e28de..9b4655649 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2011,7 +2011,7 @@ components: description: |- Describes when stock levels are updated. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/buy-online-pick-up-in-store/webhooks#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. edit_order_stock_adjustment: type: boolean description: |- @@ -2464,9 +2464,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/shipping.v2.yml b/reference/shipping.v2.yml index a29d1cfa3..ca760bc1f 100644 --- a/reference/shipping.v2.yml +++ b/reference/shipping.v2.yml @@ -2084,9 +2084,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/shipping.v3.yml b/reference/shipping.v3.yml index a6a8e3c32..3158f23a4 100644 --- a/reference/shipping.v3.yml +++ b/reference/shipping.v3.yml @@ -273,7 +273,7 @@ components: schema: $ref: '#/components/schemas/error_Full' 429_Too_Many_Requests: - description: 'When an OAuth client exceeds the [rate limit](/api-docs/getting-started/best-practices#api-rate-limits) for API requests to a store.' + description: 'When an OAuth client exceeds the [rate limit](/docs/start/best-practices#api-rate-limits) for API requests to a store.' content: application/json: schema: @@ -309,9 +309,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/shipping_provider.yml b/reference/shipping_provider.yml index 5aa3f9a8e..3b5b6577f 100644 --- a/reference/shipping_provider.yml +++ b/reference/shipping_provider.yml @@ -9,7 +9,7 @@ info: This specification file describes API requests BigCommerce will make to a registered shipping carrierʼs server to check connection options and retrieve rates. As such, the method of authentication is determined by the carrier server. - For more, see [developer-configured authentication](/api-docs/getting-started/authentication#developer-configured-authentication) for provider APIs. + For more, see [developer-configured authentication](/docs/start/authentication#developer-configured-authentication) for provider APIs. ## Subresources @@ -22,7 +22,7 @@ info: ## Additional Information ### Webhooks - - [Shipment](/api-docs/store-management/webhooks/webhook-events#shipment) + - [Shipment](/docs/integrations/webhooks/events#shipment) ### Related API Resources - [Shipping Provider](/docs/rest-contracts/shipping) diff --git a/reference/sites.v3.yml b/reference/sites.v3.yml index c958eb4c7..0037a7f4f 100644 --- a/reference/sites.v3.yml +++ b/reference/sites.v3.yml @@ -1264,9 +1264,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/store_content.v2.yml b/reference/store_content.v2.yml index a09d60349..93be79c3b 100644 --- a/reference/store_content.v2.yml +++ b/reference/store_content.v2.yml @@ -1658,9 +1658,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/store_information.v2.yml b/reference/store_information.v2.yml index 56bfb478e..985533056 100644 --- a/reference/store_information.v2.yml +++ b/reference/store_information.v2.yml @@ -201,9 +201,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/store_logs.v3.yml b/reference/store_logs.v3.yml index ab7f15be1..5dd8675b4 100644 --- a/reference/store_logs.v3.yml +++ b/reference/store_logs.v3.yml @@ -224,9 +224,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index 0726dfa5a..a15c4f28c 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -44,7 +44,7 @@ info: ## [Customer impersonation tokens](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) - Generate tokens that can make queries from the perspective of a particular customer in headless or server-side code using the [GraphQL Storefront API](/api-docs/storefront/graphql/graphql-storefront-api-overview#customer-impersonation-tokens). To [create a customer impersonation token](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token), send a `POST` request to `/v3/storefront/api-token-customer-impersonation`. + Generate tokens that can make queries from the perspective of a particular customer in headless or server-side code using the [GraphQL Storefront API](/docs/storefront/graphql#customer-impersonation-tokens). To [create a customer impersonation token](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token), send a `POST` request to `/v3/storefront/api-token-customer-impersonation`. ```http POST https://api.bigcommerce.com/stores/{STORE_HASH}/v3/storefront/api-token-customer-impersonation @@ -346,9 +346,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). name: X-Auth-Token diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index 2701912af..715f53778 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -909,9 +909,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/subscriptions.sf.yml b/reference/subscriptions.sf.yml index 63f4526ba..e5eb799e0 100644 --- a/reference/subscriptions.sf.yml +++ b/reference/subscriptions.sf.yml @@ -6,7 +6,7 @@ info: For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). - For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#same-origin-cors-authentication). + For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). ## Additional Information diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index 7963165eb..e341be623 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -49,11 +49,11 @@ paths: delete: summary: Delete a Connection description: | - Remove any previously set basic connection credentials for the specified provider. If the specified provider is the active tax provider on the store, the store's active tax provider will be reset to BigCommerce Manual Tax. It is suggested to call this endpoint during a single-click app [uninstall callback](/api-docs/apps/guide/callbacks#uninstall-callback). + Remove any previously set basic connection credentials for the specified provider. If the specified provider is the active tax provider on the store, the store's active tax provider will be reset to BigCommerce Manual Tax. It is suggested to call this endpoint during a single-click app [uninstall callback](/docs/integrations/apps/guide/callbacks#uninstall-callback). > #### Note > * This operation will be logged in [Store Logs](https://support.bigcommerce.com/s/article/Using-Store-Logs) under **Staff Actions**. - > * Requires **write** permissions on the **Information and Settings** [scope](/api-docs/getting-started/api-accounts#oauth-scopes). + > * Requires **write** permissions on the **Information and Settings** [scope](/docs/start/authentication/api-accounts#oauth-scopes). operationId: provider-connection-delete responses: '200': @@ -138,7 +138,7 @@ paths: required: true schema: type: string - description: 'The Tax Providerʼs `provider_id` provided by BigCommerce after the provider [shares their provider details](/api-docs/providers/tax#sharing-provider-details-with-bigcommerce).' + description: 'The Tax Providerʼs `provider_id` provided by BigCommerce after the provider [shares their provider details](/docs/integrations/tax#sharing-provider-details-with-bigcommerce).' components: parameters: Accept: @@ -183,7 +183,7 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). diff --git a/reference/tax_classes.v2.yml b/reference/tax_classes.v2.yml index a18b88435..cb821f28e 100644 --- a/reference/tax_classes.v2.yml +++ b/reference/tax_classes.v2.yml @@ -178,9 +178,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/tax_properties.v3.yml b/reference/tax_properties.v3.yml index 2684b762d..e0c292f0c 100644 --- a/reference/tax_properties.v3.yml +++ b/reference/tax_properties.v3.yml @@ -273,9 +273,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index 285a476ce..0ef31cfdb 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Tax Provider API version: '1.0' - description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/apps-api/tax#estimate-taxes), [adjust](/docs/apps-api/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' + description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/apps-api/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce @@ -1317,9 +1317,9 @@ components: type: http scheme: basic description: |- - The [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials used to authenticate each API request to the Tax Provider from the associated store; set and update `username`, `password`, and optionally `profile`, using the [Update a Connection](/docs/apps-api/tax-app-connection#update-a-connection) request. `profile` is an optional field and will be used with supporting providers only. + The [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials used to authenticate each API request to the Tax Provider from the associated store; set and update `username`, `password`, and optionally `profile`, using the [Update a Connection](/docs/rest-contracts/tax-app-connection#update-a-connection) request. `profile` is an optional field and will be used with supporting providers only. - For more, see [developer-configured authentication](/api-docs/getting-started/authentication#developer-configured-authentication) for Provider APIs. + For more, see [developer-configured authentication](/docs/start/authentication#developer-configured-authentication) for Provider APIs. security: - Authorization: [] diff --git a/reference/tax_rates_zones.v3.yml b/reference/tax_rates_zones.v3.yml index 04e1126cf..ffbb892a5 100644 --- a/reference/tax_rates_zones.v3.yml +++ b/reference/tax_rates_zones.v3.yml @@ -420,9 +420,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). schemas: diff --git a/reference/tax_settings.v3.yml b/reference/tax_settings.v3.yml index 692f5adfb..cb761be24 100644 --- a/reference/tax_settings.v3.yml +++ b/reference/tax_settings.v3.yml @@ -106,9 +106,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/themes.v3.yml b/reference/themes.v3.yml index 86822b7e9..fdb47f8c9 100644 --- a/reference/themes.v3.yml +++ b/reference/themes.v3.yml @@ -730,9 +730,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/webhooks.v3.yml b/reference/webhooks.v3.yml index 6e59c4477..c1dc0237b 100644 --- a/reference/webhooks.v3.yml +++ b/reference/webhooks.v3.yml @@ -664,9 +664,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/widgets.v3.yml b/reference/widgets.v3.yml index 624a241da..a16660a9e 100644 --- a/reference/widgets.v3.yml +++ b/reference/widgets.v3.yml @@ -443,7 +443,7 @@ paths: **Template Files** - To view the list of values accepted by the `template_file` property, including **custom** templates, see [Placements](/api-docs/store-management/widgets/overview#placements). + To view the list of values accepted by the `template_file` property, including **custom** templates, see [Placements](/docs/storefront/widgets#placements). get: tags: - Placement @@ -1298,9 +1298,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey @@ -1754,7 +1754,7 @@ components: items: type: object title: widgetSchemaSetting_Base - description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/stencil-docs/page-builder/schema-settings#alignment) in Theme Docs.' + description: 'For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' properties: type: type: string diff --git a/reference/wishlists.v3.yml b/reference/wishlists.v3.yml index ec62c4b66..257ac1c65 100644 --- a/reference/wishlists.v3.yml +++ b/reference/wishlists.v3.yml @@ -1012,9 +1012,9 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey From 87365a35e13c25262d0f89587136b119e33be870 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:30:45 -0500 Subject: [PATCH 06/11] again --- reference/catalog/product-variants_catalog.v3.yml | 2 +- reference/catalog/products_catalog.v3.yml | 2 +- reference/payments/accepted-methods_payments.v3.yml | 2 +- reference/payments/access-tokens_payments.v3.yml | 6 +++--- reference/payments/methods_payments.v2.yml | 2 +- reference/payments/process_payments.yml | 2 +- reference/price_lists.v3.yml | 2 +- reference/scripts.v3.yml | 2 +- reference/settings.v3.yml | 4 ++-- reference/tax.v3.yml | 2 +- reference/tax_provider.yml | 2 +- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index a8e550462..84d6df459 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1432,7 +1432,7 @@ paths: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). x-nullable: true maximum: 2147483647 example: 21474 diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index b0d8bff6b..1935ddb1d 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -6714,7 +6714,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index ed1d105c7..3bc4a61e1 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -17,7 +17,7 @@ info: ## Resources * [Payments Overview](/docs/store-operations/payments) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) ### Webhooks diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index ad174841f..df1ffd878 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -7,7 +7,7 @@ info: BigCommerce payments requests require a Payment Access Token, or _PAT_, which is a single use BigCommerce-generated JWT that's tied to the particular **order** for which the shopper authorizes BigCommerce to submit a payment. - To get a valid PAT, submit the order number to the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint. Authenticate using an [API account access token](/docs/start/authentication/api-accounts#api-accounts) with the [Create payments](/api-docs/getting-started/api-accounts#token-creation-scopes) scope as the value of the X-Auth-Token header. + To get a valid PAT, submit the order number to the [Create a Payment Access Token](/docs/rest-payments/tokens#create-payment-access-token) endpoint. Authenticate using an [API account access token](/docs/start/authentication/api-accounts#api-accounts) with the [Create payments](/docs/start/authentication/api-accounts#token-creation-scopes) scope as the value of the X-Auth-Token header. You can also generate a PAT during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). @@ -57,7 +57,7 @@ paths: description: |- Use this endpoint to create a payment access token. A payment access token is required to process payments with the BigCommerce API. - You can also generate a payment access token during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/api-docs/storefront/graphql/carts-and-checkout#handling-payments). + You can also generate a payment access token during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments). After the token is created, use the token to [Process a payment](/docs/rest-payments/processing#process-payment). @@ -384,7 +384,7 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). diff --git a/reference/payments/methods_payments.v2.yml b/reference/payments/methods_payments.v2.yml index 7a14c9832..614f50ff6 100644 --- a/reference/payments/methods_payments.v2.yml +++ b/reference/payments/methods_payments.v2.yml @@ -144,7 +144,7 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index 08c0731a8..bc2e405bf 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -16,7 +16,7 @@ info: ## Resources * [Payments Overview](/docs/store-operations/payments) - * [Process payments authentication example request](/api-docs/getting-started/authentication#bigcommerce-generated-jwts) + * [Process payments authentication example request](/docs/start/authentication#bigcommerce-generated-jwts) * [Orders Overview](/docs/store-operations/orders) ### Webhooks diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml index 84ba17d99..56a16fe1f 100644 --- a/reference/price_lists.v3.yml +++ b/reference/price_lists.v3.yml @@ -47,7 +47,7 @@ info: * [Price list assignments](/docs/integrations/webhooks/events/channels#price-list-assignments) * [Products](/docs/integrations/webhooks/events#products) - * [SKU](/api-docs/store-management/webhooks/events#sku) + * [SKU](/docs/integrations/webhooks/events#sku) ### Related endpoints * [Get All Price Lists](/docs/rest-management/price-lists#get-all-price-lists) termsOfService: 'https://www.bigcommerce.com/terms' diff --git a/reference/scripts.v3.yml b/reference/scripts.v3.yml index ab5d6c73b..ac15c016c 100644 --- a/reference/scripts.v3.yml +++ b/reference/scripts.v3.yml @@ -880,7 +880,7 @@ components: script_Response: type: object title: script_Response - description: 'For a list of all locations visit [Scripts Visibility](/api-docs/store-management/scripts#script-visibility-locations).' + description: 'For a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations).' properties: data: $ref: '#/components/schemas/script_Full' diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index 9b4655649..df3f09d0a 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2011,13 +2011,13 @@ components: description: |- Describes when stock levels are updated. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. edit_order_stock_adjustment: type: boolean description: |- Describes whether stock levels automatically adjust when you edit an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/buy-online-pick-up-in-store/webhooks#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. refund_order_stock_adjustment: type: boolean description: |- diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index e341be623..4e2c783cf 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -100,7 +100,7 @@ paths: > #### Note > * This operation will be logged in [Store Logs](https://support.bigcommerce.com/s/article/Using-Store-Logs) under **Staff Actions**. - > * Requires **write** permissions on the **Information and Settings** [scope](/api-docs/getting-started/api-accounts#oauth-scopes). + > * Requires **write** permissions on the **Information and Settings** [scope](/docs/start/authentication/api-accounts#oauth-scopes). summary: Update a Connection parameters: - $ref: '#/components/parameters/ContentType' diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index 0ef31cfdb..be17ea3b5 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Tax Provider API version: '1.0' - description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/apps-api/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' + description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/rest-contracts/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce From de980da525166abeb8a7457a945946579af7b1c4 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:31:51 -0500 Subject: [PATCH 07/11] again --- reference/catalog/product-variants_catalog.v3.yml | 2 +- reference/catalog/products_catalog.v3.yml | 2 +- reference/payments/accepted-methods_payments.v3.yml | 2 +- reference/payments/access-tokens_payments.v3.yml | 2 +- reference/payments/process_payments.yml | 2 +- reference/scripts.v3.yml | 2 +- reference/settings.v3.yml | 4 ++-- reference/tax.v3.yml | 2 +- reference/tax_provider.yml | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 84d6df459..8d5d41e5b 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1557,7 +1557,7 @@ paths: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). x-nullable: true maximum: 2147483647 inventory_warning_level: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 1935ddb1d..f5fe58b32 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -8165,7 +8165,7 @@ components: The inventory for a product cannot exceed 2,147,483,647 in the catalog. If you exceed the limit, the store sets the inventory level to the limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). inventory_warning_level: maximum: 2147483647 minimum: 0 diff --git a/reference/payments/accepted-methods_payments.v3.yml b/reference/payments/accepted-methods_payments.v3.yml index 3bc4a61e1..3cb37ccca 100644 --- a/reference/payments/accepted-methods_payments.v3.yml +++ b/reference/payments/accepted-methods_payments.v3.yml @@ -486,7 +486,7 @@ components: ### Further reading - For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/api-docs/getting-started/authentication#x-auth-token-header-example-requests). + For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). diff --git a/reference/payments/access-tokens_payments.v3.yml b/reference/payments/access-tokens_payments.v3.yml index df1ffd878..25211c673 100644 --- a/reference/payments/access-tokens_payments.v3.yml +++ b/reference/payments/access-tokens_payments.v3.yml @@ -386,7 +386,7 @@ components: For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/payments/process_payments.yml b/reference/payments/process_payments.yml index bc2e405bf..30da26157 100644 --- a/reference/payments/process_payments.yml +++ b/reference/payments/process_payments.yml @@ -552,7 +552,7 @@ components: ### Further reading - For an outline of the Process Payment API call flow and more information about authenticating, see [Authentication and Example Requests](/api-docs/getting-started/authentication#bigcommerce-generated-jwts). + For an outline of the Process Payment API call flow and more information about authenticating, see [Authentication and Example Requests](/docs/start/authentication#bigcommerce-generated-jwts). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: http diff --git a/reference/scripts.v3.yml b/reference/scripts.v3.yml index ac15c016c..b95c6c9b3 100644 --- a/reference/scripts.v3.yml +++ b/reference/scripts.v3.yml @@ -890,7 +890,7 @@ components: script_responseCollection: type: object title: script_responseCollection - description: 'For a list of all locations visit [Scripts Visibility](/api-docs/store-management/scripts#script-visibility-locations).' + description: 'For a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations).' properties: data: type: array diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index df3f09d0a..5e964f5ef 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2017,13 +2017,13 @@ components: description: |- Describes whether stock levels automatically adjust when you edit an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. refund_order_stock_adjustment: type: boolean description: |- Describes whether stock levels automatically adjust when you refund or cancel an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/buy-online-pick-up-in-store/webhooks#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. stock_level_display: type: string enum: diff --git a/reference/tax.v3.yml b/reference/tax.v3.yml index 4e2c783cf..58e9ee964 100644 --- a/reference/tax.v3.yml +++ b/reference/tax.v3.yml @@ -185,7 +185,7 @@ components: For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/api-docs/getting-started/api-accounts#oauth-scopes). + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index be17ea3b5..b55b7d8af 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Tax Provider API version: '1.0' - description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/rest-contracts/tax#adjust-tax-quote), [commit](/docs/apps-api/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' + description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/rest-contracts/tax#adjust-tax-quote), [commit](/docs/rest-contracts/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce From 3c09fe1f0146824f41d5bf9c499896e0d526dbf8 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:33:40 -0500 Subject: [PATCH 08/11] again --- reference/catalog/product-variants_catalog.v3.yml | 2 +- reference/scripts.v3.yml | 2 +- reference/settings.v3.yml | 2 +- reference/tax_provider.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 8d5d41e5b..be939c4e8 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1863,7 +1863,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: diff --git a/reference/scripts.v3.yml b/reference/scripts.v3.yml index b95c6c9b3..2c1795db6 100644 --- a/reference/scripts.v3.yml +++ b/reference/scripts.v3.yml @@ -933,7 +933,7 @@ components: - footer visibility: type: string - description: "Which set of pages the script should load on. \n\nPlease note that you need to have `Checkout content` scope to use `all_pages` and `checkout`.\n\n- The current visibility options are `storefront`, `checkout`, `all_pages` and `order_confirmation`.\n\n `storefront`: All pages that are not `checkout` or `order_confirmation`.\n\n\t\t \nFor a list of all locations visit [Scripts Visibility](/api-docs/store-management/scripts#script-visibility-locations)." + description: "Which set of pages the script should load on. \n\nPlease note that you need to have `Checkout content` scope to use `all_pages` and `checkout`.\n\n- The current visibility options are `storefront`, `checkout`, `all_pages` and `order_confirmation`.\n\n `storefront`: All pages that are not `checkout` or `order_confirmation`.\n\n\t\t \nFor a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations)." enum: - storefront - all_pages diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index 5e964f5ef..303d9f405 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2017,7 +2017,7 @@ components: description: |- Describes whether stock levels automatically adjust when you edit an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. refund_order_stock_adjustment: type: boolean description: |- diff --git a/reference/tax_provider.yml b/reference/tax_provider.yml index b55b7d8af..5856f225e 100644 --- a/reference/tax_provider.yml +++ b/reference/tax_provider.yml @@ -2,7 +2,7 @@ openapi: '3.0.3' info: title: Tax Provider API version: '1.0' - description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/rest-contracts/tax#adjust-tax-quote), [commit](/docs/rest-contracts/tax#commit-tax-quote), and [void](/docs/apps-api/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' + description: 'Use BigCommerce’s platform-to-platform Tax Provider API to integrate a tax calculation engine into the BigCommerce storefront and control panel. Supports [estimate](/docs/rest-contracts/tax#estimate-taxes), [adjust](/docs/rest-contracts/tax#adjust-tax-quote), [commit](/docs/rest-contracts/tax#commit-tax-quote), and [void](/docs/rest-contracts/tax#void-tax-quote) operations. For more information, see [Tax Provider API Overview](/docs/integrations/tax).' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce From 06d8ad0daaae1c806523ee8cc437a91216f029e0 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:34:51 -0500 Subject: [PATCH 09/11] again --- reference/catalog/product-variants_catalog.v3.yml | 2 +- reference/settings.v3.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index be939c4e8..7a0cfca1a 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -2057,7 +2057,7 @@ components: If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. - The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/buy-online-pick-up-in-store/inventory#limit-handling-in-inventory-versus-catalog-api). + The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). nullable: true maximum: 2147483647 inventory_warning_level: diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index 303d9f405..c6324fad4 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2023,7 +2023,7 @@ components: description: |- Describes whether stock levels automatically adjust when you refund or cancel an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/api-docs/store-management/webhooks/webhook-events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. stock_level_display: type: string enum: From 7d85411f14b5387de1117f51d2b3a497b91e4d26 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Mon, 23 Oct 2023 12:35:38 -0500 Subject: [PATCH 10/11] again --- reference/settings.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml index c6324fad4..fb2b89139 100644 --- a/reference/settings.v3.yml +++ b/reference/settings.v3.yml @@ -2023,7 +2023,7 @@ components: description: |- Describes whether stock levels automatically adjust when you refund or cancel an order. - Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/api-docs/store-management/webhooks/webhook-events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. stock_level_display: type: string enum: From f66e2596c2e9c9001a80ba5c5c5e005162a027cd Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Tue, 24 Oct 2023 13:08:37 -0500 Subject: [PATCH 11/11] links, update customers and auth spec --- reference/storefront_tokens.v3.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/reference/storefront_tokens.v3.yml b/reference/storefront_tokens.v3.yml index a15c4f28c..c26f34cbc 100644 --- a/reference/storefront_tokens.v3.yml +++ b/reference/storefront_tokens.v3.yml @@ -4,9 +4,9 @@ info: description: |- Get and manage tokens used to authenticate cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). - ## [API tokens](/docs/storefront-auth/tokens#create-a-token) + ## [API tokens](/docs/rest-authentication/tokens#create-a-token) - Generate tokens (JWT) for authenticating cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). To [create a token](/docs/storefront-auth/tokens#create-a-token), send a `POST` request to `/stores/{{STORE_HASH}}/v3/storefront/api-token`. + Generate tokens (JWT) for authenticating cross-origin requests to the [GraphQL Storefront API](/docs/storefront/graphql). To [create a token](/docs/rest-authentication/tokens#create-a-token), send a `POST` request to `/stores/{{STORE_HASH}}/v3/storefront/api-token`. ```http POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/storefront/api-token @@ -29,7 +29,7 @@ info: |`expires_at`|int| Unix timestamp in seconds (required). Does not support milliseconds, microseconds, or nanoseconds. | |`allowed_cors_origins`|array[str]| Allowed origins for cross origin requests (required) | - [**Response:**](/docs/storefront-auth/tokens#create-a-token) + [**Response:**](/docs/rest-authentication/tokens#create-a-token) ```json { @@ -42,9 +42,9 @@ info: - ## [Customer impersonation tokens](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) + ## [Customer impersonation tokens](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token) - Generate tokens that can make queries from the perspective of a particular customer in headless or server-side code using the [GraphQL Storefront API](/docs/storefront/graphql#customer-impersonation-tokens). To [create a customer impersonation token](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token), send a `POST` request to `/v3/storefront/api-token-customer-impersonation`. + Generate tokens that can make queries from the perspective of a particular customer in headless or server-side code using the [GraphQL Storefront API](/docs/storefront/graphql#customer-impersonation-tokens). To [create a customer impersonation token](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token), send a `POST` request to `/v3/storefront/api-token-customer-impersonation`. ```http POST https://api.bigcommerce.com/stores/{STORE_HASH}/v3/storefront/api-token-customer-impersonation @@ -53,7 +53,7 @@ info: Content-Type: application/json ``` - [**Response:**](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) + [**Response:**](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token) ```json { @@ -65,7 +65,7 @@ info: } ``` - Customer impersonation token authenticated requests made to the GraphQL API receive store information from the perspective of the customer with the ID specified in the `X-Bc-Customer-Id` header sent with the GraphQL `POST` request. Pricing, product availability, customer account, and customer details will be reflected. Consider this sample request using a [customer impersonation token](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token) to run a request in the context of customer ID `123`. + Customer impersonation token authenticated requests made to the GraphQL API receive store information from the perspective of the customer with the ID specified in the `X-Bc-Customer-Id` header sent with the GraphQL `POST` request. Pricing, product availability, customer account, and customer details will be reflected. Consider this sample request using a [customer impersonation token](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token) to run a request in the context of customer ID `123`. ```http POST https://store.example.com/graphql @@ -85,7 +85,7 @@ info: ## Revoking tokens - To [revoke a token](/docs/storefront-auth/tokens#revoke-a-token), send a `DELETE` request to `/v3/storefront/api-token`. + To [revoke a token](/docs/rest-authentication/tokens#revoke-a-token), send a `DELETE` request to `/v3/storefront/api-token`. ```http DELETE /stores/{{STORE_HASH}}/v3/storefront/api-token-customer-impersonation @@ -190,7 +190,7 @@ paths: - Customer Impersonation Token summary: Create a Token description: |- - Returns a Storefront API token that allows your application to impersonate customers when making GraphQL `POST` requests. For more information on how to use the returned token, see [customer impersonation tokens](/docs/storefront-auth/tokens/customer-impersonation-token#create-a-token). + Returns a Storefront API token that allows your application to impersonate customers when making GraphQL `POST` requests. For more information on how to use the returned token, see [customer impersonation tokens](/docs/rest-authentication/tokens/customer-impersonation-token#create-a-token). **Required Scopes** * `Manage` `Storefront API Customer Impersonation Tokens`