Skip to main content
All CollectionsIntegrationsMagento Open Source and Adobe CommerceData syncing
Synchronise order insight data in Magento Open Source and Adobe Commerce
Synchronise order insight data in Magento Open Source and Adobe Commerce

Synchronise your order data to your Dotdigital account.

Gareth Burroughes avatar
Written by Gareth Burroughes
Updated over a year ago

The connector fully utilises the Dotdigital OrderInsight module. Enabling this feature lets you synchronise your customers' order information and current basket contents. This allows for deep segmentation within Dotdigital, enabling highly targeted marketing.

Orders are synced and batched once they are created. They are also updated within Dotdigital when any modifications are made to the quote after their creation.


Before you start

Things you need to know:

  • To synchronise your customers' order information, you first require the Insight collection working in your account. Speak with your Customer Success representative to have this enabled for you.


Enable order data syncing

  1. Go to Stores > Configuration > DOTDIGITAL > Sync Settings and find the heading Sync.

  2. Expand the Order Enabled drop-down menu and select YES.

  3. Select Save Config in the top right. A confirmation message appears to show that the settings have been saved and the synchronisation begins. Once this has finished the order data becomes available in your Dotdigital account.


List of synced order data

The order data that is synced includes:

ID

The database ID for the order

(text)

order_total

The total amount the customer paid

(numerical)

payment

The payment method the customer used

(text)

delivery_method

The delivery method selected

(text)

delivery_total

The amount paid for delivery

(numerical)

currency

The currency the order was placed in

(text)

couponcode

The coupon code used on the order if applicable

(text)

order_status

The current status of the order

(text)

email

The email address of the contact who placed the order

(text)

store_name

The store name the order was placed on

(text)

quote_id

The database quote ID the order was created from

(text)

purchased_date

The date and time of the order

(date)

billing_address

The address that the payment method is registered to:

  • billing_address_1

  • billing_address_2

  • billing_city

  • billing_country

  • billing_postcode

(text)

delivery_address

The address that the order is delivered to:

  • delivery_address_1

  • delivery_address_2

  • delivery_city

  • delivery_country

  • delivery_postcode

(text)

order_subtotal

The order subtotal

(numerical)

base_subtotal_incl_tax

The order subtotal including tax

(numerical)

discount_amount

The total amount discounted on the order

  • This should be a positive value.

(numerical)

Details for the billing and shipping address used to place the order are also synced.

Furthermore, the following information is synced for every product within the order:

name

The name of the product

(text)

price

The price paid for the product

(numerical)

sku

The SKU of the product

(text)

qty

The quantity of the product purchased

(numerical)

attribute-set

The attribute set assigned to the product

(text)

categories

The categories associated with the product:

  • name

(array)


Order Sync Settings

Import Status

You can choose to only import and synchronise orders of a certain status, rather than all of them. For example, you might only be interested in sending campaigns or running segments based on orders that have been fulfilled. In this case, you might only want to import orders in a Complete status.

To choose your order import status:

  1. Go to Stores > Configuration > DOTDIGITAL > Configuration and find the heading Transactional Data.

  2. For Import Order With Status, select the order statuses you want to import.

    To choose multiple, hold down the CTRL key on your keyboard.

    import-order-status.png
  3. Select Save Config.

Custom Attributes

In addition to our standard default order data fields, you have the option to synchronize custom order attributes. This list comprises all of the order attributes that are available within your store's system, allowing you to segment and send content based upon these too.

To choose your order custom attributes status:

  1. Go to Stores > Configuration > DOTDIGITAL > Configuration and find the heading Transactional Data.

  2. For Order Custom Attributes, select the attributes you want to import.

    To choose multiple, hold down the CTRL key on your keyboard.

    order-custom-attributes.png

  3. Select Save Config.


Troubleshooting

Order sync is enabled but nothing is displaying in Dotdigital

This could be for the following reasons:

  • You do not have valid API credentials or saved details.

  • OrderInsight is not enabled on your account.

  • Cron is not running on your site.

  • The importer is currently processing other imports and hasn't got to the order import yet.

  • The order statuses selected for import do not match the statuses your orders go through.

Order data is displayed in Dotdigital but some of the values for orders are empty

This could be for the following reasons:

  • The data doesn't exist for that order, for example, the delivery amount wasn't paid.

  • The source data in your store no longer exists, for example, you had old payment methods in your store that no longer exist

Order data is marked as imported in the store but not displaying in Dotdigital

Insight data can take several minutes to import and show in Dotdigital, even after a sync is complete. You might want to ensure you don't already have order data imported with matching IDs, perhaps coming from a staging site, as this key must be unique.

Did this answer your question?