Skip to content

Commit

Permalink
DEVDOCS-5505: [Update] Clarified text re. correlating request and edi…
Browse files Browse the repository at this point in the history
…torial updates
  • Loading branch information
bc-traciporter authored Sep 28, 2023
1 parent 70880b5 commit 2ee3049
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/api-docs/headless/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ This is the first article in a comprehensive developer's guide to using BigComme

## Ways to implement headless commerce

If you are looking to build a headless storefront powered by a BigCommerce backend without starting from scratch, BigCommerce offers multiple starter apps and pre-built solutions to choose from. For headless storefront solutions and tools, see [Headless Integrations](/tools-resources#headless-integrations).
If you want to build a headless storefront powered by a BigCommerce backend without starting from scratch, BigCommerce offers multiple starter apps and pre-built solutions. For headless storefront solutions and tools, see [Headless Integrations](/tools-resources#headless-integrations).

If you need to build a custom solution, BigCommerce has APIs and [SDKs](/tools-resources#sdks) available to support your headless architecture. For specific use cases, see the following sections of the guide:
If you need to build a custom solution, BigCommerce has APIs and [SDKs](/tools-resources/tools#sdks) available to support your headless architecture. For specific use cases, see the following sections of the guide:

* [Create a channel and a channel site](/api-docs/storefronts/guide/channels)
* [Fetch and manage product data](/api-docs/storefronts/guide/products)
Expand All @@ -35,7 +35,7 @@ In the diagram below, the storefront is where the shopper interacts with product

## Correlating requests

Completing an operation on a headless storefront may require several API calls. For example, [processing a payment](/api-docs/store-management/payments-api-overview) and [refunding an order](/api-docs/store-management/order-refunds) each require reading and writing information using multiple endpoints. When you perform a multi-part operation on a headless storefront, group the constituent requests by generating one UUID to represent the whole operation, then use the `X-Correlation-Id` request header to send that UUID with every request in the group. This indicates to BigCommerce's infrastructure that an API call is part of a larger operation, and helps us track the handoff from request to request as the operation moves through our servers. To learn more about the header, see our [list of request headers](/api-docs/getting-started/about-our-api#bigcommerce-specific-request-headers).
Completing an operation on a headless storefront may require several API calls. For example, [processing a payment](/api-docs/store-management/payments-api-overview) and [refunding an order](/api-docs/store-management/order-refunds) each require reading and writing information using multiple endpoints. When you perform a multi-part operation on a headless storefront, group the constituent requests by generating one UUID to represent the whole operation, then use the `X-Correlation-Id` request header to send that UUID with every request in the group. The value you pass to the `X-Correlation-Id` header should be a UUID-type string you generate independently. This indicates to BigCommerce's infrastructure that an API call is part of a larger operation and helps us track the handoff from request to request as the operation moves through our servers. To learn more about the header, see our [list of request headers](/api-docs/getting-started/about-our-api#bigcommerce-specific-request-headers).

When you're using the BigCommerce for WordPress plugin, there is no need to send the `X-Correlation-Id` header.

Expand Down

0 comments on commit 2ee3049

Please sign in to comment.