Get Voucher's Redemptions

Retrieve the number of times a voucher was redeemed and each of the redemption details.

GET /v1/vouchers/{code}/redemption

Get Voucher's Redemptions

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code}/redemption \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "quantity": null,
  "redeemed_quantity": 6,
  "object": "list",
  "url": "/v1/vouchers/Test - FB - Vouchers - 9/redemptions?page=1&limit=10",
  "data_ref": "redemption_entries",
  "total": 6,
  "redemption_entries": [
    {
      "id": "r_0bc92f81a6801f9bca",
      "object": "redemption",
      "date": "2022-10-03T12:24:58.008Z",
      "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
      "tracking_id": "track_fxEMFisanb6bqeHALcTMxy9fmc+1Azdq951CZwGFCweQF8eGLowFHg==",
      "metadata": {},
      "result": "SUCCESS",
      "order": {
        "id": "ord_bhp1EH2SDz7UwkkurPFPLPhi",
        "source_id": null,
        "created_at": "2022-10-03T12:24:56.179Z",
        "updated_at": null,
        "status": "PAID",
        "amount": 230000,
        "discount_amount": 100,
        "total_discount_amount": 100,
        "total_amount": 229900,
        "applied_discount_amount": 100,
        "total_applied_discount_amount": 100,
        "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
            }
          }
        ],
        "metadata": {},
        "customer": {
          "id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
          "object": "customer"
        },
        "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
        "referrer_id": null,
        "object": "order",
        "redemptions": {
          "r_0bc92f81a6801f9bca": {
            "date": "2022-10-03T12:24:56.219Z",
            "related_object_type": "voucher",
            "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno"
          }
        }
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
        "name": null,
        "email": null,
        "source_id": "[e-mail]",
        "metadata": {},
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
      "voucher": {
        "id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
        "code": "Test - FB - Vouchers - 9",
        "campaign_id": null
      }
    },
    {
      "id": "r_0bc92e6a68050e118c",
      "object": "redemption",
      "date": "2022-10-03T12:20:11.873Z",
      "customer_id": "cust_TzWOhveicr7BI1Qg4bCFrrQQ",
      "tracking_id": "track_5DQxXbK0C0pvAaHk7mnulmKhuFqhawWj",
      "metadata": {},
      "result": "SUCCESS",
      "order": {
        "id": "ord_rBsuJYqf4eFZgqj6IxeJgEcN",
        "source_id": null,
        "created_at": "2022-10-03T12:20:10.222Z",
        "updated_at": null,
        "status": "PAID",
        "amount": 230000,
        "discount_amount": 100,
        "total_discount_amount": 100,
        "total_amount": 229900,
        "applied_discount_amount": 100,
        "total_applied_discount_amount": 100,
        "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
            }
          }
        ],
        "metadata": {},
        "customer": {
          "id": "cust_TzWOhveicr7BI1Qg4bCFrrQQ",
          "object": "customer"
        },
        "customer_id": "cust_TzWOhveicr7BI1Qg4bCFrrQQ",
        "referrer_id": null,
        "object": "order",
        "redemptions": {
          "r_0bc92e6a68050e118c": {
            "date": "2022-10-03T12:20:10.272Z",
            "related_object_type": "voucher",
            "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno"
          }
        }
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "cust_TzWOhveicr7BI1Qg4bCFrrQQ",
        "name": "Bob Jones",
        "email": "[e-mail]",
        "source_id": "pub_source_customer_4",
        "metadata": {
          "lang": "en",
          "test": true
        },
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
      "voucher": {
        "id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
        "code": "Test - FB - Vouchers - 9",
        "campaign_id": null
      }
    },
    {
      "id": "r_0bc92db6e6001f9aa8",
      "object": "redemption",
      "date": "2022-10-03T12:17:07.780Z",
      "customer_id": "cust_BB6F97yf0XqCe7hxVUV7M4sS",
      "tracking_id": "track_5DQxXbK0C0pvAaHk7mnulmYlx396Pk4X",
      "metadata": {},
      "result": "SUCCESS",
      "order": {
        "id": "ord_JvZbg1LFcXdQ67no5SENGldH",
        "source_id": null,
        "created_at": "2022-10-03T12:17:06.404Z",
        "updated_at": null,
        "status": "PAID",
        "amount": 230000,
        "discount_amount": 1200,
        "total_discount_amount": 1200,
        "total_amount": 228800,
        "applied_discount_amount": 1200,
        "total_applied_discount_amount": 1200,
        "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
            }
          }
        ],
        "metadata": {},
        "customer": {
          "id": "cust_BB6F97yf0XqCe7hxVUV7M4sS",
          "object": "customer"
        },
        "customer_id": "cust_BB6F97yf0XqCe7hxVUV7M4sS",
        "referrer_id": null,
        "object": "order",
        "redemptions": {
          "r_0bc92db6e6001f9aa8": {
            "date": "2022-10-03T12:17:06.456Z",
            "related_object_type": "voucher",
            "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno"
          }
        }
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "cust_BB6F97yf0XqCe7hxVUV7M4sS",
        "name": "Bob Jones",
        "email": "[e-mail]",
        "source_id": "pub_source_customer_5",
        "metadata": {
          "lang": "en",
          "test": true
        },
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
      "voucher": {
        "id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
        "code": "Test - FB - Vouchers - 9",
        "campaign_id": null
      }
    },
    {
      "id": "r_0bc2dc6404426c0ab3",
      "object": "redemption",
      "date": "2022-09-28T14:30:56.199Z",
      "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
      "tracking_id": "track_fxEMFisanb6bqeHALcTMxy9fmc+1Azdq951CZwGFCweQF8eGLowFHg==",
      "metadata": {},
      "result": "SUCCESS",
      "order": {
        "id": "ord_6uuhGraDuXMOpVRTJT251kKW",
        "source_id": null,
        "created_at": "2022-09-28T14:30:54.681Z",
        "updated_at": null,
        "status": "PAID",
        "amount": 230000,
        "discount_amount": 800,
        "total_discount_amount": 800,
        "total_amount": 229200,
        "applied_discount_amount": 800,
        "total_applied_discount_amount": 800,
        "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
            }
          }
        ],
        "metadata": {},
        "customer": {
          "id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
          "object": "customer"
        },
        "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
        "referrer_id": null,
        "object": "order",
        "redemptions": {
          "r_0bc2dc6404426c0ab3": {
            "date": "2022-09-28T14:30:54.737Z",
            "related_object_type": "voucher",
            "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno"
          }
        }
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
        "name": null,
        "email": null,
        "source_id": "[e-mail]",
        "metadata": {},
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
      "voucher": {
        "id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
        "code": "Test - FB - Vouchers - 9",
        "campaign_id": null
      }
    },
    {
      "id": "r_0bc2d6f0ebc95f1783",
      "object": "redemption",
      "date": "2022-09-28T14:07:07.516Z",
      "customer_id": "cust_H0nXrItO1DNV3UiPIl54HA5o",
      "tracking_id": "track_ThofCMTQe4EVIo0zvvOlTor1twaQNd7E",
      "metadata": {},
      "result": "SUCCESS",
      "order": {
        "id": "ord_ZQevc2J2sBegsnp5DwanXHsa",
        "source_id": null,
        "created_at": "2022-09-28T14:07:06.073Z",
        "updated_at": null,
        "status": "PAID",
        "amount": 230000,
        "discount_amount": 0,
        "total_discount_amount": 0,
        "total_amount": 230000,
        "applied_discount_amount": 0,
        "total_applied_discount_amount": 0,
        "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
            }
          }
        ],
        "metadata": {},
        "customer": {
          "id": "cust_H0nXrItO1DNV3UiPIl54HA5o",
          "object": "customer"
        },
        "customer_id": "cust_H0nXrItO1DNV3UiPIl54HA5o",
        "referrer_id": null,
        "object": "order",
        "redemptions": {
          "r_0bc2d6f0ebc95f1783": {
            "date": "2022-09-28T14:07:06.159Z",
            "related_object_type": "voucher",
            "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno"
          }
        }
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "cust_H0nXrItO1DNV3UiPIl54HA5o",
        "name": "Bob Smith",
        "email": "[e-mail]",
        "source_id": "[e-mail]",
        "metadata": {
          "lang": "en",
          "test": false
        },
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
      "voucher": {
        "id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
        "code": "Test - FB - Vouchers - 9",
        "campaign_id": null
      }
    },
    {
      "id": "r_0bc2d3c4f7495f159a",
      "object": "redemption",
      "date": "2022-09-28T13:53:16.057Z",
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "tracking_id": "track_fxEMFisanb4sbl4Z4yCnJyDW013IrRbJmqKByTNHbXE=",
      "metadata": {},
      "result": "SUCCESS",
      "order": {
        "id": "ord_ff6rwr58kmdyuLsi5orplnVW",
        "source_id": null,
        "created_at": "2022-09-28T13:53:14.604Z",
        "updated_at": null,
        "status": "PAID",
        "amount": 230000,
        "discount_amount": 800,
        "total_discount_amount": 800,
        "total_amount": 229200,
        "applied_discount_amount": 800,
        "total_applied_discount_amount": 800,
        "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
            }
          }
        ],
        "metadata": {},
        "customer": {
          "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
          "object": "customer"
        },
        "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "referrer_id": null,
        "object": "order",
        "redemptions": {
          "r_0bc2d3c4f7495f159a": {
            "date": "2022-09-28T13:53:14.717Z",
            "related_object_type": "voucher",
            "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno"
          }
        }
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "name": "John Smith",
        "email": "[e-mail]",
        "source_id": "[e-mail]",
        "metadata": {
          "acquisition_channel": "Facebook"
        },
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
      "voucher": {
        "id": "v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno",
        "code": "Test - FB - Vouchers - 9",
        "campaign_id": null
      }
    }
  ]
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

code · string · required

A code that identifies the voucher.

Example:

"2CpRCE2c"

Response

200 - application/json

A dictionary with a redemption_entries property that contains an array of voucher's redemptions.

Response body schema for GET v1/vouchers/{code}/redemption.

quantity · integer | null · required

The maximum number of times a voucher can be redeemed.

redeemed_quantity · integer · required

The number of times the voucher was redeemed successfully.

object · string · default: list · required

The type of the object represented by JSON. This object stores information about redemptions in a dictionary.

url · string · required

URL

Example:

"/v1/vouchers/PROMO-CODE2/redemptions?page=1&limit=10"

data_ref · string · default: redemption_entries · required

Identifies the name of the attribute that contains the array of redemption_entries.

total · integer · required

Total number of redemption objects.

redemption_entries · Vouchers Redemption Get Response Body Redemption Entries Item · object[] · required

Contains the array of successful and failed redemption objects.

This is an object representing a redemption.

Vouchers Redemption Get Response Body Redemption Entries Item

Vouchers Redemption Get Response Body Redemption Entries Item

Show child attributes