Skip to main content
POST
/
v1
/
redemptions
/
{parentRedemptionId}
/
rollbacks
Rollback Stackable Redemptions
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/redemptions/{parentRedemptionId}/rollbacks \
  --header 'Authorization: Bearer <token>' \
  --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": "annie@lemon.com",
    "phone": "+1 933 222 3334",
    "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"
    ]
  }
}'
{
  "rollbacks": [
    {
      "id": "rr_0efeb3dab05e62e599",
      "object": "redemption_rollback",
      "date": "2021-12-22T10:13:06.487Z",
      "customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
      "tracking_id": "<string>",
      "metadata": {},
      "amount": -10000,
      "redemption": "r_0c656311b5878a2031",
      "reason": "<string>",
      "result": "SUCCESS",
      "status": "SUCCEEDED",
      "failure_code": "customer_rules_violated",
      "failure_message": "<string>",
      "order": {
        "id": "<string>",
        "source_id": "<string>",
        "status": "CREATED",
        "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": [
          {
            "id": "<string>",
            "sku_id": "<string>",
            "product_id": "<string>",
            "related_object": "product",
            "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": {}
            },
            "object": "order_item",
            "metadata": {}
          }
        ]
      },
      "channel": {
        "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
        "channel_type": "USER"
      },
      "customer": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "source_id": "<string>",
        "metadata": {},
        "object": "customer"
      },
      "related_object_type": "voucher",
      "related_object_id": "<string>",
      "voucher": {
        "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
        "code": "WVPblOYX",
        "campaign": "Gift Card Campaign",
        "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
        "category": "<string>",
        "category_id": "cat_0bb343dee3cdb5ec0c",
        "type": "GIFT_VOUCHER",
        "discount": {
          "type": "AMOUNT",
          "amount_off": 123,
          "amount_off_formula": "<string>",
          "aggregated_amount_limit": 123,
          "effect": "APPLY_TO_ORDER",
          "is_dynamic": true
        },
        "gift": {
          "amount": 10000,
          "subtracted_amount": 123,
          "balance": 500,
          "effect": "APPLY_TO_ORDER"
        },
        "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": [
          0
        ],
        "validity_hours": {
          "daily": [
            "<any>"
          ]
        },
        "active": true,
        "additional_info": "<string>",
        "metadata": {},
        "assets": {
          "qr": {
            "id": "<any>",
            "url": "<any>"
          },
          "barcode": {
            "id": "<any>",
            "url": "<any>"
          }
        },
        "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": "<string>",
        "publish": {
          "object": "<string>",
          "count": 0,
          "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
        },
        "redemption": {
          "quantity": 123,
          "redeemed_quantity": 1,
          "redeemed_points": 100000,
          "object": "<string>",
          "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
        },
        "categories": [
          {
            "id": "<any>",
            "name": "<any>",
            "hierarchy": "<any>",
            "object": "<any>",
            "created_at": "<any>",
            "updated_at": "<any>"
          }
        ],
        "validation_rules_assignments": {
          "object": "list",
          "data_ref": "data",
          "data": [
            "<any>"
          ],
          "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,
            "effect": "APPLY_TO_ORDER",
            "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": [
            0
          ],
          "validity_hours": {
            "daily": [
              "<any>"
            ]
          },
          "active": true,
          "category_id": "cat_0b688929a2476386a6",
          "object": "<string>"
        },
        "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": [
          0
        ],
        "validity_hours": {
          "daily": [
            "<any>"
          ]
        },
        "summary": {
          "redemptions": {
            "total_redeemed": 123
          },
          "orders": {
            "total_amount": 123,
            "total_discount_amount": 123
          }
        },
        "object": "<string>",
        "validation_rule_assignments": {
          "object": "<string>",
          "data_ref": "<string>",
          "data": [
            {
              "id": "asgm_74F7QZoYbUoljwQO",
              "rule_id": "val_4j7DCRm2IS59",
              "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
              "related_object_type": "voucher",
              "created_at": "2022-02-17T08:18:15.085Z",
              "object": "validation_rules_assignment"
            }
          ],
          "total": 123
        },
        "category_id": "cat_0c9da30e7116ba6bba",
        "categories": [
          {
            "id": "<any>",
            "name": "<any>",
            "hierarchy": "<any>",
            "object": "<any>",
            "created_at": "<any>",
            "updated_at": "<any>"
          }
        ]
      },
      "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",
          "type": "GIFT_VOUCHER",
          "discount": {
            "type": "AMOUNT",
            "amount_off": 123,
            "amount_off_formula": "<string>",
            "aggregated_amount_limit": 123,
            "effect": "APPLY_TO_ORDER",
            "is_dynamic": true
          },
          "gift": {
            "amount": 10000,
            "subtracted_amount": 123,
            "balance": 500,
            "effect": "APPLY_TO_ORDER"
          },
          "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": [
            0
          ],
          "validity_hours": {
            "daily": [
              "<any>"
            ]
          },
          "active": true,
          "additional_info": "<string>",
          "metadata": {},
          "assets": {
            "qr": {
              "id": "<any>",
              "url": "<any>"
            },
            "barcode": {
              "id": "<any>",
              "url": "<any>"
            }
          },
          "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": "<string>",
          "publish": {
            "object": "<string>",
            "count": 0,
            "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
          },
          "redemption": {
            "quantity": 123,
            "redeemed_quantity": 1,
            "redeemed_points": 100000,
            "object": "<string>",
            "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
          },
          "categories": [
            {
              "id": "<any>",
              "name": "<any>",
              "hierarchy": "<any>",
              "object": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>"
            }
          ],
          "validation_rules_assignments": {
            "object": "list",
            "data_ref": "data",
            "data": [
              "<any>"
            ],
            "total": 1
          }
        },
        "product": {
          "id": "prod_0b1da8105693710357",
          "source_id": "productSourceID16",
          "name": "T-shirt",
          "price": 123,
          "attributes": [
            "<string>"
          ],
          "metadata": {},
          "image_url": "https://images.com/original.jpg",
          "created_at": "2022-05-23T06:52:55.008Z",
          "updated_at": "2022-05-23T09:24:07.405Z",
          "object": "product",
          "skus": {
            "object": "<string>",
            "data_ref": "<string>",
            "data": [
              {}
            ],
            "total": 123
          }
        },
        "sku": {
          "id": "sku_0b1621b319d248b79f",
          "source_id": "sku_source_id_4",
          "product_id": "prod_0b15f6b9f650c16990",
          "sku": "Large Pink Shirt",
          "price": 123,
          "currency": "USD",
          "attributes": {},
          "image_url": "<string>",
          "metadata": {},
          "created_at": "2022-05-17T10:36:30.187Z",
          "updated_at": "2022-05-17T10:55:09.137Z",
          "object": "sku"
        },
        "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": {},
        "type": "CAMPAIGN"
      },
      "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": {},
    "amount": -10000,
    "redemption": "r_0c656311b5878a2031",
    "reason": "<string>",
    "result": "SUCCESS",
    "status": "SUCCEEDED",
    "failure_code": "customer_rules_violated",
    "failure_message": "<string>",
    "order": {
      "id": "<string>",
      "source_id": "<string>",
      "status": "CREATED",
      "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": [
        {
          "id": "<string>",
          "sku_id": "<string>",
          "product_id": "<string>",
          "related_object": "product",
          "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": {}
          },
          "object": "order_item",
          "metadata": {}
        }
      ]
    },
    "channel": {
      "channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
      "channel_type": "USER"
    },
    "customer": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "source_id": "<string>",
      "metadata": {},
      "object": "customer"
    },
    "related_object_type": "voucher",
    "related_object_id": "<string>",
    "voucher": {
      "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
      "code": "WVPblOYX",
      "campaign": "Gift Card Campaign",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "category": "<string>",
      "category_id": "cat_0bb343dee3cdb5ec0c",
      "type": "GIFT_VOUCHER",
      "discount": {
        "type": "AMOUNT",
        "amount_off": 123,
        "amount_off_formula": "<string>",
        "aggregated_amount_limit": 123,
        "effect": "APPLY_TO_ORDER",
        "is_dynamic": true
      },
      "gift": {
        "amount": 10000,
        "subtracted_amount": 123,
        "balance": 500,
        "effect": "APPLY_TO_ORDER"
      },
      "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": [
        0
      ],
      "validity_hours": {
        "daily": [
          "<any>"
        ]
      },
      "active": true,
      "additional_info": "<string>",
      "metadata": {},
      "assets": {
        "qr": {
          "id": "<any>",
          "url": "<any>"
        },
        "barcode": {
          "id": "<any>",
          "url": "<any>"
        }
      },
      "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": "<string>",
      "publish": {
        "object": "<string>",
        "count": 0,
        "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
      },
      "redemption": {
        "quantity": 123,
        "redeemed_quantity": 1,
        "redeemed_points": 100000,
        "object": "<string>",
        "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
      },
      "categories": [
        {
          "id": "<any>",
          "name": "<any>",
          "hierarchy": "<any>",
          "object": "<any>",
          "created_at": "<any>",
          "updated_at": "<any>"
        }
      ],
      "validation_rules_assignments": {
        "object": "list",
        "data_ref": "data",
        "data": [
          "<any>"
        ],
        "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,
          "effect": "APPLY_TO_ORDER",
          "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": [
          0
        ],
        "validity_hours": {
          "daily": [
            "<any>"
          ]
        },
        "active": true,
        "category_id": "cat_0b688929a2476386a6",
        "object": "<string>"
      },
      "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": [
        0
      ],
      "validity_hours": {
        "daily": [
          "<any>"
        ]
      },
      "summary": {
        "redemptions": {
          "total_redeemed": 123
        },
        "orders": {
          "total_amount": 123,
          "total_discount_amount": 123
        }
      },
      "object": "<string>",
      "validation_rule_assignments": {
        "object": "<string>",
        "data_ref": "<string>",
        "data": [
          {
            "id": "asgm_74F7QZoYbUoljwQO",
            "rule_id": "val_4j7DCRm2IS59",
            "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
            "related_object_type": "voucher",
            "created_at": "2022-02-17T08:18:15.085Z",
            "object": "validation_rules_assignment"
          }
        ],
        "total": 123
      },
      "category_id": "cat_0c9da30e7116ba6bba",
      "categories": [
        {
          "id": "<any>",
          "name": "<any>",
          "hierarchy": "<any>",
          "object": "<any>",
          "created_at": "<any>",
          "updated_at": "<any>"
        }
      ]
    },
    "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",
        "type": "GIFT_VOUCHER",
        "discount": {
          "type": "AMOUNT",
          "amount_off": 123,
          "amount_off_formula": "<string>",
          "aggregated_amount_limit": 123,
          "effect": "APPLY_TO_ORDER",
          "is_dynamic": true
        },
        "gift": {
          "amount": 10000,
          "subtracted_amount": 123,
          "balance": 500,
          "effect": "APPLY_TO_ORDER"
        },
        "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": [
          0
        ],
        "validity_hours": {
          "daily": [
            "<any>"
          ]
        },
        "active": true,
        "additional_info": "<string>",
        "metadata": {},
        "assets": {
          "qr": {
            "id": "<any>",
            "url": "<any>"
          },
          "barcode": {
            "id": "<any>",
            "url": "<any>"
          }
        },
        "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": "<string>",
        "publish": {
          "object": "<string>",
          "count": 0,
          "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
        },
        "redemption": {
          "quantity": 123,
          "redeemed_quantity": 1,
          "redeemed_points": 100000,
          "object": "<string>",
          "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
        },
        "categories": [
          {
            "id": "<any>",
            "name": "<any>",
            "hierarchy": "<any>",
            "object": "<any>",
            "created_at": "<any>",
            "updated_at": "<any>"
          }
        ],
        "validation_rules_assignments": {
          "object": "list",
          "data_ref": "data",
          "data": [
            "<any>"
          ],
          "total": 1
        }
      },
      "product": {
        "id": "prod_0b1da8105693710357",
        "source_id": "productSourceID16",
        "name": "T-shirt",
        "price": 123,
        "attributes": [
          "<string>"
        ],
        "metadata": {},
        "image_url": "https://images.com/original.jpg",
        "created_at": "2022-05-23T06:52:55.008Z",
        "updated_at": "2022-05-23T09:24:07.405Z",
        "object": "product",
        "skus": {
          "object": "<string>",
          "data_ref": "<string>",
          "data": [
            {}
          ],
          "total": 123
        }
      },
      "sku": {
        "id": "sku_0b1621b319d248b79f",
        "source_id": "sku_source_id_4",
        "product_id": "prod_0b15f6b9f650c16990",
        "sku": "Large Pink Shirt",
        "price": 123,
        "currency": "USD",
        "attributes": {},
        "image_url": "<string>",
        "metadata": {},
        "created_at": "2022-05-17T10:36:30.187Z",
        "updated_at": "2022-05-17T10:55:09.137Z",
        "object": "sku"
      },
      "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": {},
      "type": "CAMPAIGN"
    },
    "gift": {
      "amount": 123
    },
    "loyalty_card": {
      "points": 123
    }
  },
  "order": {
    "id": "<string>",
    "source_id": "<string>",
    "status": "CREATED",
    "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": [
      {
        "id": "<string>",
        "sku_id": "<string>",
        "product_id": "<string>",
        "related_object": "product",
        "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": {}
        },
        "object": "order_item",
        "metadata": {}
      }
    ]
  }
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

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
object
​
order
object

Order information.

​
metadata
object

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

Response

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.

​
parent_rollback
object

This is an object representing a redemption rollback.

​
order
object

Order information.

⌘I