shopify.utils.sanitizeShop

October 2, 2023 · View on GitHub

This method makes user inputs safer by ensuring that a given shop value is a properly formatted Shopify shop domain.

Note: if you're using custom shop domains for testing, you can use the customShopDomains setting to add allowed domains.

Example

const shop = shopify.utils.sanitizeShop(req.query.shop, true);

string | :exclamation: required

The incoming shop value.

boolean | Defaults to false

If true, throws an error when the shop is invalid.

string | null

The shop value if it is a properly formatted Shopify shop domain, otherwise null.