orderObject

The order object represents order data you can pass into the application. Any field data you use in a message must be smaller than 1 MB.

Name Type Description
id string The unique id for the order.

If the id for the order already exists within the application, then this API call will update that order. However, if the id for the order does not exist within the application then this API call will create a new order.

contactId string

A unique id assigned to the contact placing the order.

Note: If the order id already exists, then this field is ignored and not updated
email string

The email address of the person placing the order.

Note: If a corresponding contact does not exist, then a new one will be created with the status of transactional. If the order id already exists, then this field is ignored and not updated
products productObject[]

Array of the products contained in this order.

Note: This is not required. You can add an order and come back later to fill in the product details. When the order id does already exist:
  • If this is not provided at all (as in null) then it is not replaced
  • If an empty array is provided (as in not null but the array has no values), then all products are removed from the order
  • If an array with values is provided, then all products in the order are replaced with this new set
orderDate dateTime

Date and time of the order.

Note: If no value is provided, the system will times tamp the record. You can (and should) specify a timezone offset if you do not want the system to assume you are providing a time in UTC (Coordinated Universal Time / Greenwich Mean Time). For the Eastern Time Zone on Daylight Savings Time, this would be:

YYYY-MM-DDTHH:MM:SS-04:00

deliveryId string The id of the delivery the order is associated with.
messageId string The id of the message the order is associated with.
automatorId string The id of the automator the order is associated with.
listId string The id of the list the order is associated with.
segmentId string The id of the segment the order is associated with.
deliveryType string The type of delivery the order resulted from. Valid values are:
  • normal
  • test
  • transactional
  • automated

If you are on the old order service and you try to pass a type that is not one of the 4 valid types then type will be ignored.

tid string

Unique id that associates an order with a specific contact and delivery. Since this ties the order back to a delivery, it is then classified as a conversion for that specific delivery.

Note: The tid can only be pulled from the Bronto tracking cookie, which requires that Conversion Tracking be enabled within the Bronto application. If the order id already exists, then this field is ignored and not updated