querystring
Editable GraphQL query sent to the Storefront API.
Default "query BCGetProductById($entityId: Int!) {\n site {\n product(entityId: $entityId) {\n entityId id name sku description\n defaultImage { url(width: 800) altText }\n prices {\n price { value currencyCode }\n salePrice { value currencyCode }\n }\n availabilityV2 { status description }\n variants(first: 100) {\n edges {\n node {\n entityId sku\n prices { price { value currencyCode } }\n inventory { isInStock }\n options { edges { node { entityId displayName values { edges { node { entityId label } } } } } }\n }\n }\n }\n categories { edges { node { entityId name } } }\n brand { entityId name }\n }\n }\n}"
variablesstring
JSON object of query variables — set entityId to the real product ID.
Default "{\n \"entityId\": 123\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