Retrieves purchase history and referral analytics from FriendBuy for a specific customer email address within a date range.
This integration searches FriendBuy&... Read More
Retrieves purchase history and referral analytics from FriendBuy for a specific customer email address within a date range.
This integration searches FriendBuy’s analytics database to find all purchase records associated with a customer’s email address. It returns detailed order information including referral data, advocate information, product details, and campaign attribution. This is particularly useful for understanding a customer’s purchase behavior and how referral programs influenced their buying decisions.
Parameters
- customer_email (String (email)): The customer’s email address to search for purchase records. Example: “sarah.johnson@example.com”.
- from_date (String (ISO datetime)): Start date for the search range in ISO 8601 format. Defaults to one year ago if not specified. Example: “2024-01-01T00:00:00Z”.
- to_date (String (ISO datetime)): End date for the search range in ISO 8601 format. Defaults to current date if not specified. Example: “2024-12-31T23:59:59Z”.
- pageToken (String): Optional token for accessing additional pages of results when there are more than 200 orders.
Output
Returns a structured object containing purchase analytics with orders (array of order objects), total_results (number of matching orders), and next_page_token (for pagination). Each order includes detailed information about the purchase, referral attribution, advocate details, and individual product line items with pricing and quantities.
Example Output:
{
"orders": [
{
"order_id": "8234567890123",
"customer_id": "7123456789012",
"customer_email": "sarah.johnson@example.com",
"customer_name": "Sarah Johnson",
"campaign_id": "a2b3c4d5-6789-4abc-def1-234567890abc",
"campaign_name": "Spring Referral Campaign",
"created_on": "2024-03-15T14:22:35.891Z",
"advocate_name": "Michael Chen",
"advocate_customer_id": "7987654321098",
"advocate_email": "m.chen@example.com",
"referral_code": "spring2024x",
"order_amount": 89.47,
"is_new_customer": true,
"products": [
{
"product_name": "Premium Organic Coffee Beans",
"product_sku": "COF123456",
"quantity": 2,
"price": 24.99,
"currency": null
},
{
"product_name": "Express Shipping",
"product_sku": "SHIP001",
"quantity": 1,
"price": 9.99,
"currency": null
}
]
}
],
"total_results": 1,
"next_page_token": "eyJzZWFyY2hBZnRlciI6WzE3MTEzNjY5NTU4OTFdLCJmcm9tRGF0ZSI6IjIwMjQtMDEtMDFUMDA6MDA6MDBaIiwidG9EYXRlIjoiMjAyNC0xMi0zMVQyMzo1OTo1OVoiLCJwYWdlU2l6ZSI6MjAwfQ"
} Read Less
