Sign in
VoucherCodes

Retrieve a VoucherCode

Retrieves a single VoucherCode by ID, including every redemption recorded against it. Use this when you have a voucher ID from a webhook payload, the listVoucherCodes response, or a customer-service search, and need the canonical record plus full redemption history.

Trashed (soft-deleted) voucher codes are returned by this endpoint with status of revoked, so customer-service flows can inspect revoked codes without a separate lookup.

get/shop/voucher-codes/{voucherCodeId}

Response

The VoucherCode was successfully retrieved.

Example response

{
  "data": {
    "code": "ABC123XYZ",
    "valid_from_date": "2026-01-01T00:00:00+00:00",
    "valid_to_date": "2027-01-01T00:00:00+00:00",
    "amount": 5000,
    "balance": 2500,
    "currency": "gbp",
    "value": 5000,
    "partially_redeemable": true,
    "uses_total": 7,
    "uses_remaining": 5,
    "fulfillment_status": "needs_dispatching",
    "voucher_type": {
      "name": "Spa Day Gift Voucher"
    },
    "recipient": {
      "name": "Jane Doe",
      "email": "jane@example.com"
    },
    "delivery": {
      "method": "post",
      "option": {
        "name": "First class mail",
        "price": 5000,
        "revenue_centre": "spa"
      }
    },
    "order": {
      "order_ref": "TRY00",
      "item_cost": 5000
    },
    "redemptions": [
      {
        "amount": 2500
      }
    ],
    "created_at": "2025-02-04T12:00:00+01:00",
    "issued_at": "2026-01-02T09:00:00+00:00"
  }
}

Changes