Authorizations
Path Parameters
Example:
Query Parameters
Required range:
1 <= x <= 100Available options:
id, -id curl --request GET \
--url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/pending-points \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"id": "lopp_0ffdbd86f0120789f2",
"voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"order_id": "ord_0ffc73eff092dea295",
"points": 1,
"activates_at": "2025-01-16",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044515",
"name": "Silver Tier"
},
"event": {
"id": "evcus_0ffc73eff212dea29f",
"type": "customer.order.paid",
"group_id": "v-0ffc73efe71d5053fa",
"entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"created_at": "2025-01-15T16:51:03.745Z",
"category": "EFFECT",
"event_source": {
"channel": "USER_PORTAL",
"user": {
"id": "user_xyzaBcDEfgHOIJKLmn1opqr2Stu3VWX4"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_0ffc73eff092dea295",
"source_id": "dashboard-source-20250115-001"
}
},
"created_at": "2025-01-15T16:51:04.708Z"
},
{
"id": "lopp_0ffd968aa8d207eb38",
"voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"order_id": "ord_0ffc4cf3aa55d28bae",
"points": 1,
"activates_at": "2025-01-16",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044515",
"name": "Silver Tier"
},
"event": {
"id": "evcus_0ffc4cf3ad15d28bb8",
"type": "customer.order.paid",
"group_id": "v-0ffc4cf39e2d7d9ade",
"entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"created_at": "2025-01-15T14:00:43.940Z",
"category": "EFFECT",
"event_source": {
"channel": "API",
"api_key": {
"name": "Primary",
"app_id": "3XxxX483-0YYd-XX8z-aXXX-YYY7a3d3698"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_0ffc4cf3aa55d28bae",
"source_id": "your_own_source_id_20250115-006"
}
},
"created_at": "2025-01-15T14:00:44.934Z"
},
{
"id": "lopp_0ffd9661bd5207eb0a",
"voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"order_id": "ord_0ffc4ccac0d5d28b7a",
"points": 1,
"activates_at": "2025-01-16",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044515",
"name": "Silver Tier"
},
"event": {
"id": "evcus_0ffc4ccac5d5d28b84",
"type": "customer.order.paid",
"group_id": "v-0ffc4ccaafdd50214b",
"entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"created_at": "2025-01-15T14:00:02.038Z",
"category": "EFFECT",
"event_source": {
"channel": "API",
"api_key": {
"name": "Primary",
"app_id": "34fdc483-066d-478b-a707-be2c7a3d3698"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_0ffc4ccac0d5d28b7a",
"source_id": "your_own_source_id_20250115-005"
}
},
"created_at": "2025-01-15T14:00:02.586Z"
}
],
"has_more": true,
"more_starting_after": "lopp_0ffd9661bd5207eb0a"
}Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned.
👍 Configuring pending points
Pending points are configured as part of an earning rule with POST Create earning rule or PUT Update earning rule.
curl --request GET \
--url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/pending-points \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"id": "lopp_0ffdbd86f0120789f2",
"voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"order_id": "ord_0ffc73eff092dea295",
"points": 1,
"activates_at": "2025-01-16",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044515",
"name": "Silver Tier"
},
"event": {
"id": "evcus_0ffc73eff212dea29f",
"type": "customer.order.paid",
"group_id": "v-0ffc73efe71d5053fa",
"entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"created_at": "2025-01-15T16:51:03.745Z",
"category": "EFFECT",
"event_source": {
"channel": "USER_PORTAL",
"user": {
"id": "user_xyzaBcDEfgHOIJKLmn1opqr2Stu3VWX4"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_0ffc73eff092dea295",
"source_id": "dashboard-source-20250115-001"
}
},
"created_at": "2025-01-15T16:51:04.708Z"
},
{
"id": "lopp_0ffd968aa8d207eb38",
"voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"order_id": "ord_0ffc4cf3aa55d28bae",
"points": 1,
"activates_at": "2025-01-16",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044515",
"name": "Silver Tier"
},
"event": {
"id": "evcus_0ffc4cf3ad15d28bb8",
"type": "customer.order.paid",
"group_id": "v-0ffc4cf39e2d7d9ade",
"entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"created_at": "2025-01-15T14:00:43.940Z",
"category": "EFFECT",
"event_source": {
"channel": "API",
"api_key": {
"name": "Primary",
"app_id": "3XxxX483-0YYd-XX8z-aXXX-YYY7a3d3698"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_0ffc4cf3aa55d28bae",
"source_id": "your_own_source_id_20250115-006"
}
},
"created_at": "2025-01-15T14:00:44.934Z"
},
{
"id": "lopp_0ffd9661bd5207eb0a",
"voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"order_id": "ord_0ffc4ccac0d5d28b7a",
"points": 1,
"activates_at": "2025-01-16",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044515",
"name": "Silver Tier"
},
"event": {
"id": "evcus_0ffc4ccac5d5d28b84",
"type": "customer.order.paid",
"group_id": "v-0ffc4ccaafdd50214b",
"entity_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
"created_at": "2025-01-15T14:00:02.038Z",
"category": "EFFECT",
"event_source": {
"channel": "API",
"api_key": {
"name": "Primary",
"app_id": "34fdc483-066d-478b-a707-be2c7a3d3698"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_0ffc4ccac0d5d28b7a",
"source_id": "your_own_source_id_20250115-005"
}
},
"created_at": "2025-01-15T14:00:02.586Z"
}
],
"has_more": true,
"more_starting_after": "lopp_0ffd9661bd5207eb0a"
}1 <= x <= 100id, -id Was this page helpful?