Skip to content
weLabsweLabsStorefront Playbook
Live demoQuickstart

Reference

Reference

Look-up tables for the storefront and the Companion plugin, from environment variables and routes to hooks, constants and common questions.

Exhaustive, terse pages for looking things up. For step-by-step guides, use Storefront setup or Store admin.

Storefront

Section titled “Storefront”
Environment variablesEvery variable the storefront reads, with defaults and examples.
RoutesEvery page and API route, public or private, and how Locale prefixes work.
Demo dataDemo account, coupon, test cards, preview links and the seeded catalogue.

Companion plugin

Section titled “Companion plugin”
REST APIThe Companion plugin's endpoints under retail-store-companion/v1.
Hooks and filtersFilters and actions developers can use to extend the plugin.
wp-config constantsSecrets and pinned settings defined in wp-config.php.

Questions

Section titled “Questions”
FAQAnswers for clients, store owners and delivery teams.
GlossaryThe terms used throughout these docs.
Storefront Playbook · Built by weLabsFeaturesFAQTalk to us