Get started with engage
To get the most out of engage, you need to provide data such as your product catalog and orders, along with event data such as when a user completes an order. Events are simple to implement using our event tracker described further down on this page. But let's start with the order and product data required.
Are you using Shopify, Prestashop or Woocommerce? Then you can use our ready-made extensions to get started in minutes. No need to do any of the setup described below.
You may provide this data using our API, plugins or by uploading the data in csv files. If you decide to use the API it is recommended to send both historical order data and new orders as they come in. If you instead opt to use the file upload you may start with the historical order data and then incrementally add new data once a week or so. Recommended frequency of new data is every 3rd day, but once a week works well too.
You may use file upload and / or the API as you see fit. You can for example send historical data using file upload and provide new orders using the API.
The following plugins take care of the entire setup for you. Simply install and connect your store.
engage currently only requires two data objects in addition to the data captured from the events.
Example of an API call to add an order.
curl --location --request POST 'https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/orders'--header 'Authorization: Bearer [ADD YOUR USER TOKEN HERE]' \--header 'Content-Type: application/json'--data-raw '{"city": "New York","country": "USA","currency": "USD","date_created_gmt": "2020-01-01 20:20:01+01:00","email": "[email protected]","order_id": 20200101,"status": "completed","order_value": 40.00,"line_items":[{"line_item_product_id": 1002,"line_item_price": 17.49,"line_item_quantity": 1,"line_item_name": "Any name","line_item_sku": "sku 123","line_item_variation_id": 1234,"line_item_subtotal": 17.49,"line_item_total": 17.49,"line_item_tax_class": "Class A","line_item_subtotal_tax": 0,"line_item_total_tax": 0}]}'
Example of an API call to add a product
curl --location --request POST 'https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog'--header 'Authorization: Bearer [ADD YOUR USER TOKEN HERE]' \--header 'Content-Type: application/json'--data-raw '{"currency": "USD","image": "https://some-image-url.com","link": "https://a-link-to-the-product.com","product_id": 20200101,"name": "My new product","price": 29.99,}'
Read the API documentation and get more examples here:
engage currently only requires two data files in addition to the data captured from the events.
orders.csv
products.csv
Read all about uploading the data files here:
Follow the Get Started With Events guide to setup event tracking.
