get https://loyalty.yotpo.com/api/v2/privacy/data
An asynchronous request that retrieves existing user data in the Yotpo loyalty system. User data is sent as a JSON file to the account email address associated with the Yotpo loyalty account.
What happens next?
If you received a 200 OK response and the Data Exists endpoint returned a response attribute of "has_data": true, you'll receive the user data via an email sent to the email address associated with the account. The email contains a link to a JSON file which includes any existing user data as shown in the response below:
Important:
- The link to the user data JSON file will expire 48 hours after the request is generated.
- The User Data JSON includes any orders metadata collected upon order creation.
{
"id":2,
"merchant_id":2,
"last_purchase_at":"2021-01-25T09:47:27.000Z",
"is_member":true,
"email":"[email protected]",
"name":"Guy S",
"total_spend_cents":130980,
"subscribed":true,
"accepts_marketing":true,
"points_earned":24250,
"points_balance":23710,
"source":"store_account",
"points_expire_at":null,
"first_name":"Guy",
"last_name":"S",
"created_at":"2020-12-13T13:55:17.000Z",
"perks":[
{
"id":1,
"created_at":"2021-01-25T09:30:57.000Z",
"updated_at":"2021-01-25T09:30:58.000Z",
"campaign_id":16,
"awarded":true,
"awarded_at":"2021-01-25T09:30:57.000Z",
"pending":false,
"completed":true,
"completed_at":"2021-01-25T09:30:57.000Z",
"reward_points":1750,
"reversed":false,
"reversed_at":null,
"expired":false,
"expired_at":null,
"expires_at":null,
"referral_id":null,
"customer_id":2,
"history_title":"Make a purchase",
"completed_action":null,
"c_vip_tier_id":null,
"total_actions":0,
"campaign":{
"title":"Make a purchase",
"hidden":false,
"type":"PointsForPurchasesCampaign",
"vip_tier_id":null
},
"percent_completed":100.0
},
{
"id":2,
"created_at":"2021-01-25T09:30:58.000Z",
"updated_at":"2021-01-25T09:30:58.000Z",
"campaign_id":19,
"awarded":true,
"awarded_at":"2021-01-25T09:30:58.000Z",
"pending":false,
"completed":true,
"completed_at":"2021-01-25T09:30:58.000Z",
"reward_points":2625,
"reversed":false,
"reversed_at":null,
"expired":false,
"expired_at":null,
"expires_at":null,
"referral_id":null,
"customer_id":2,
"history_title":"Make a Purchase",
"completed_action":null,
"c_vip_tier_id":null,
"total_actions":0,
"campaign":{
"title":"Make a Purchase",
"hidden":false,
"type":"PointsForPurchasesCampaign",
"vip_tier_id":null
},
"percent_completed":100.0
},
{
"id":3,
"created_at":"2021-01-25T09:47:36.000Z",
"updated_at":"2021-01-25T09:47:36.000Z",
"campaign_id":16,
"awarded":true,
"awarded_at":"2021-01-25T09:47:36.000Z",
"pending":false,
"completed":true,
"completed_at":"2021-01-25T09:47:36.000Z",
"reward_points":7950,
"reversed":false,
"reversed_at":null,
"expired":false,
"expired_at":null,
"expires_at":null,
"referral_id":null,
"customer_id":2,
"history_title":"Make a purchase",
"completed_action":null,
"c_vip_tier_id":null,
"total_actions":0,
"campaign":{
"title":"Make a purchase",
"hidden":false,
"type":"PointsForPurchasesCampaign",
"vip_tier_id":null
},
"percent_completed":100.0
},
{
"id":4,
"created_at":"2021-01-25T09:47:36.000Z",
"updated_at":"2021-01-25T09:47:36.000Z",
"campaign_id":19,
"awarded":true,
"awarded_at":"2021-01-25T09:47:36.000Z",
"pending":false,
"completed":true,
"completed_at":"2021-01-25T09:47:36.000Z",
"reward_points":11925,
"reversed":false,
"reversed_at":null,
"expired":false,
"expired_at":null,
"expires_at":null,
"referral_id":null,
"customer_id":2,
"history_title":"Make a Purchase",
"completed_action":null,
"c_vip_tier_id":null,
"total_actions":0,
"campaign":{
"title":"Make a Purchase",
"hidden":false,
"type":"PointsForPurchasesCampaign",
"vip_tier_id":null
},
"percent_completed":100.0
}
],
"point_redemptions":[
{
"id":1,
"amount":null,
"value_cents":0,
"created_at":"2021-01-25T09:45:47.000Z",
"user_id":null,
"approved":true,
"approved_at":"2021-01-25T09:45:49.000Z",
"currency":"USD",
"external_url":null,
"reward_text":"9R7QS9VJ",
"is_pos":false,
"referral_id":null,
"customer_id":2,
"perk_id":null,
"at_checkout":false,
"visible":true,
"reward_title":"₪5.00 Off",
"ro_applies_to_id":null,
"redemption_option":{
"name":"₪5.00 Off",
"amount":500,
"discount_type":"fixed_amount",
"type":"Coupon"
},
"token":"vvyitjXytnuFi6ARtmS3SX6x3"
},
{
"id":2,
"amount":null,
"value_cents":0,
"created_at":"2021-01-25T09:55:20.000Z",
"user_id":null,
"approved":true,
"approved_at":"2021-01-25T09:55:22.000Z",
"currency":"USD",
"external_url":null,
"reward_text":"CROTW40C",
"is_pos":false,
"referral_id":null,
"customer_id":2,
"perk_id":null,
"at_checkout":false,
"visible":true,
"reward_title":"100$ guy coupn",
"ro_applies_to_id":"",
"redemption_option":{
"name":"100$ guy coupn",
"amount":40,
"discount_type":"recharge_discount_fixed_amount",
"type":"Coupon"
},
"token":"wwzjukYzuovGj7BSunT4TY7y5"
}
],
"hidden_point_redemptions":[
],
"campaigns":[
{
"id":15,
"globalPerksLeft":null,
"customerActionsCompleted":0,
"customerPerksCompleted":0,
"customerMinutesUntilNextAction":0,
"customerMinutesUntilNextPerk":0
},
{
"id":16,
"globalPerksLeft":null,
"customerActionsCompleted":0,
"customerPerksCompleted":2,
"customerMinutesUntilNextAction":0,
"customerMinutesUntilNextPerk":0
},
{
"id":17,
"globalPerksLeft":null,
"customerActionsCompleted":0,
"customerPerksCompleted":0,
"customerMinutesUntilNextAction":0,
"customerMinutesUntilNextPerk":0
},
{
"id":19,
"globalPerksLeft":null,
"customerActionsCompleted":0,
"customerPerksCompleted":2,
"customerMinutesUntilNextAction":0,
"customerMinutesUntilNextPerk":0
}
],
"referral_receipts":[
],
"vip_tier_subscription_date":null,
"vip_tier_expiration_date":null,
"referral_code":"4mgvxea",
"affiliated_purchases":[
],
"affiliated_sold_products":[
],
"is_affiliated":false,
"affiliate_program_enabled":false,
"payout_email":null,
"total_earned":null,
"payout_percentage":null,
"is_opt_in":true,
"opted_in_at":"2021-01-24T13:04:05.000Z"
}
Important:
If your response came back with a 200 | OK code and you haven't received an email from Yotpo within 24 hours, please contact Yotpo support