BigCommerce Stencil: get product data as JSON via a dummy template, not debug context

TL;DR

Passing debug context params worked locally under stencil start but broke once the theme was bundled and uploaded, because the debug tools are disabled in production.

Steps

1. When you need product data as JSON from Stencil utils on a live BigCommerce theme, dont rely on the debug context param, it only works in a local stencil start. Create a dummy Handlebars template that references just the fields you want and renders them through the built-in json helper, then call the Stencil API against that template. You get clean JSON in production without the debug tooling.

When to use

You are seeing this: When you need product data as JSON from Stencil utils on a live BigCommerce theme, dont rely on the debug context param, it only works in a local stencil start. Use this skill when you run into "BigCommerce Stencil: get product data as JSON via a dummy template, not debug context".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

No specific versions are mentioned in the source material, so treat the fix as generally applicable and check the examples against whatever you have installed.

Why this happens

The original report does not dig into a root cause. It documents the symptom and the fix that resolved it.

Source: Stack Overflow #35090421 (accepted answer, 5 votes): the asker used stencil-utils getById and wanted the product data as JSON instead of an HTML template. Passing debug context params worked locally under stencil start but broke once the theme was bundled and uploaded, because the debug tools are disabled in production. BigCommerce support's proposed workflow: use a dummy Handlebars template containing only the variables you need, rendered through the custom json helper that stringifies them.

Verified resolution: When you need product data as JSON from Stencil utils on a live BigCommerce theme, dont rely on the debug context param, it only works in a local stencil start. Create a dummy Handlebars template that references just the fields you want and renders them through the built-in json helper, then call the Stencil API against that template. You get clean JSON in production without the debug tooling.

Source URL: https://stackoverflow.com/questions/35090421/retrieve-product-information-as-json-with-stencil-utils