---
title: "Get voucher info"
method: GET
path: "/shops/{SHOP_ID}/vouchers/{VOUCHER_ID}"
tags: ["Voucher"]
---

# Get voucher info

`GET /shops/{SHOP_ID}/vouchers/{VOUCHER_ID}`

## Request

- Base URL: `https://pos.pages.fm/api/v1`
- URL: `https://pos.pages.fm/api/v1/shops/{SHOP_ID}/vouchers/{VOUCHER_ID}`
- Auth: API key in query parameter `api_key`

Get voucher information

## Path parameters

- `SHOP_ID` integer, required
- `VOUCHER_ID` string, required

## Response `200`

Success

- object
  - `data` Voucher: Voucher information
    - `id` string: Voucher ID
    - `display_id` integer: Voucher ID
    - `name` string: Voucher name
    - `type` string: Voucher type
    - `start_time` string, date-time: Voucher start time
    - `end_time` string, date-time: Voucher end time
    - `promo_code_info` object: Voucher promo code information
      - `discount` integer: Discount value
      - `is_percent` boolean: Is percent
      - `max_discount_by_percent` integer: Maximum discount by percent
    - `is_free_shipping` boolean: Is free shipping
    - `is_activated` boolean: Is activated
    - `is_used` boolean: Is used
    - `customer_tags` string[]: Customer tags
    - `shop_id` integer: Shop ID
    - `creator_id` string: Creator ID
    - `inserted_at` string, date-time: Inserted at
    - `updated_at` string, date-time: Updated at
  - `success` boolean: Success status

---

[API](https://skmtc.dev/pancake/apis/pancake-pos-open-api.md) - [All operations](https://skmtc.dev/pancake/apis/pancake-pos-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pancake/apis/pancake-pos-open-api/revisions/3df28d1fb5dc?raw)