List Redemptions
curl --request GET \
--url https://{cluster}.voucherify.io/v1/redemptions \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "redemptions",
"redemptions": [
{
"id": "r_0c0469eaf705889d99",
"object": "redemption",
"date": "2022-11-18T12:30:32.622Z",
"customer_id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"tracking_id": "track_5DQxXbK0C0pvAaHk7mnulhyMBo7VratI",
"metadata": {
"store_names": "Store 2 - Florida - Miami"
},
"result": "SUCCESS",
"order": {
"id": "ord_ndw5rQJt12zvZ4upF72a3ljh",
"source_id": null,
"created_at": "2022-11-18T12:30:31.338Z",
"updated_at": null,
"status": "PAID",
"amount": 9680000,
"items_discount_amount": 9450000,
"total_discount_amount": 9450000,
"total_amount": 230000,
"items_applied_discount_amount": 9450000,
"total_applied_discount_amount": 9450000,
"items": [
{
"object": "order_item",
"product_id": "prod_0bae45ffc7003ffc52",
"quantity": 1,
"amount": 230000,
"price": 230000,
"subtotal_amount": 230000,
"product": {
"id": "prod_0bae45ffc7003ffc52",
"source_id": "second_product",
"name": "Samsung Phone 2",
"price": 230000
}
},
{
"object": "order_item",
"product_id": "prod_0bae2dc5a090fd0184",
"sku_id": "sku_0bae3b28f610fd0da1",
"quantity": 45,
"discount_quantity": 45,
"initial_quantity": 0,
"amount": 9450000,
"discount_amount": 9450000,
"initial_amount": 0,
"applied_discount_amount": 9450000,
"price": 210000,
"subtotal_amount": 0,
"product": {
"id": "prod_0bae2dc5a090fd0184",
"source_id": "first_product",
"name": "Samsung Phone 1",
"price": 220000
},
"sku": {
"id": "sku_0bae3b28f610fd0da1",
"source_id": "first_product_sku_1",
"sku": "Samsung phone 256GB",
"price": 210000
}
}
],
"metadata": {},
"customer": {
"id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"object": "customer"
},
"customer_id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0c0469eaf705889d99": {
"date": "2022-11-18T12:30:31.388Z",
"related_object_type": "promotion_tier",
"related_object_id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm",
"related_object_parent_id": "camp_40LC42P5NFbkkD4RWoJ4btks"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"name": "Bob Jones",
"email": "bob.smith@email.com",
"source_id": "pub_source_customer_5_a",
"metadata": {
"lang": "en",
"test": true
},
"object": "customer"
},
"related_object_type": "promotion_tier",
"related_object_id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm",
"voucher": null,
"promotion_tier": {
"id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm",
"campaign": {
"id": "camp_40LC42P5NFbkkD4RWoJ4btks"
}
}
},
{
"id": "r_0bf9cf0a8b12dc5ba6",
"object": "redemption",
"date": "2022-11-10T06:49:03.835Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"amount": 200,
"result": "SUCCESS",
"order": {
"id": "ord_jAifScsbOqxgb12hLu7hXrLU",
"source_id": null,
"created_at": "2022-11-10T06:49:02.703Z",
"updated_at": null,
"status": "PAID",
"amount": 4500,
"discount_amount": 4000,
"total_discount_amount": 4000,
"total_amount": 500,
"applied_discount_amount": 4000,
"total_applied_discount_amount": 4000,
"items": [
{
"object": "order_item",
"product_id": "prod_0b72b0bd64d198e3ae",
"quantity": 3,
"amount": 4500,
"price": 1500,
"subtotal_amount": 4500,
"product": {
"id": "prod_0b72b0bd64d198e3ae",
"source_id": "vase_1",
"name": "Vase - Boho Vintage",
"price": 1500
}
}
],
"metadata": {},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"object": "customer"
},
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0bf9cf0a8b12dc5ba6": {
"date": "2022-11-10T06:49:02.764Z",
"related_object_type": "voucher",
"related_object_id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"related_object_parent_id": "camp_fkZ28pe7DUAEmmabofkxHI8N"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bobby McDonald",
"email": "bobby.mcdonald@email.com",
"source_id": "bobby.mcdonald@email.com",
"metadata": {
"acquisition_channel": "Facebook",
"customer_life_time_value": 100
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"voucher": {
"id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"code": "LT1-wMPnRhxb",
"campaign": "Loyalty Campaign - Tiers - 1",
"campaign_id": "camp_fkZ28pe7DUAEmmabofkxHI8N"
},
"reward": {
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bobby McDonald",
"email": "bobby.mcdonald@email.com",
"source_id": "bobby.mcdonald@email.com",
"metadata": {
"acquisition_channel": "Facebook",
"customer_life_time_value": 100
},
"object": "customer"
},
"assignment_id": "rewa_nMXB59qGTNYawMT8eP8M4oUp",
"id": "rew_MVXA2kV7lZ1zC057WUaTrvNz",
"object": "reward",
"name": "100 Points = $20",
"created_at": "2022-09-09T06:41:54.496Z",
"updated_at": null,
"parameters": {
"coin": {
"exchange_ratio": 20,
"points_ratio": 100
}
},
"type": "COIN"
},
"loyalty_card": {
"points": 200
}
},
{
"id": "rf_0bf9caf744d2dc593a",
"object": "redemption",
"date": "2022-11-10T06:31:15.477Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"result": "FAILURE",
"failure_code": "loyalty_card_points_exceeded",
"failure_message": "loyalty card points exceeded",
"order": null,
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bobby McDonald",
"email": "bobby.mcdonald@email.com",
"source_id": "bobby.mcdonald@email.com",
"metadata": {
"acquisition_channel": "Facebook",
"customer_life_time_value": 100
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"voucher": {
"id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"code": "LT1-wMPnRhxb",
"campaign": "Loyalty Campaign - Tiers - 1",
"campaign_id": "camp_fkZ28pe7DUAEmmabofkxHI8N"
}
},
{
"id": "rf_0bf8c023eb4d4aa4ad",
"object": "redemption",
"date": "2022-11-09T11:05:28.074Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"result": "FAILURE",
"failure_code": "customer_rules_violated",
"failure_message": "customer does not match validation rules",
"order": null,
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bob Smith",
"email": "bob.smith@email.com",
"source_id": "bob.smith@email.com",
"metadata": {
"acquisition_channel": "Facebook"
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"voucher": {
"id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"code": "3rqWOTAh",
"campaign_id": null
}
},
{
"id": "r_0ba9fa02fcd28ed8f1",
"object": "redemption",
"date": "2022-09-09T06:38:20.085Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"amount": 300,
"result": "SUCCESS",
"order": {
"id": "ord_G9LBb5SOPa36pHdwxUvzkw4P",
"source_id": null,
"created_at": "2022-09-09T06:38:17.984Z",
"updated_at": null,
"status": "PAID",
"amount": 4600,
"items_discount_amount": 300,
"total_discount_amount": 300,
"total_amount": 4300,
"items_applied_discount_amount": 300,
"total_applied_discount_amount": 300,
"items": [
{
"object": "order_item",
"product_id": "prod_0b7d7dfb05cbe5c616",
"sku_id": "sku_0b7d7dfb090be5c619",
"quantity": 1,
"amount": 1600,
"price": 1600,
"subtotal_amount": 1600,
"product": {
"id": "prod_0b7d7dfb05cbe5c616",
"source_id": "Books",
"name": "Comic Books1",
"price": 1600
},
"sku": {
"id": "sku_0b7d7dfb090be5c619",
"source_id": "ComicBook_1",
"sku": "Comics1",
"price": 1600
}
},
{
"object": "order_item",
"product_id": "prod_0a65b3ff8592d7a5b5",
"quantity": 1,
"amount": 3000,
"discount_amount": 300,
"applied_discount_amount": 300,
"price": 3000,
"subtotal_amount": 2700,
"product": {
"id": "prod_0a65b3ff8592d7a5b5",
"name": "Koffee Cup",
"price": 3000
}
}
],
"metadata": {},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"object": "customer"
},
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0ba9fa02fcd28ed8f1": {
"date": "2022-09-09T06:38:18.099Z",
"related_object_type": "voucher",
"related_object_id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
"related_object_parent_id": "camp_hC2GdqYtOmTT45zfhib62cK1"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bob Smith",
"email": "bob.smith@email.com",
"source_id": "bob.smith@email.com",
"metadata": {},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
"voucher": {
"id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
"code": "vTcguVLE",
"campaign": "SL-Gift",
"campaign_id": "camp_hC2GdqYtOmTT45zfhib62cK1"
},
"gift": {
"amount": 300
}
},
{
"id": "rf_0bf8bfe0808d4aa473",
"object": "redemption",
"date": "2022-11-09T11:04:19.062Z",
"customer_id": null,
"tracking_id": null,
"metadata": {},
"result": "FAILURE",
"failure_code": "missing_customer",
"failure_message": "Missing customer",
"order": null,
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": null,
"related_object_type": "voucher",
"related_object_id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"voucher": {
"id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"code": "3rqWOTAh",
"campaign_id": null
}
}
],
"total": 6
}List Redemptions
Returns a list of redemptions previously created. The redemptions are returned in a sorted order, with the most recent redemptions appearing first. The response returns a list of redemptions of all vouchers.
Filtering results
The result can be narrowed according to specified (or default) filters, for example, you can sort redemptions by date:
https://api.voucherify.io/v1/redemptions?limit=3&[created_at][before]=2017-09-08T13:52:18.227Z.
A filter based on the object created_at field narrows down the results and lists redemptions done before or after a particular date time. You can use the following options: [created_at][after], [created_at][before].
A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z.
Failed Redemptions
A redemption may fail for various reasons. You can figure out an exact reason from the failure_code:
resource_not_found- voucher with given code does not existvoucher_not_active- voucher is not active yet (before start date)voucher_expired- voucher has already expired (after expiration date)voucher_disabled- voucher has been disabled (active: false)quantity_exceeded- voucher’s redemptions limit has been exceededgift_amount_exceeded- gift amount has been exceededcustomer_rules_violated- customer did not match the segmentorder_rules_violated- order did not match validation rulesinvalid_order- order was specified incorrectlyinvalid_amount- order amount was specified incorrectlymissing_amount- order amount was not specifiedmissing_order_items- order items were not specifiedmissing_customer- customer was not specified
GET
/
v1
/
redemptions
List Redemptions
curl --request GET \
--url https://{cluster}.voucherify.io/v1/redemptions \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "redemptions",
"redemptions": [
{
"id": "r_0c0469eaf705889d99",
"object": "redemption",
"date": "2022-11-18T12:30:32.622Z",
"customer_id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"tracking_id": "track_5DQxXbK0C0pvAaHk7mnulhyMBo7VratI",
"metadata": {
"store_names": "Store 2 - Florida - Miami"
},
"result": "SUCCESS",
"order": {
"id": "ord_ndw5rQJt12zvZ4upF72a3ljh",
"source_id": null,
"created_at": "2022-11-18T12:30:31.338Z",
"updated_at": null,
"status": "PAID",
"amount": 9680000,
"items_discount_amount": 9450000,
"total_discount_amount": 9450000,
"total_amount": 230000,
"items_applied_discount_amount": 9450000,
"total_applied_discount_amount": 9450000,
"items": [
{
"object": "order_item",
"product_id": "prod_0bae45ffc7003ffc52",
"quantity": 1,
"amount": 230000,
"price": 230000,
"subtotal_amount": 230000,
"product": {
"id": "prod_0bae45ffc7003ffc52",
"source_id": "second_product",
"name": "Samsung Phone 2",
"price": 230000
}
},
{
"object": "order_item",
"product_id": "prod_0bae2dc5a090fd0184",
"sku_id": "sku_0bae3b28f610fd0da1",
"quantity": 45,
"discount_quantity": 45,
"initial_quantity": 0,
"amount": 9450000,
"discount_amount": 9450000,
"initial_amount": 0,
"applied_discount_amount": 9450000,
"price": 210000,
"subtotal_amount": 0,
"product": {
"id": "prod_0bae2dc5a090fd0184",
"source_id": "first_product",
"name": "Samsung Phone 1",
"price": 220000
},
"sku": {
"id": "sku_0bae3b28f610fd0da1",
"source_id": "first_product_sku_1",
"sku": "Samsung phone 256GB",
"price": 210000
}
}
],
"metadata": {},
"customer": {
"id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"object": "customer"
},
"customer_id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0c0469eaf705889d99": {
"date": "2022-11-18T12:30:31.388Z",
"related_object_type": "promotion_tier",
"related_object_id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm",
"related_object_parent_id": "camp_40LC42P5NFbkkD4RWoJ4btks"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_qBwHpagDOFu71Z3F22UzR80X",
"name": "Bob Jones",
"email": "bob.smith@email.com",
"source_id": "pub_source_customer_5_a",
"metadata": {
"lang": "en",
"test": true
},
"object": "customer"
},
"related_object_type": "promotion_tier",
"related_object_id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm",
"voucher": null,
"promotion_tier": {
"id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm",
"campaign": {
"id": "camp_40LC42P5NFbkkD4RWoJ4btks"
}
}
},
{
"id": "r_0bf9cf0a8b12dc5ba6",
"object": "redemption",
"date": "2022-11-10T06:49:03.835Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"amount": 200,
"result": "SUCCESS",
"order": {
"id": "ord_jAifScsbOqxgb12hLu7hXrLU",
"source_id": null,
"created_at": "2022-11-10T06:49:02.703Z",
"updated_at": null,
"status": "PAID",
"amount": 4500,
"discount_amount": 4000,
"total_discount_amount": 4000,
"total_amount": 500,
"applied_discount_amount": 4000,
"total_applied_discount_amount": 4000,
"items": [
{
"object": "order_item",
"product_id": "prod_0b72b0bd64d198e3ae",
"quantity": 3,
"amount": 4500,
"price": 1500,
"subtotal_amount": 4500,
"product": {
"id": "prod_0b72b0bd64d198e3ae",
"source_id": "vase_1",
"name": "Vase - Boho Vintage",
"price": 1500
}
}
],
"metadata": {},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"object": "customer"
},
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0bf9cf0a8b12dc5ba6": {
"date": "2022-11-10T06:49:02.764Z",
"related_object_type": "voucher",
"related_object_id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"related_object_parent_id": "camp_fkZ28pe7DUAEmmabofkxHI8N"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bobby McDonald",
"email": "bobby.mcdonald@email.com",
"source_id": "bobby.mcdonald@email.com",
"metadata": {
"acquisition_channel": "Facebook",
"customer_life_time_value": 100
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"voucher": {
"id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"code": "LT1-wMPnRhxb",
"campaign": "Loyalty Campaign - Tiers - 1",
"campaign_id": "camp_fkZ28pe7DUAEmmabofkxHI8N"
},
"reward": {
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bobby McDonald",
"email": "bobby.mcdonald@email.com",
"source_id": "bobby.mcdonald@email.com",
"metadata": {
"acquisition_channel": "Facebook",
"customer_life_time_value": 100
},
"object": "customer"
},
"assignment_id": "rewa_nMXB59qGTNYawMT8eP8M4oUp",
"id": "rew_MVXA2kV7lZ1zC057WUaTrvNz",
"object": "reward",
"name": "100 Points = $20",
"created_at": "2022-09-09T06:41:54.496Z",
"updated_at": null,
"parameters": {
"coin": {
"exchange_ratio": 20,
"points_ratio": 100
}
},
"type": "COIN"
},
"loyalty_card": {
"points": 200
}
},
{
"id": "rf_0bf9caf744d2dc593a",
"object": "redemption",
"date": "2022-11-10T06:31:15.477Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"result": "FAILURE",
"failure_code": "loyalty_card_points_exceeded",
"failure_message": "loyalty card points exceeded",
"order": null,
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bobby McDonald",
"email": "bobby.mcdonald@email.com",
"source_id": "bobby.mcdonald@email.com",
"metadata": {
"acquisition_channel": "Facebook",
"customer_life_time_value": 100
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"voucher": {
"id": "v_Xak3ViMbxCH8Lb4ZG0lWwC0goMRBXWB4",
"code": "LT1-wMPnRhxb",
"campaign": "Loyalty Campaign - Tiers - 1",
"campaign_id": "camp_fkZ28pe7DUAEmmabofkxHI8N"
}
},
{
"id": "rf_0bf8c023eb4d4aa4ad",
"object": "redemption",
"date": "2022-11-09T11:05:28.074Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"result": "FAILURE",
"failure_code": "customer_rules_violated",
"failure_message": "customer does not match validation rules",
"order": null,
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bob Smith",
"email": "bob.smith@email.com",
"source_id": "bob.smith@email.com",
"metadata": {
"acquisition_channel": "Facebook"
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"voucher": {
"id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"code": "3rqWOTAh",
"campaign_id": null
}
},
{
"id": "r_0ba9fa02fcd28ed8f1",
"object": "redemption",
"date": "2022-09-09T06:38:20.085Z",
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
"metadata": {},
"amount": 300,
"result": "SUCCESS",
"order": {
"id": "ord_G9LBb5SOPa36pHdwxUvzkw4P",
"source_id": null,
"created_at": "2022-09-09T06:38:17.984Z",
"updated_at": null,
"status": "PAID",
"amount": 4600,
"items_discount_amount": 300,
"total_discount_amount": 300,
"total_amount": 4300,
"items_applied_discount_amount": 300,
"total_applied_discount_amount": 300,
"items": [
{
"object": "order_item",
"product_id": "prod_0b7d7dfb05cbe5c616",
"sku_id": "sku_0b7d7dfb090be5c619",
"quantity": 1,
"amount": 1600,
"price": 1600,
"subtotal_amount": 1600,
"product": {
"id": "prod_0b7d7dfb05cbe5c616",
"source_id": "Books",
"name": "Comic Books1",
"price": 1600
},
"sku": {
"id": "sku_0b7d7dfb090be5c619",
"source_id": "ComicBook_1",
"sku": "Comics1",
"price": 1600
}
},
{
"object": "order_item",
"product_id": "prod_0a65b3ff8592d7a5b5",
"quantity": 1,
"amount": 3000,
"discount_amount": 300,
"applied_discount_amount": 300,
"price": 3000,
"subtotal_amount": 2700,
"product": {
"id": "prod_0a65b3ff8592d7a5b5",
"name": "Koffee Cup",
"price": 3000
}
}
],
"metadata": {},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"object": "customer"
},
"customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0ba9fa02fcd28ed8f1": {
"date": "2022-09-09T06:38:18.099Z",
"related_object_type": "voucher",
"related_object_id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
"related_object_parent_id": "camp_hC2GdqYtOmTT45zfhib62cK1"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_tAED42tFhLM9v7GmZUaklJFd",
"name": "Bob Smith",
"email": "bob.smith@email.com",
"source_id": "bob.smith@email.com",
"metadata": {},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
"voucher": {
"id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
"code": "vTcguVLE",
"campaign": "SL-Gift",
"campaign_id": "camp_hC2GdqYtOmTT45zfhib62cK1"
},
"gift": {
"amount": 300
}
},
{
"id": "rf_0bf8bfe0808d4aa473",
"object": "redemption",
"date": "2022-11-09T11:04:19.062Z",
"customer_id": null,
"tracking_id": null,
"metadata": {},
"result": "FAILURE",
"failure_code": "missing_customer",
"failure_message": "Missing customer",
"order": null,
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": null,
"related_object_type": "voucher",
"related_object_id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"voucher": {
"id": "v_FGQjOjqasEbbdpnySdCpUoalJio3OHWK",
"code": "3rqWOTAh",
"campaign_id": null
}
}
],
"total": 6
}Authorizations
X-App-Id & X-App-TokenX-Voucherify-OAuth
Query Parameters
Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
Required range:
1 <= x <= 100Which page of results to return. The lowest value is 1, the highest value is 99.
Required range:
1 <= x <= 99A filter on the list based on the redemption result. Available options are: SUCCESS, FAILURE. You can provide multiple values by repeating the param.
A filter by the campaign name that the redemption resources originate from.
Return redemptions performed by the customer with given id or source_id.
Example:
"cust_nk0N1uNQ1YnupAoJGOgvsODC"
Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
Available options:
created_at, -created_at, id, -id, voucher_code, -voucher_code, tracking_id, -tracking_id, customer_id, -customer_id A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z
Show child attributes
Show child attributes
Filters for listing responses.
Show child attributes
Show child attributes
Response
200 - application/json
Returns a list of redemption objects. Each entry in the array is a separate redemption object. If no more redemptions are available, the resulting array will be empty. If you provide a non-existent customer ID, this call returns an empty object.
Response body schema for GET v1/redemptions.
The type of the object represented by JSON. This object stores information about redemptions in a dictionary.
Identifies the name of the attribute that contains the array of redemption objects.
This is an object representing a redemption.
- Redemption
- Redemption Rollback
Show child attributes
Show child attributes
Total number of redemptions.
Last modified on July 7, 2026
Was this page helpful?
⌘I