querystring
Editable GraphQL query sent to the Storefront API.
Default "query BCSearchProducts($filters: SearchProductsFiltersInput!, $sort: SearchProductsSortInput, $first: Int!, $after: String) {\n site {\n search {\n searchProducts(filters: $filters, sort: $sort) {\n products(first: $first, after: $after) {\n pageInfo { hasNextPage endCursor }\n edges {\n cursor\n node {\n entityId name sku path\n defaultImage { url(width: 400) altText }\n prices { price { value currencyCode } salePrice { value currencyCode } }\n availabilityV2 { status }\n brand { name }\n categories { edges { node { name } } }\n }\n }\n }\n filters {\n edges {\n node {\n name isCollapsedByDefault\n ... on CategorySearchFilter { name displayProductCount categories { edges { node { entityId name productCount isSelected subCategories { edges { node { entityId name } } } } } } }\n ... on BrandSearchFilter { name displayProductCount brands { edges { node { entityId name productCount isSelected } } } }\n ... on PriceSearchFilter { name selected { minPrice maxPrice } }\n }\n }\n }\n }\n }\n }\n}"
variablesstring
JSON object of query variables — filters.searchTerm is required; also supports filters.categoryEntityId, filters.brandEntityIds, filters.price.{minPrice,maxPrice}, sort, first, after.
Default "{\n \"filters\": { \"searchTerm\": \"blue running shoes\" },\n \"sort\": \"RELEVANCE\",\n \"first\": 20\n}"
fullResponseboolean
Return BigCommerce's whole { data, errors } body and status unchanged — for passing a response straight back to a GraphQL client. When off, data is unwrapped (read fields at response.data.<field>) and GraphQL errors fail the step.
Default false
forwardAllHeadersboolean
If enabled, all headers from the incoming request will be forwarded to BigCommerce. Headers below override forwarded ones.
Default false
headerskeyvalue
HTTP headers to include in the request to BigCommerce
