Rollback Stackable Redemptions

Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to POST Rollback redemption.

🚧 You can roll back a redemption up to 3 months back.

POST /v1/redemptions/{parentRedemptionId}/rollbacks

Rollback Stackable Redemptions

cURL

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/redemptions/{parentRedemptionId}/rollbacks \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "customer": {
    "id": "cust_SolpIN5N4oZbCnrxZ5NHrbVB",
    "name": "Annie Lemons",
    "email": "[e-mail]",
    "phone": "[phone]",
    "birthday": "1900-12-02",
    "birthdate": "1900-12-01",
    "address": {
      "city": "New York",
      "state": "NY",
      "line_1": "123 Main St.",
      "line_2": "APT 3 BLG 5",
      "country": "United States",
      "postal_code": "100012"
    },
    "metadata": {
      "age": 23
    }
  },
  "order": {
    "source_id": "test_rollback_8"
  },
  "metadata": {
    "location_id": [
      "L2"
    ]
  }
}
'

200

Example

{ "rollbacks": [ { "id": "rr_0efeb3dab05e62e599", "object": "redemption_rollback", "date": "2021-12-22T10:13:06.487Z", "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64", "tracking_id": "<string>", "metadata": {}, "redemption": "r_0c656311b5878a2031", "order": { "id": "<string>", "source_id": "<string>", "amount": 123, "initial_amount": 123, "discount_amount": 123, "items_discount_amount": 123, "total_discount_amount": 123, "total_amount": 123, "applied_discount_amount": 123, "items_applied_discount_amount": 123, "total_applied_discount_amount": 123, "metadata": {}, "object": "order", "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1", "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix", "customer": { "id": "<string>", "object": "customer" }, "referrer": { "id": "<string>", "object": "customer" }, "redemptions": {}, "items": [ { "object": "order_item", "id": "<string>", "sku_id": "<string>", "product_id": "<string>", "source_id": "<string>", "quantity": 123, "discount_quantity": 123, "initial_quantity": 123, "amount": 123, "discount_amount": 123, "applied_discount_amount": 123, "applied_discount_quantity": 123, "applied_quantity": 123, "applied_quantity_amount": 123, "initial_amount": 123, "price": 123, "subtotal_amount": 123, "product": { "id": "<string>", "source_id": "<string>", "override": true, "name": "<string>", "metadata": {}, "price": 123 }, "sku": { "id": "<string>", "source_id": "<string>", "override": true, "sku": "<string>", "price": 123, "metadata": {} }, "metadata": {} } ] }, "channel": { "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH" }, "customer": { "id": "<string>", "name": "<string>", "email": "<string>", "source_id": "<string>", "metadata": {}, "object": "customer" }, "related_object_id": "<string>", "amount": -10000, "reason": "<string>", "failure_code": "customer_rules_violated", "failure_message": "<string>", "voucher": { "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV", "code": "WVPblOYX", "campaign": "Gift Card Campaign", "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV", "category": "<string>", "category_id": "cat_0bb343dee3cdb5ec0c", "discount": { "type": "AMOUNT", "amount_off": 123, "amount_off_formula": "<string>", "aggregated_amount_limit": 123, "is_dynamic": true }, "gift": { "amount": 10000, "subtracted_amount": 123, "balance": 500 }, "loyalty_card": { "points": 7000, "balance": 6970, "next_expiration_date": "2023-05-30", "next_expiration_points": 123, "pending_points": 123, "expired_points": 123, "subtracted_points": 123 }, "start_date": "2021-12-01T00:00:00.000Z", "expiration_date": "2021-12-31T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "active": true, "additional_info": "<string>", "metadata": {}, "assets": { "qr": { "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==", "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D" }, "barcode": { "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==", "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D" } }, "is_referral_code": true, "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4", "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv", "object": "voucher", "publish": { "object": "list", "count": 0, "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10" }, "redemption": { "quantity": 123, "redeemed_quantity": 1, "redeemed_points": 100000, "object": "list", "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10" }, "categories": [ { "id": "<string>", "name": "<string>", "hierarchy": 1, "object": "category", "created_at": "2022-07-14T10:45:13.156Z", "updated_at": "2022-08-16T10:52:08.094Z" } ], "validation_rules_assignments": { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_LnY1g7UNFA9KyDrD", "rule_id": "val_3gPNA6SnH4ae", "related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol", "related_object_type": "campaign", "object": "validation_rules_assignment", "validation_status": "PARTIALLY_VALID", "validation_omitted_rules": [ "1" ] } ], "total": 1 } }, "promotion_tier": { "id": "promo_63fYCt81Aw0h7lzyRkrGZh9p", "created_at": "2021-12-15T11:34:01.333Z", "updated_at": "2022-02-09T09:20:05.603Z", "name": "<string>", "banner": "<string>", "action": { "discount": { "type": "AMOUNT", "amount_off": 123, "amount_off_formula": "<string>", "aggregated_amount_limit": 123, "is_dynamic": true } }, "metadata": {}, "hierarchy": 123, "promotion_id": "<string>", "campaign": { "id": "<string>", "start_date": "2022-09-22T00:00:00.000Z", "expiration_date": "2022-09-30T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "active": true, "category_id": "cat_0b688929a2476386a6", "object": "campaign" }, "campaign_id": "<string>", "active": true, "start_date": "2022-09-23T00:00:00.000Z", "expiration_date": "2022-09-26T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "summary": { "redemptions": { "total_redeemed": 123 }, "orders": { "total_amount": 123, "total_discount_amount": 123 } }, "object": "promotion_tier", "validation_rule_assignments": { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_74F7QZoYbUoljwQO", "rule_id": "val_4j7DCRm2IS59", "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT", "created_at": "2022-02-17T08:18:15.085Z", "object": "validation_rules_assignment" } ], "total": 123 }, "category_id": "cat_0c9da30e7116ba6bba", "categories": [ { "id": "<string>", "name": "<string>", "hierarchy": 1, "object": "category", "created_at": "2022-07-14T10:45:13.156Z", "updated_at": "2022-08-16T10:52:08.094Z" } ] }, "reward": { "customer": { "id": "<string>", "name": "<string>", "email": "<string>", "source_id": "<string>", "metadata": {}, "object": "customer" }, "assignment_id": "<string>", "voucher": { "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV", "code": "WVPblOYX", "campaign": "Gift Card Campaign", "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV", "category": "<string>", "category_id": "cat_0bb343dee3cdb5ec0c", "discount": { "type": "AMOUNT", "amount_off": 123, "amount_off_formula": "<string>", "aggregated_amount_limit": 123, "is_dynamic": true }, "gift": { "amount": 10000, "subtracted_amount": 123, "balance": 500 }, "loyalty_card": { "points": 7000, "balance": 6970, "next_expiration_date": "2023-05-30", "next_expiration_points": 123, "pending_points": 123, "expired_points": 123, "subtracted_points": 123 }, "start_date": "2021-12-01T00:00:00.000Z", "expiration_date": "2021-12-31T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "active": true, "additional_info": "<string>", "metadata": {}, "assets": { "qr": { "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==", "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D" }, "barcode": { "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==", "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D" } }, "is_referral_code": true, "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4", "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv", "object": "voucher", "publish": { "object": "list", "count": 0, "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10" }, "redemption": { "quantity": 123, "redeemed_quantity": 1, "redeemed_points": 100000, "object": "list", "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10" }, "categories": [ { "id": "<string>", "name": "<string>", "hierarchy": 1, "object": "category", "created_at": "2022-07-14T10:45:13.156Z", "updated_at": "2022-08-16T10:52:08.094Z" } ], "validation_rules_assignments": { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_LnY1g7UNFA9KyDrD", "rule_id": "val_3gPNA6SnH4ae", "related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol", "related_object_type": "campaign", "object": "validation_rules_assignment", "validation_status": "PARTIALLY_VALID", "validation_omitted_rules": [ "1" ] } ], "total": 1 } }, "product": { "id": "prod_0b1da8105693710357", "source_id": "productSourceID16", "name": "T-shirt", "price": 123, "attributes": [ "<string>" ], "metadata": {}, "object": "product", "image_url": "https://images.com/original.jpg", "created_at": "2022-05-23T06:52:55.008Z", "updated_at": "2022-05-23T09:24:07.405Z", "skus": { "object": "list", "data_ref": "data", "data": [ { "id": "sku_0b1621b319d248b79f", "source_id": "sku_source_id_4", "product_id": "prod_0b15f6b9f650c16990", "sku": "Large Pink Shirt", "price": 123, "attributes": {}, "image_url": "<string>", "metadata": {}, "created_at": "2022-05-17T10:36:30.187Z", "updated_at": "2022-05-17T10:55:09.137Z", "object": "sku", "currency": "USD" } ], "total": 123 } }, "sku": { "id": "sku_0b1621b319d248b79f", "source_id": "sku_source_id_4", "product_id": "prod_0b15f6b9f650c16990", "sku": "Large Pink Shirt", "price": 123, "attributes": {}, "image_url": "<string>", "metadata": {}, "created_at": "2022-05-17T10:36:30.187Z", "updated_at": "2022-05-17T10:55:09.137Z", "object": "sku", "currency": "USD" }, "loyalty_tier_id": "<string>", "id": "rew_0bc92f81a6801f9bca", "name": "Reward Name", "object": "reward", "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2022-10-03T12:24:58.008Z", "parameters": { "campaign": { "id": "camp_13BbZ0kQsNinhqsX3wUts2UP", "balance": 123, "type": "<string>" }, "product": { "id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0a41e31c7b41c28358" }, "coin": { "exchange_ratio": 123, "points_ratio": 123 } }, "metadata": {} }, "gift": { "amount": 123 }, "loyalty_card": { "points": 123 } } ], "parent_rollback": { "id": "rr_0efeb3dab05e62e599", "object": "redemption_rollback", "date": "2021-12-22T10:13:06.487Z", "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64", "tracking_id": "<string>", "metadata": {}, "redemption": "r_0c656311b5878a2031", "order": { "id": "<string>", "source_id": "<string>", "amount": 123, "initial_amount": 123, "discount_amount": 123, "items_discount_amount": 123, "total_discount_amount": 123, "total_amount": 123, "applied_discount_amount": 123, "items_applied_discount_amount": 123, "total_applied_discount_amount": 123, "metadata": {}, "object": "order", "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1", "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix", "customer": { "id": "<string>", "object": "customer" }, "referrer": { "id": "<string>", "object": "customer" }, "redemptions": {}, "items": [ { "object": "order_item", "id": "<string>", "sku_id": "<string>", "product_id": "<string>", "source_id": "<string>", "quantity": 123, "discount_quantity": 123, "initial_quantity": 123, "amount": 123, "discount_amount": 123, "applied_discount_amount": 123, "applied_discount_quantity": 123, "applied_quantity": 123, "applied_quantity_amount": 123, "initial_amount": 123, "price": 123, "subtotal_amount": 123, "product": { "id": "<string>", "source_id": "<string>", "override": true, "name": "<string>", "metadata": {}, "price": 123 }, "sku": { "id": "<string>", "source_id": "<string>", "override": true, "sku": "<string>", "price": 123, "metadata": {} }, "metadata": {} } ] }, "channel": { "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH" }, "customer": { "id": "<string>", "name": "<string>", "email": "<string>", "source_id": "<string>", "metadata": {}, "object": "customer" }, "related_object_id": "<string>", "amount": -10000, "reason": "<string>", "failure_code": "customer_rules_violated", "failure_message": "<string>", "voucher": { "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV", "code": "WVPblOYX", "campaign": "Gift Card Campaign", "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV", "category": "<string>", "category_id": "cat_0bb343dee3cdb5ec0c", "discount": { "type": "AMOUNT", "amount_off": 123, "amount_off_formula": "<string>", "aggregated_amount_limit": 123, "is_dynamic": true }, "gift": { "amount": 10000, "subtracted_amount": 123, "balance": 500 }, "loyalty_card": { "points": 7000, "balance": 6970, "next_expiration_date": "2023-05-30", "next_expiration_points": 123, "pending_points": 123, "expired_points": 123, "subtracted_points": 123 }, "start_date": "2021-12-01T00:00:00.000Z", "expiration_date": "2021-12-31T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "active": true, "additional_info": "<string>", "metadata": {}, "assets": { "qr": { "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==", "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D" }, "barcode": { "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==", "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D" } }, "is_referral_code": true, "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4", "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv", "object": "voucher", "publish": { "object": "list", "count": 0, "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10" }, "redemption": { "quantity": 123, "redeemed_quantity": 1, "redeemed_points": 100000, "object": "list", "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10" }, "categories": [ { "id": "<string>", "name": "<string>", "hierarchy": 1, "object": "category", "created_at": "2022-07-14T10:45:13.156Z", "updated_at": "2022-08-16T10:52:08.094Z" } ], "validation_rules_assignments": { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_LnY1g7UNFA9KyDrD", "rule_id": "val_3gPNA6SnH4ae", "related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol", "related_object_type": "campaign", "object": "validation_rules_assignment", "validation_status": "PARTIALLY_VALID", "validation_omitted_rules": [ "1" ] } ], "total": 1 } }, "promotion_tier": { "id": "promo_63fYCt81Aw0h7lzyRkrGZh9p", "created_at": "2021-12-15T11:34:01.333Z", "updated_at": "2022-02-09T09:20:05.603Z", "name": "<string>", "banner": "<string>", "action": { "discount": { "type": "AMOUNT", "amount_off": 123, "amount_off_formula": "<string>", "aggregated_amount_limit": 123, "is_dynamic": true } }, "metadata": {}, "hierarchy": 123, "promotion_id": "<string>", "campaign": { "id": "<string>", "start_date": "2022-09-22T00:00:00.000Z", "expiration_date": "2022-09-30T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "active": true, "category_id": "cat_0b688929a2476386a6", "object": "campaign" }, "campaign_id": "<string>", "active": true, "start_date": "2022-09-23T00:00:00.000Z", "expiration_date": "2022-09-26T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "summary": { "redemptions": { "total_redeemed": 123 }, "orders": { "total_amount": 123, "total_discount_amount": 123 } }, "object": "promotion_tier", "validation_rule_assignments": { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_74F7QZoYbUoljwQO", "rule_id": "val_4j7DCRm2IS59", "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT", "created_at": "2022-02-17T08:18:15.085Z", "object": "validation_rules_assignment" } ], "total": 123 }, "category_id": "cat_0c9da30e7116ba6bba", "categories": [ { "id": "<string>", "name": "<string>", "hierarchy": 1, "object": "category", "created_at": "2022-07-14T10:45:13.156Z", "updated_at": "2022-08-16T10:52:08.094Z" } ] }, "reward": { "customer": { "id": "<string>", "name": "<string>", "email": "<string>", "source_id": "<string>", "metadata": {}, "object": "customer" }, "assignment_id": "<string>", "voucher": { "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV", "code": "WVPblOYX", "campaign": "Gift Card Campaign", "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV", "category": "<string>", "category_id": "cat_0bb343dee3cdb5ec0c", "discount": { "type": "AMOUNT", "amount_off": 123, "amount_off_formula": "<string>", "aggregated_amount_limit": 123, "is_dynamic": true }, "gift": { "amount": 10000, "subtracted_amount": 123, "balance": 500 }, "loyalty_card": { "points": 7000, "balance": 6970, "next_expiration_date": "2023-05-30", "next_expiration_points": 123, "pending_points": 123, "expired_points": 123, "subtracted_points": 123 }, "start_date": "2021-12-01T00:00:00.000Z", "expiration_date": "2021-12-31T00:00:00.000Z", "validity_timeframe": { "duration": "PT1H", "interval": "P2D" }, "validity_day_of_week": [], "validity_hours": { "daily": [ { "start_time": "12:00", "days_of_week": [], "expiration_time": "14:00" } ] }, "active": true, "additional_info": "<string>", "metadata": {}, "assets": { "qr": { "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==", "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D" }, "barcode": { "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==", "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D" } }, "is_referral_code": true, "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4", "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv", "object": "voucher", "publish": { "object": "list", "count": 0, "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10" }, "redemption": { "quantity": 123, "redeemed_quantity": 1, "redeemed_points": 100000, "object": "list", "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10" }, "categories": [ { "id": "<string>", "name": "<string>", "hierarchy": 1, "object": "category", "created_at": "2022-07-14T10:45:13.156Z", "updated_at": "2022-08-16T10:52:08.094Z" } ], "validation_rules_assignments": { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_LnY1g7UNFA9KyDrD", "rule_id": "val_3gPNA6SnH4ae", "related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol", "related_object_type": "campaign", "object": "validation_rules_assignment", "validation_status": "PARTIALLY_VALID", "validation_omitted_rules": [ "1" ] } ], "total": 1 } }, "product": { "id": "prod_0b1da8105693710357", "source_id": "productSourceID16", "name": "T-shirt", "price": 123, "attributes": [ "<string>" ], "metadata": {}, "object": "product", "image_url": "https://images.com/original.jpg", "created_at": "2022-05-23T06:52:55.008Z", "updated_at": "2022-05-23T09:24:07.405Z", "skus": { "object": "list", "data_ref": "data", "data": [ { "id": "sku_0b1621b319d248b79f", "source_id": "sku_source_id_4", "product_id": "prod_0b15f6b9f650c16990", "sku": "Large Pink Shirt", "price": 123, "attributes": {}, "image_url": "<string>", "metadata": {}, "created_at": "2022-05-17T10:36:30.187Z", "updated_at": "2022-05-17T10:55:09.137Z", "object": "sku", "currency": "USD" } ], "total": 123 } }, "sku": { "id": "sku_0b1621b319d248b79f", "source_id": "sku_source_id_4", "product_id": "prod_0b15f6b9f650c16990", "sku": "Large Pink Shirt", "price": 123, "attributes": {}, "image_url": "<string>", "metadata": {}, "created_at": "2022-05-17T10:36:30.187Z", "updated_at": "2022-05-17T10:55:09.137Z", "object": "sku", "currency": "USD" }, "loyalty_tier_id": "<string>", "id": "rew_0bc92f81a6801f9bca", "name": "Reward Name", "object": "reward", "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2022-10-03T12:24:58.008Z", "parameters": { "campaign": { "id": "camp_13BbZ0kQsNinhqsX3wUts2UP", "balance": 123, "type": "<string>" }, "product": { "id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0a41e31c7b41c28358" }, "coin": { "exchange_ratio": 123, "points_ratio": 123 } }, "metadata": {} }, "gift": { "amount": 123 }, "loyalty_card": { "points": 123 } }, "order": { "id": "<string>", "source_id": "<string>", "amount": 123, "initial_amount": 123, "discount_amount": 123, "items_discount_amount": 123, "total_discount_amount": 123, "total_amount": 123, "applied_discount_amount": 123, "items_applied_discount_amount": 123, "total_applied_discount_amount": 123, "metadata": {}, "object": "order", "created_at": "2021-12-22T10:13:06.487Z", "updated_at": "2021-12-22T10:14:45.316Z", "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1", "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix", "customer": { "id": "<string>", "object": "customer" }, "referrer": { "id": "<string>", "object": "customer" }, "redemptions": {}, "items": [ { "object": "order_item", "id": "<string>", "sku_id": "<string>", "product_id": "<string>", "source_id": "<string>", "quantity": 123, "discount_quantity": 123, "initial_quantity": 123, "amount": 123, "discount_amount": 123, "applied_discount_amount": 123, "applied_discount_quantity": 123, "applied_quantity": 123, "applied_quantity_amount": 123, "initial_amount": 123, "price": 123, "subtotal_amount": 123, "product": { "id": "<string>", "source_id": "<string>", "override": true, "name": "<string>", "metadata": {}, "price": 123 }, "sku": { "id": "<string>", "source_id": "<string>", "override": true, "sku": "<string>", "price": 123, "metadata": {} }, "metadata": {} } ] } }

Authorizations

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

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

parentRedemptionId · string · required

Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm.

Example:

"r_0ba186c4824e4881e1"

Query Parameters

reason · string

Reason for the rollback.

tracking_id · string

Customer's source_id.

Body

application/json

Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body.

Request body schema for POST v1/redemptions/{parentRedemptionId}/rollbacks.

reason · string

Reason for the rollback.

tracking_id · string

Customer's source_id.

customer · Customer · object

Show child attributes

order · Order · object

Order information.

Show child attributes

metadata · object

A set of key/value pairs that you can send in the request body to update redemption metadata.

Response

200

application/json

Returns an array with the individual redemption rollback results along with the parent rollback result and related order.

Response body schema for POST /redemptions/{parentRedemptionID}/rollbacks.

rollbacks · Redemption Rollback · object[]

Contains the rollback redemption objects of the particular incentives.

Show child attributes

parent_rollback · Redemption Rollback · object

This is an object representing a redemption rollback.

Show child attributes

order · Order Calculated No Customer Data · object

Order information.

Show child attributes