---
title: "GET /api/v1.0/{appId}/vouchers/code/{code}"
method: GET
path: "/api/v1.0/{appId}/vouchers/code/{code}"
tags: ["Vouchers"]
---

# GET /api/v1.0/{appId}/vouchers/code/{code}

`GET /api/v1.0/{appId}/vouchers/code/{code}`

## Path parameters

- `appId` string, required
- `code` string, required

## Response `200`

OK

- RestApiResultVoucher — Rest api result
  - `Data` Voucher, required — Voucher
    - `VoucherId` integer — Voucher Id
    - `Status` 'Valid' | 'NotYetValid' | 'Expired' | 'Used' | 'Disabled' — Voucher Status
    - `VoucherType` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher Type
    - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — Currency of the voucher
    - `StoreNames` string[] — Stores that this voucher applies to
    - `PromotionDetails` PromotionDetails — Promotion
      - `PromotionId` integer — Promotion Id
      - `Name` string — The name of the promotion
      - `PromotionAwards` PromotionAward[] — The items that this promotion will award
        - `PromotionAwardId` integer — Promotion Award Id
        - `MenuItemPublicId` string, uuid — The public id of the menu item that will be awarded
    - `CreditNoteDetails` CreditNoteDetails — Credit note details
      - `RemainingCredit` number, double — Remaining credit
    - `LumpDiscountDetails` LumpDiscountDetails — Lump discount details
      - `DiscountAmount` number, double — Discount amount
    - `PercentDiscountDetails` PercentDiscountDetails — Percent discount details
      - `PercentageDiscount` integer — Percentage discount
      - `MaxDiscountAmount` number, double, nullable — The maximum amount that the percentage discount value can be. If not set then there is no maximum. If set to e.g. 20 euro, and the percentage discount is 25%, and the order total is 100 euro, then the discount will be 20 euro (not 25 euro).
    - `Code` string — Voucher Code
    - `Description` string — Voucher Description (Visible on printout)
    - `Stores` integer[] — Stores that this voucher applies to
    - `ValidOnOrdersOver` number, double — Valid on orders on or above
    - `TakesPriority` boolean — Takes priority
    - `IsEnabled` boolean — Is voucher enabled
    - `IsAutomaticallyApplied` boolean — Is voucher automatically applied
    - `IncludeDeliveryFee` boolean — Include delivery fees
    - `IsValidForDeliveryOrders` boolean — Valid for delivery orders
    - `IsValidForPickupOrders` boolean — Valid for pickup orders
    - `IsValidForOrdersPayedOnline` boolean — Valid for orders payed online
    - `IsValidForOrdersPayedByCash` boolean — Valid for orders payed in cash
    - `IsValidForFirstOrderOnly` boolean — Valid only on the first order by the customer
    - `IsValidOncePerCustomer` boolean — Valid once per customer
    - `IsValidOnlyOnce` boolean — Valid only once, by any customer (once used cannot be used again by any other customer)
    - `IsDiscoverable` boolean — Enables the voucher to be offered in the Voucher Discoverability feature
    - `ForceDiscount` boolean — Force the discount to be applied which bypasses some menu restrictions
    - `StartDate` string, date-time — Voucher Starts On (Time in UTC)
    - `ExpiryDate` string, date-time — Voucher Expires On (Time in UTC)
    - `ChannelRestrictions` string[] — Limit the channels this voucher can be used on
    - `ValidityPeriods` ValidityPeriod[] — Periods in which the voucher is valid. An empty list means the voucher is valid at all times. When updating the voucher, if this is set to null, the validity periods won't be updated.
      - `DayOfWeek` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — DayOfWeek.
      - `StartTime` string — StartTime.
      - `EndTime` string — EndTime.
    - `VoucherSubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher Subtype
    - `CustomerId` integer, nullable — Customer UserID
    - `MaxRedemptions` integer, nullable — Maximum number of times the voucher can be redeemed (used)

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Successful authentication, but authorization has been denied for this request.
- `404` — NotFound

---

[API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)