Orders API
The Orders API endpoint may be used to report customer transactions as they happen. These are used within Poplar for attribution reporting and to enable existing customers to be easily suppressed within your campaigns.
You can monitor this integration from the Transactions page in your account. We provide basic diagnostic information and the ability to purge any transactional data stored within your account.
Two fields in the payload: order_date and order_id. This allows you flexibility and control over the amount and specificity of the data you choose to share with Poplar. Be sure to use your Production Access Token in the Authorization header.
Data Completeness
To assure a high level of accuracy, we recommend including additional data beyond the required fields. Adding customer_email, shipping_address, or billing_address will help solidify the match quality of orders to mailings. customer_email is typically the most unique identifier whereas shipping_address or billing_address can map to multiple customers, unless you're assuming 1 Household = 1 Customer.
If none of these data points are passed to Poplar, your attribution reports will be incomplete.
| order_id | String | A unique identifier for each order |
| order_date | String | YYYY-MM-DD Must be an ISO8601 formatted date representing the date and/or time of purchase |
| total | Number | Required to calculate Revenue and related metrics (CPO, ROAS, etc.), must represent the total order value in decimal form Optional for use cases that don't require revenue tracking (site sign-ups, app downloads, etc.) |
| customer_id | String | A unique identifier for the transacting customer in your e-commerce system |
| billing_name billing_addresss_1 billing_address_2 billing_city billing_state billing_postal_code |
String | Required if Shipping Address data is not provided Optional to include with Shipping Address data |
| shipping_name shipping_address_1 shipping_address_2 shipping_city shipping_state shipping_postal_code |
String | Required if Billing Address data is not provided Optional to include with Billing Address data |
| String | Can be used to match against campaigns that mailed using emails for Address Enrichment This data is not stored by Poplar, it is used to compute a hash and then discarded |
|
| hashed_email | String | The SHA256 has of the customer's email address as a 64 character string Please convert the value of the email address to lowercase prior to hashing |
| metadata | Object | Additional order details such as items purchased or New Buyer tags |
| currency_code | String | Three character ISO country-code - if not provided will default to USD |
Customers (Orders API)
You're not required to define your campaign success in terms of orders or conversions. For example, if you are sending mailings to generate leads, rather than purchases, you could still pass successful leads through the Orders API and receive attribution reports.
This list is useful when you are mailing prospecting campaigns and want to suppress existing customers that have been submitted to the Orders API.
Campaign Success
You're not required to define your campaign success in terms of orders or conversions. For example, if you are sending mailings to generate leads, rather than purchases, you could still pass successful leads through the Orders API and receive attribution reports.