-
Notifications
You must be signed in to change notification settings - Fork 52
DEVDOCS-6492 - Document GraphQL promotion banners API usage #1099
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bc-terra
wants to merge
5
commits into
main
Choose a base branch
from
DEVDOCS-6492
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
55e5b4c
DEVDOCS-6492 - Document GraphQL promotion banners API usage
bc-terra b9d4e05
Merge branch 'main' into DEVDOCS-6492
bc-terra 79e8cd2
Update docs/storefront/graphql/banners.mdx
bc-terra 067ac57
Merge branch 'main' into DEVDOCS-6492
bc-terra d00671b
Datatypes were updated
bc-terra File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # Promotion Banners with the GraphQL Storefront API | ||
|
|
||
| BigCommerce's GraphQL Storefront API allows you to query promotional banners that can be displayed throughout the shopper journey. This includes banners for the homepage, product pages, cart, and checkout. | ||
|
|
||
| <Callout type="warning"> | ||
| Banner content is returned as raw HTML. You must treat this content as potentially unsafe. Always sanitize or escape the HTML before rendering it to prevent cross-site scripting (XSS) vulnerabilities. | ||
| </Callout> | ||
|
|
||
| ## Example Usage | ||
|
|
||
| Use the `promotionBanners` query to fetch all available promotion banners for a shopper session. Pass your current cart ID if you want to fetch context-relevant banners for the cart or checkout pages. | ||
|
|
||
| <Tabs items={['Request', 'Response']}> | ||
| <Tab> | ||
|
|
||
| ```graphql filename="Example query: Get all promotion banners" showLineNumbers copy | ||
| query GetPromotionBanners($cartId: String) { | ||
| site { | ||
| promotion { | ||
| banners(cartEntityId: $cartId) { | ||
| content | ||
| locations | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| <Tab> | ||
|
|
||
| ```json filename="Example response: Get all promotion banners" showLineNumbers copy | ||
| { | ||
| "data": { | ||
| "site": { | ||
| "promotion": { | ||
| "banners": [ | ||
| { | ||
| "content": "product promotion banner", | ||
| "locations": ["PRODUCT_PAGE"] | ||
| }, | ||
| { | ||
| "content": "homepage promotion banner", | ||
| "locations": ["HOME_PAGE"] | ||
| }, | ||
| { | ||
| "content": "promotion banner on home and product page", | ||
| "locations": ["HOME_PAGE", "PRODUCT_PAGE"] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Key Points | ||
|
|
||
| - **Sanitize HTML**: Banners are delivered as raw HTML strings. Always sanitize these strings before rendering in your storefront to protect against XSS attacks. | ||
| - **Dynamic Content**: The returned banners may change depending on the shopper’s session, cart contents, or other dynamic factors. | ||
| - **`cartId` Parameter**: Pass the current cart ID for cart/checkout-specific banners. | ||
|
|
||
| ## Additional Resources | ||
| - [GraphQL Storefront API Reference](/graphql-storefront/reference#group-Operations-Queries) | ||
| - [GraphQL Storefront API overview](/docs/storefront/graphql) | ||
| - [Best Practices for Using GraphQL APIs](/docs/storefront/graphql/best-practices) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.