Integrations
Shopify is an ecommerce platform that has everything you need to sell online, on social media, or in person. The mParticle Shopify integration uses Webhooks.
Execute the following steps in mParticle platform and in Shopify to enable the integration
The following steps must be executed in mParticle’s platform
Input the configuration parameters
This Webhook URL will be used in steps concerning Shopify’s Webhook creation
Ensure you have signed up for a Shopify account, and verify you have access to the Shopify admin dashboard. The Admin dashboard can be reached by going to https://admin.shopify.com/store/mydemostore
, where mydemostore
is the name you chose for your store when created.
Event
, select one of the Supported Events by mParticleFormat
, select JSON
URL
, paste the Webhook URL that was generated in Input Feed Creation sectionFor Webhook API version
, select 2023-07
2023-07
is not available, select the most recent stable version.If you want to know more technical details, please review Shopify webhooks
Each webhook within Shopify should display a Send test notification button after creation. When clicked, Shopify will send a test notification to mParticle which should be visible in the mParticle Live Stream.
These are the mParticle supported events that can be used when you Create Webhook for a Shopify Topic
Shopify Event | Shopify Topic |
---|---|
Checkout | checkouts/create , checkouts/update |
Customer | customers/create , customers/disable , customers/enable , customers/update |
Draft Order | draft_orders/create , draft_orders/update |
Fulfillment | fulfillments/create , fulfillments/update |
Order | orders/cancelled , orders/create , orders/fulfilled , orders/paid , orders/partially_fulfilled , orders/updated |
Customer events are mapped to Custom Events of type other
and events names:
Shopify Topic | mParticle Event Name |
---|---|
customers/create |
create_customer |
customers/disable |
disable_customer |
customers/enable |
enable_customer |
customers/update |
update_customer |
All other events are mapped to Product Action Commerce Events:
Shopify Topic | mParticle Product Action |
---|---|
orders/cancelled |
refund |
orders/create |
checkout |
orders/fulfilled |
checkout |
orders/paid |
purchase |
orders/partially_fulfilled |
checkout |
orders/updated |
checkout |
fulfillments/create |
checkout |
fulfillments/update |
checkout |
draft_orders/create |
checkout |
draft_orders/update |
checkout |
product.id
. The Shopify product_id
and key fields will be set as product custom attributes.The following Shopify fields will be set as event custom attributes:
{
"tags": [
"Barnes & Noble",
"John's Fav",
"Big Air"
]
}
{
"tags": "Barnes & Noble, John's Fav, Big Air"
}
{
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
}
}
{
"price_set.shop_money.amount": "199.00",
"price_set.shop_money.currency_code": "USD",
"price_set.presentment_money.amount": "199.00",
"price_set.presentment_money.currency_code": "USD"
}
mParticle will map user properties to User Attributes. All other user properties will be stored as user attributes prefixed with shopify_
Shopify Field | mParticle field |
---|---|
default_address.address1, default_address.address2 | $address |
default_address.city | $city |
default_address.country_code | $country |
first_name | $firstname |
last_name | $lastname |
default_address.zip | $zip |
Was this page helpful?