Orders

Used for:

•  Message Content
•  Building Audiences

Orders Overview

Order data is stored in the orders collection and contains all data related to a purchase event.

The most common order related attributes are provided by default as part of the schema and include: productID, sku, category, etc. Some attributes are set as arrays and can include customizable name/value pairs such as color:blue, size:large, etc. For more information on order attributes and requirements read about order data and the API.

Order data can be used to personalize content in a message and to build an audience.

How Orders Are Stored

Below is a simple example of how an order is stored in the order collection as a JSON object.

[
  {
    "orderID": 1,
    "cID": "55d7294629aa544d75c6b810",
    "purchaseDate": "2015-10-29T15:05:00+0000",
    "items": [
      {
        "productID": "1",
        "sku": "sku",
        "model": "mymodel",
        "category": "garment",
        "name": "dress",
        "qty": 1,
        "amount": 2.5,
        "attr": {
          "color": "blue",
          "size": "xs"
        }
      }
    ]

The example above shows the reserved fields of productID, sku and category as well as an object of customized attributes: color and size.

Importing Orders

An order collection is loaded into Cordial via the API. Learn more about order collections and the API.

Viewing Orders

An order collection can only be viewed via an API call.

To view an orders collection via an API call, read the article about order collections and the API.

Using Orders in a Message

Message content can be personalized with order data using the Smarty getOrders method.

For example, a contact could be sent a message with information on the products they ordered. When displaying product meta data related to an order (images, descriptions, etc), it is recommended to pull that data from the product catalog as it may be more up to date.

Learn more about using Smarty to display order data in message

Building Audiences with Orders

Using the audience builder, you can create audiences of contacts that purchased a certain product. Additional properties about the product can be used to filter the results.

The image below shows the audience rule associated with orders.

For example, you could create an audience of all contacts that have purchased the Super Drill 3000 within the past 30 days and send them a personalize message with recommended product accessories or related products from your catalog.

In the next article learn about supplements.