Shopify extension Splio: Marketing Automation
Prerequisites
- The Splio app must be installed from the Shopify App Store before any configuration
- Have your Splio configuration details ready: universe ID, Configuration ID and API key (from the Splio platform)
Step 1 — Create the metafield definition
The SDK reads its configuration from a JSON metafield attached to the Shopify page. First, create the metafield definition.
- Go to Shopify Admin > Settings > Custom data > Pages > Metafields
https://admin.shopify.com/store/{store}/settings/custom_data/page/metafields - Create a new metafield with the following settings:
- Name:
splioSDK.configurationsMap - Type: JSON
- Name:
Step 2 — Create the page
- Go to Shopify Admin > Online Store > Pages
- Create a new page (e.g. "Loyalty")
- Note the page slug (e.g.
/pages/loyalty) — it will be used for thereturn_toparameter
Step 3 — Set the metafield value on the page
- Open the page created in step 2 in Shopify Admin > Online Store > Pages
- Scroll down to the Metafields section
- Fill in the
splioSDK.configurationsMapfield with the following JSON payload:
{
"fr": {
"id": "your_configuration_id_fr",
"apiKey": "your_api_key_fr"
},
"en": {
"id": "your_configuration_id_en",
"apiKey": "your_api_key_en"
}
}The top-level key corresponds to the locale ISO code (
fr,en, etc.). If the visitor's locale is not found, the SDK uses the first entry as a fallback.
Step 4 — Add the block in the theme editor
- Go to Online Store > Themes > Customize
- Navigate to the page created in step 2
- Add the Splio Loyalty Web Kit block to a section
- Configure the block settings (see step 5)
Step 5 — Configure the block
Required settings
| Setting | Description |
|---|---|
| Splio Universe | Your Splio universe ID |
| Display mode | inline, popup or widget |
External ID source
Defines which Shopify customer data is used as the unique identifier in Splio.
| Option | Description |
|---|---|
Email | Customer email (default) |
Phone | Phone number |
Shopify Customer ID | Shopify internal customer ID |
Customer metafield | Value from a custom customer metafield |
Using a customer metafield as external ID
If the Splio identifier is stored in a customer metafield:
- Go to Shopify Admin > Settings > Custom data > Customers > Metafields
- Create or identify the metafield containing the ID (e.g.
splio_id,shp_id...) - In the block, select External ID source →
Customer metafield - Fill in the Metafield key field using the
namespace.keyformat- Example:
custom.splio_id
- Example:
If the metafield is not set on the customer, the SDK falls back to the email.
Optional settings
| Setting | Description |
|---|---|
| Card code | Required only if your loyalty program does not auto-generate card codes |
| List IDs | Comma-separated list IDs for opt-in on contact creation. Example: 3,4,16. Cannot be updated after creation. |
| Hide if logged out | Hides the block if the customer is not logged in |
Step 6 — Configure redirect URLs on the Splio platform
In the SDK configuration on the Splio platform, update the signin and signup URLs.
Legacy accounts (before Shopify migration)
"unconnected": {
"signin": "https://{store}.myshopify.com/account/register",
"signup": "https://{store}.myshopify.com/account/login"
}New customer accounts (after Shopify migration)
"unconnected": {
"signin": "https://{store}.myshopify.com/customer_authentication/login?return_to=/pages/{loyalty-page}",
"signup": "https://{store}.myshopify.com/customer_authentication/login?return_to=/pages/{loyalty-page}"
}The return_to parameter must point to the slug of the page created in step 2.
After login, Shopify redirects the customer to that page and the SDK enrolls them in the program.
With new customer accounts,
/account/registerno longer exists. Both login and registration go through the same/customer_authentication/loginendpoint.
Updated 1 day ago