Dev Center Updates

Change to default number of product images returned by GraphQL on April 15

2022-03-28T20:51:01.973Z

On April 15, 2022, the behavior of the product.images node in the GraphQL storefront API will be changing to only return 10 images by default. If you wish to request a different number of product images, you should specify the `first` argument explicitly with your request, which is considered a best practice when interacting with any paginated collection.

For example, if you were previously sending a request like this:

query productsWithImages {
site {
products {
edges {
cursor
node {
entityId
name
images { // will return 10 images unless explicit arguments are specified
edges {
node {
url(width: 640)
}
}
}
}
}
}
}
}

You could instead send a request like this:

query productsWithImages {
site {
products(first: 5) { // as a best practice, use `first` on all collections to specify page size
edges {
cursor
node {
entityId
name
images (first:20) { // will return up to 20 images per product
edges {
node {
url(width: 640)
}
}
}
}
}
}
}
}

Please note that requesting larger amounts of data with increased page sizes will factor into the GraphQL complexity calculation for your query.

API Updates for December 2, 2021

2021-12-02T15:44:34.430Z

API

The Add to Cart URLs example now uses promises to demonstrate using JavaScript to make serial requests to a single endpoint.
The Add Consignments to Checkout endpoint now reflects limits to the number of line items a consignment can contain.

GraphQL Storefront API can now be used to power Stencil theme context

2021-09-27T21:21:21.779Z

It is now possible to augment the data available in the theme context through the use of GraphQL queries described directly in the Front Matter of template files.

Using this capability, you can fetch data a little bit more flexibly to build your themes.

Here’s an example of using a GraphQL query in Front Matter to fetch metafields in product.html:

---
product:
videos:
limit: {{theme_settings.productpage_videos_count}}
reviews:
limit: {{theme_settings.productpage_reviews_count}}
related_products:
limit: {{theme_settings.productpage_related_products_count}}
similar_by_views:
limit: {{theme_settings.productpage_similar_by_views_count}}
gql: "query productMetafieldsById($productId: Int!) {
site {
product(entityId: $productId) {
metafields(namespace: \"my-namespace\") {
edges {
node {
key
value
}
}
}
}
}
}
"
---

More information on how to use this new storefront capability is available here: https://developer.bigcommerce.com/stencil-docs/reference-docs/front-matter-reference#graphql-attributes

Rendered Widget HTML now available in GraphQL Storefront API

2021-06-22T14:33:23.841Z

You may now fetch the rendered HTML of widgets created via Widgets API or Page Builder.

To get the content, you’ll need to provide a page type, and the ID for the page (if necessary). In the response, you’ll get a list of all the regions on that page, and the HTML of the widgets within those regions. This response can be used to inject Widget content into a headless storefront, or in any other situation where you need to flexibly access the content.

Here’s an example query:

# Get the widget HTML for the home page
query getHomePageContentWidgets {
site {
content {
renderedRegionsByPageType(pageType: HOME) {
regions {
name
html
}
}
}
}
}

GraphQL Storefront API now supports sorting products within categories

2021-05-19T17:53:35.712Z

The GraphQL Storefront API’s now supports sorting the products on a Category node, using the sortBy parameter. This will match the equivalent sorting behaviors on the BigCommerce Storefront (Stencil).

Consider this query:

query CategoryByUrl {
site {
route(path: "/shop-all") {
node {
__typename
id
... on Category {
name
products(first: 20, sortBy: DEFAULT) {
# Use sortBy parameter to use any of the available storefront sorts
edges {
node {
name
defaultImage {
url(width: 360)
}
}
}
}
}
}
}
}
}

GraphQL Login Mutation now returns entire Customer object

2021-05-19T17:53:35.712Z

The GraphQL Storefront API’s Login Mutation now supports fetching all of the details of the customer account after a successful login. Consider this query:

mutation Login($email: String!, $pass: String!) {
login(email: $email, password: $pass) {
result
customer {
entityId
firstName
lastName
email
storeCredit {
value
currencyCode
}
attributes {
attribute(entityId: 123) {
name
value
}
}
}
}
}

UPC, MPN, and GTIN now available in Storefront GraphQL API

2021-03-08T16:11:48.775Z

The UPC, MPN, and GTIN fields are now available on both product and variant nodes in the GraphQL Storefront API

GraphQL Complexity Limit Increased (October 2020)

2020-10-28T18:24:00.001Z

We have once again adjusted the GraphQL Storefront API complexity limit to be more permissive, based on developer feedback.

If you have previously bumped up against the complexity limit for a particular query, you are encouraged to try it again, as it may now be supported.

We will continue to tweak this limit based on feedback from our developer community, in order to strike the right balance between platform performance and the needs of custom storefronts.

GraphQL Storefront API Complexity Scoring Adjusted

2020-07-28T16:22:00.001Z

Based on feedback from our developer community, we’ve adjusted the weighting of our GraphQL Storefront API’s complexity scoring in order to be more permissive. As a result, queries which may have previously been rejected on the basis of complexity may now pass the complexity check and be allowed.

The weighting of several nodes related to product subresources (child nodes of the Product type) have been adjusted, and the product.variants node in particular has been adjusted to support up to 250 variants in one request, from the previous limit of 50.

If you’ve hit the complexity limit in the past, feel free to try your query again to see if it’s now allowed.

We will continue to adjust this limit based on customer feedback as we learn more about how the GraphQL Storefront API is being used, as well as its performance and scalability characteristics.

GraphQL Storefront API - Bulk Pricing on Products and Variants

2020-06-25T01:26:00.001Z

The GraphQL Storefront API now supports fetching the bulk pricing tiers on both products and variants.

Consider this query:

query bulkPricingTiers {
site {
products(first: 3) {
edges {
cursor
node {
entityId
name
prices {
price {
value
currencyCode
}
bulkPricing {
... BulkPricingFields
}
}
variants(first: 3) {
edges {
node {
sku
prices {
price {
value
currencyCode
}
bulkPricing {
... BulkPricingFields
}
}
}
}
}
}
}
}
}
}
fragment BulkPricingFields on BulkPricingTier {
minimumQuantity
maximumQuantity
... on BulkPricingFixedPriceDiscount {
price
}
... on BulkPricingRelativePriceDiscount {
priceAdjustment
}
... on BulkPricingPercentageDiscount {
percentOff
}
}