Get Voucher Redemptions

Get Voucher's Redemptions

GET/v1/vouchers/{code}/redemption

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the Get Voucher Redemptions action (under Redemptions).
Fill in the fields below, then reference the result from later steps as {{getVoucherRedemptions.response.data}}.

Request

Path parameters

codestringrequired

A **code** that identifies the voucher.

Response

Returns 200 with an object. Read it in later steps with {{getVoucherRedemptions.response.data.<field>}}.

quantityinteger

The maximum number of times a voucher can be redeemed.

redeemed_quantityinteger

The number of times the voucher was redeemed successfully.

objectstring

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

Default "list"

urlstring

URL

data_refstring

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

Default "redemption_entries"

totalinteger

Total number of redemption objects.

redemption_entriesany

Contains the array of successful and failed redemption objects.

json

{
  "redemption_entries": null,
  "quantity": 0,
  "redeemed_quantity": 0,
  "object": "list",
  "url": "/v1/vouchers/PROMO-CODE2/redemptions?page=1&limit=10",
  "data_ref": "redemption_entries",
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?