younifyd
Menu

Storefront: List Products

Page through products via the BigCommerce Storefront GraphQL API — the query is editable, so you decide exactly what comes back

Use it in a workflow

  1. Add a step and choose the BigCommerce Storefront connector.
  2. Pick the Storefront: List Products action (under bigcommerce).
  3. Fill in the fields below, then reference the result from later steps as {{storefrontListProducts.response.data}}.

Fields

querystring

Editable GraphQL query sent to the Storefront API. Pre-filled with a default query listing products with common fields — edit it to change what's returned, or use $variables below for $first/$after and anything else the query declares.

Default "query BCListProducts($first: Int!, $after: String) {\n site {\n products(first: $first, after: $after) {\n pageInfo { hasNextPage hasPreviousPage startCursor endCursor }\n edges {\n cursor\n node {\n entityId id name sku path description\n defaultImage { url(width: 500) altText }\n prices {\n price { value currencyCode }\n salePrice { value currencyCode }\n priceRange { min { value currencyCode } max { value currencyCode } }\n }\n availabilityV2 { status description }\n categories { edges { node { entityId name path } } }\n brand { entityId name }\n }\n }\n }\n }\n}"

variablesstring

JSON object of query variables, e.g. {"first": 20, "after": null}

Default "{\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

Need more? See the BigCommerce Storefront guide for connection setup and behaviour shared by every action.

Storefront: List Products — BigCommerce Storefront — Documentation