# Shopify The Commanders Act application, which is available in the [Shopify App Store](https://apps.shopify.com/commanders-act), helps merchants streamline their workflows by connecting Shopify events with partners. Whether you’re tracking customer interactions, or optimizing ad performance, our app simplifies the process. By intercepting Shopify Standard and Custom events, the Commanders Act application seamlessly integrates with your existing stack while leveraging Shopify Customer Privacy API. This means less manual setup and more secure data collection. ## Key features * Connect [Shopify standard](https://shopify.dev/docs/api/web-pixels-api/standard-events) and custom events with your partners. * Enable reliable server-side tracking capabilities via [destinations](https://doc.commandersact.com/getting-started/concepts#destination). * Ensure user privacy by supporting [Shopify Customer Privacy API](https://shopify.dev/docs/api/customer-privacy). * Preserve original Shopify event data. * User-friendly configuration. * Include debugging functionality for troubleshooting. ## Source setup 1. Log in into your [Commanders Act account](https://app.commandersact.com/). 2. From the left menu, click on `(1)` `Sources` to expand the section:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-02b8a1d8d84be72d5bd313ed519fbe7cc1c211e0%2Fshopify_1.png?alt=media)\\ 3. Click `(2)` `Source catalog` :\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-70e8be7c818db6ac22e97908b91741c1b3f91487%2Fshopify_2.png?alt=media)\\ 4. In the search box, type `(3)` "Shopify" and click the `(4)` `Shopify web` on the right:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-2759977946f8756aed70b6d9e275c7870125f28c%2Fshopify_3.png?alt=media)\\ 5. Click on `(5)` `Configure` :\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-dfcf097df72d51dadae0a19416af8eee678960ba%2Fshopify_6.png?alt=media)\\ 6. Input `(6)` a name for your source, select `(7)` an environment and click `(8)` `Next` :\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-a9defb81cb342a16dc0e636bac3a72991815fb64%2Fshopify_7.png?alt=media)\\ 7. If you already have destinations up and running, you can connect them with your Shopify source by clicking the `(9)` top checkbox or by `(10)` selecting which one of them you want to link:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-91ae4224831b09e7800f475f35ad7f28fbbf8dfb%2Fshopify_9.png?alt=media)\\ 8. Scroll down to the bottom and click `Save`. 9. Take note of your `(11)` `Site/Account Id` and `(12)` `Source Key` :\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-b149e600f3d140f6a3c49e83051de1ddcf64f3de%2Fshopify_10.png?alt=media)\ \ You're going to use both values in the next section: [App setup](#app-setup). ## App setup 1. Open our [application URL in Shopify App Store](https://apps.shopify.com/commanders-act). 2. Install the app by clicking the `(1)` `Install` button:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-4828ef9ad6c54cf9de034a626c4d609e51e9f62e%2Fshopify_4.png?alt=media)\\ 3. Configure the app by providing both the `(2)` `Site/Account Id` and `(3)` `Source Key` from the source you created in the section [Source setup](#source-setup) (See the above step 9.) and then turn `(4)` the toggle green to activate your app configuration:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-eb87dce3ab0cab604f9935e8acec0a307ecebbe4%2Fshopify_5.png?alt=media)\\ 4. Click `Save` to complete the setup and activate the app. See the next section [Validate your setup](#validate-your-setup) to ensure tracking is activated. {% hint style="info" %} At any point in time, you can deactivate the app by turning the `(4)` toggle off/red and click `Save` . {% endhint %} ## Validate your setup 1. Log in into your [Commanders Act account](https://app.commandersact.com/). 2. From the left menu, click on (1) `Sources` to expand the section:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-02b8a1d8d84be72d5bd313ed519fbe7cc1c211e0%2Fshopify_1.png?alt=media)\\ 3. Click (2) `Overview` :\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-d946064283ee22bb755ac6e6cb2622b13d9cfb16%2Fshopify_11.png?alt=media)\\ 4. In the search box, type (3) the name of your source and (4) click it:\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-c8f6514b91d8031a31b615cdcd5cc1e95cfac1f1%2Fshopify_12.png?alt=media)\ \ You may already have the (5) `Trend` showing a peak meaning that events are coming in. 5. Click (6) `Event Inspector` :\ \ ![](https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-3346a24347b0756c0e8496d433cf2fbbdb1672fb%2Fshopify_13.png?alt=media)\\ 6. Check for reported log/entries.\\ ## Quick reference {% hint style="info" %} The following table shows the mapping between Commanders Act and Shopify events.\ Custom Shopify events are also forwarded to Commanders Act with the same original Shopify event name. {% endhint %} | Shopify Events | Commanders Act Events | | ---------------------------------- | ----------------------------- | | `cart_viewed` | `view_cart` | | `checkout_completed` | `purchase` | | `checkout_shipping_info_submitted` | `add_shipping_info` | | `checkout_started` | `begin_checkout` | | `collection_viewed` | `view_item_list` | | `page_viewed` | `page_view` | | `payment_info_submitted` | `add_payment_info` | | `product_added_to_cart` | `add_to_cart` | | `product_removed_from_cart` | `remove_from_cart` | | `product_viewed` | `view_item` | | `search_submitted` | `search` | | `[Custom Shopify event name]` | `[Custom Shopify event name]` | ## Field mappings {% hint style="info" %} All Shopify properties are retrieved from the `event` property.\ The original Shopify event data, with all its properties, is stored in the Commanders Act property `partners.shopify.event` . {% endhint %}
Shopify PropertiesCommanders Act Properties
analytics.subscribe(...)event_name [1]

data.checkout.order.id

data.element.id

id

data.checkout.subtotalPrice.amount

data.cartLine.cost.totalAmount.amount

data.cart.cost.totalAmount.amount

value
data.checkout.totalPrice.amountrevenue
data.checkout.shippingLine.price.amountshipping_amount
data.checkout.totalTax.amounttax_amount

data.checkout.currencyCode

data.cartLine.cost.totalAmount.currencyCode

data.cart.cost.totalAmount.currencyCode

currency
context.document.location.hrefurl
context.document.titlepage_title
context.document.location.hrefcontext.page.url
context.navigator.languagecontext.page.lang
context.navigator.userAgentcontext.device.user_agent
data.searchResult.querysearch_term
data.checkout.transactions.0.paymentMethod.typepayment_method [2]
data.checkout.discountApplications.X.titlecoupon
data.checkout.order.customer.iduser.id
data.checkout.order.customer.isFirstOrderuser.status [3]

data.checkout.shippingAddress.firstName

data.checkout.billingAddress.firstName

user.firstname

data.checkout.shippingAddress.lastName

data.checkout.billingAddress.lastName

user.lastname
data.checkout.emailuser.email

data.checkout.phone

data.checkout.shippingAddress.phone

user.phone

data.checkout.shippingAddress.address1 + data.checkout.shippingAddress.address2

data.checkout.billingAddress.address1 + data.checkout.billingAddress.address2

user.street

data.checkout.shippingAddress.city

data.checkout.billingAddress.city

user.city

data.checkout.shippingAddress.countryCode

data.checkout.billingAddress.countryCode

user.country

data.checkout.shippingAddress.province

data.checkout.billingAddress.province

user.state

data.checkout.shippingAddress.zip

data.checkout.billingAddress.zip

user.zipcode
data.collection.titleitem_list_name

data.checkout.lineItems.X.variant.id

data.checkout.lineItems.X.merchandise.id

data.checkout.lineItems.X.id

data.cart.lines.X.variant.id

data.cart.lines.X.merchandise.id

data.cart.lines.X.id

data.collection.productVariants.X.variant.id

data.collection.productVariants.X.merchandise.id

data.collection.productVariants.X.id

data.searchResult.productVariants.X.variant.id

data.searchResult.productVariants.X.merchandise.id

data.searchResult.productVariants.X.id

data.productVariant.product.id

data.cartLine.merchandise.product.id

items.X.id [4]

data.checkout.lineItems.X.variant.product.title

data.checkout.lineItems.X.merchandise.product.title

data.checkout.lineItems.X.product.title

data.cart.lines.X.variant.product.title

data.cart.lines.X.merchandise.product.title

data.cart.lines.X.product.title

data.collection.productVariants.X.variant.product.title

data.collection.productVariants.X.merchandise.product.title

data.collection.productVariants.X.product.title

data.searchResult.productVariants.X.variant.product.title

data.searchResult.productVariants.X.merchandise.product.title

data.searchResult.productVariants.X.product.title
data.productVariant.product.title

data.cartLine.merchandise.product.title

items.X.product.name [4]

data.checkout.lineItems.X.variant.price.amount

data.checkout.lineItems.X.merchandise.price.amount

data.checkout.lineItems.X.price.amount

data.cart.lines.X.variant.price.amount

data.cart.lines.X.merchandise.price.amount

data.cart.lines.X.price.amount

data.collection.productVariants.X.variant.price.amount

data.collection.productVariants.X.merchandise.price.amount

data.collection.productVariants.X.price.amount

data.searchResult.productVariants.X.variant.price.amount

data.searchResult.productVariants.X.merchandise.price.amount

data.searchResult.productVariants.X.price.amount
data.productVariant.price.amount

data.cartLine.merchandise.price.amount

items.X.product.price [4]

data.checkout.lineItems.X.quantity

data.cart.lines.X.quantity

data.collection.productVariants.X.quantity

data.searchResult.productVariants.X.quantity
data.cartLine.quantity

items.X.quantity [4]

data.checkout.lineItems.X.variant.product.vendor

data.checkout.lineItems.X.merchandise.product.vendor

data.checkout.lineItems.X.product.vendor

data.cart.lines.X.variant.product.vendor

data.cart.lines.X.merchandise.product.vendor

data.cart.lines.X.product.vendor

data.collection.productVariants.X.variant.product.vendor

data.collection.productVariants.X.merchandise.product.vendor

data.collection.productVariants.X.product.vendor

data.searchResult.productVariants.X.variant.product.vendor

data.searchResult.productVariants.X.merchandise.product.vendor

data.searchResult.productVariants.X.product.vendor

data.productVariant.product.vendor

data.cartLine.merchandise.product.vendor

items.X.product.brand [4]

data.checkout.lineItems.X.discountAllocations.Y.amount.amount

data.cart.lines.X.discountAllocations.Y.amount.amount

data.collection.productVariants.X.discountAllocations.Y.amount.amount

data.searchResult.productVariants.X.discountAllocations.Y.amount.amount

items.X.discount [4]

data.checkout.lineItems.X.discountAllocations.Y.discountApplication.title

data.cart.lines.X.discountAllocations.Y.discountApplication.title

data.collection.productVariants.X.discountAllocations.Y.discountApplication.title

data.searchResult.productVariants.X.discountAllocations.Y.discountApplication.title

items.X.coupon [4]
analyticsProcessingAllowedanalyticsProcessingAllowed [5]
marketingAllowedmarketingAllowed [5]
preferencesProcessingAllowedpreferencesProcessingAllowed [5]
saleOfDataAllowedsaleOfDataAllowed [5]
[Original Shopify event data]partners.shopify.event
{% hint style="info" %} > **\[1]** See Quick reference for more details. \ > \&#xNAN;**\[2]** See supported values [here](https://doc.commandersact.com/developers/tracking-and-integrations/tracking/events-reference#payment-methods). \ > \&#xNAN;**\[3]** Set with "New". \ > \&#xNAN;**\[4]** Value based on the priority list on the left column. \ > \&#xNAN;**\[5]** Property set from the base path `partners.shopify.userConsent`. > {% endhint %}