Env Values

Required For Admin

ValueDescription
SHOPIFY_APP_URLThe url to your store (no https://)
SHOPIFY_ADMIN_TOKENThe Admin API access token you received when generating your app
SHOPIFY_AUTH_KEYThe Admin API key found when creating your private app. This is optional and only required if you want to use the REST API.
SHOPIFY_AUTH_PASSWORDThe Admin API password found when creating your private app. This is optional and only required if you want to use the REST API.

Required For Frontend

If you are using the JavaScript publishable in the addon you'll need to set the following.

ValueDescription
SHOPIFY_APP_URLThe url to your myshopify.com store (no https://)
SHOPIFY_STOREFRONT_URLThe custom url to your store if you have one (no https://)
SHOPIFY_STOREFRONT_TOKENFound in the configuration section of your Headless Sales Channel

Required For Webhooks

If you are using the webhook handlers you'll need the following.

ValueDescription
SHOPIFY_WEBHOOK_SECRETFound when creating your first notification. Read more about this here

Optional

These allow you to tweak how the system works. Please check out the config/shopify.php for a full list of options.

ValueDescription
SHOPIFY_API_VERSIONThe version of the storefront and admin APIs you want to target (defaults to '2025-04').
SHOPIFY_ASSET_CONTAINERThe asset container you want to use to store assets (defaults to 'shopify')
SHOPIFY_ASSET_PATHThe path in the container you want to use to store assets (defaults to '').
SHOPIFY_COLLECTION_HANDLEThe handle of the collection that contains your Shopify products, defaults to 'products'.
SHOPIFY_JOB_QUEUEThe queue to run the shopify jobs on. Allows you to set it to a different one than the default.
SHOPIFY_SALES_CHANNELThe Sales Channel to use for product availability, defaults to 'Online Store'.
SHOPIFY_TAXONOMY_COLLECTIONSThe taxonomy handle to use for shopify collections (defaults to 'collections').
SHOPIFY_TAXONOMY_TAGSThe taxonomy handle to use for 'tags' of product (defaults to 'tags').
SHOPIFY_TAXONOMY_TYPEThe taxonomy handle to use for 'types' of product (defaults to 'type').
SHOPIFY_TAXONOMY_VENDORThe taxonomy handle to use for 'vendors' of product (defaults to 'vendor').
Edit this page on GitHub Updated at Tue, Jul 29, 2025