addConversion

The addConversion function allows you to add a conversion and any data associated with that conversion.

Syntax

writeResult = bApi.addConversion(conversionObject[] conversions);

Attributes

Name Type Required Description
contactId string No The unique ID assigned to the contact you want to add a conversion for.
Note: The tid will take priority over other ids (deliveryId, contactId, email) passed in.
email string No The email address of the conversion contact.
orderId string No The order identifier. This should be unique per order and will be used to prevent duplicate orders.
item string No The SKU of the line item. Certain item codes are reserved for special use subtotal, taxes, shipping, and total.
description string No The description of the line item.
quantity int Yes The unit count of the line item.
amount float Yes The grand total of the line items.
orderTotal int No The total number of orders made.
createdDate datetime No The date and time of the conversion. If no date/time is provided, then the system will time stamp 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 (Universal Coordinated 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 No The unique ID assigned to a delivery you want to associate a conversion with.
Note: The tid will take priority over other ids (deliveryId, contactId, email) passed in.
messageId string No The unique ID assigned to a message you want to associate a conversion with.
automatorId string No The unique ID assigned to an automator you want to associate a conversion with.
listId string No The unique ID assigned to a list you want to associate a conversion with.
segmentId string No The unique ID assigned to a segment you want to associate a conversion with.
tid string No A unique ID which associates a conversion with a specific contact and delivery. When conversion tracking is enabled in the application, you can pull the tid from the Bronto tracking cookie and use it in the addConversion call to record a conversion that a specific contact makes from a specific delivery.
Note: The tid will take priority over other ids (deliveryId, contactId, email) passed in.

The tid is not returned when calling readConversion. In order to obtain the tid, you must pull it from the bronto tracking cookie.