> ## Documentation Index > Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt > Use this file to discover all available pages before exploring further. # Get Voucher > Retrieves the voucher with the given `code` or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., `v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE`, or the `code` of the voucher as the path parameter value, e.g., `7fjWdr`. ## OpenAPI ````yaml /openapi/vouchers.json get /v1/vouchers/{code} openapi: 3.0.1 info: title: Voucherify API - Vouchers version: v2018-08-01 description: >- Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details. contact: name: Voucherify Team url: https://www.voucherify.io/contact-support email: support@voucherify.io termsOfService: https://www.voucherify.io/legal/subscription-agreement license: name: MIT url: https://github.com/voucherifyio/voucherify-js-sdk/blob/main/LICENSE servers: - url: https://{cluster}.voucherify.io description: Base URL variables: cluster: default: api enum: - api - us1.api - as1.api - download - us1.download - as1.download security: [] paths: /v1/vouchers/{code}: parameters: - schema: $ref: '#/components/schemas/ParameterCode' in: path name: code description: A unique **code** that identifies the voucher. required: true get: tags: - Vouchers summary: Get Voucher description: >- Retrieves the voucher with the given `code` or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., `v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE`, or the `code` of the voucher as the path parameter value, e.g., `7fjWdr`. operationId: get-voucher parameters: [] responses: '200': description: >- Returns a voucher object if a valid identifier was provided. Additionally, the response returns validation rules related to the voucher object. They can be inherited from a campaign. content: application/json: schema: $ref: '#/components/schemas/VouchersGetResponseBody' examples: Loyalty Card: value: id: v_hrMBBeT4sOP9VSGPmj5KAgJwX202UjiY code: LOYALTY-CARD-xLPbpbXR campaign: Loyalty Program Fall 2022 campaign_id: camp_f7fBbQxUuTN7dI7tGOo5XMDA category: First category_id: cat_0bb343dee3cdb5ec0c categories: - id: cat_0bb343dee3cdb5ec0c name: First hierarchy: 1 created_at: '2022-09-16T11:47:19.568Z' object: category type: LOYALTY_CARD discount: null gift: null loyalty_card: points: 110 balance: 100 next_expiration_date: '2023-12-31' next_expiration_points: 100 start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX19OrTPNyUztbNretF7tPRL4ZlUDPAUXVGL9e5UCPh6dic8zXEP8/6I6hUEqtz/F6IMIghWz1ljdjzpdizGHG3HZBw4c19fd8SD/DjhBRDSr8APqKGpZTLKe4QC2gislFTeDAq2lmJb6T1oOTBUGkUEwMgEX1Vlco9A= url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX1/SpYuOrU9wd6/o1wzy6E/04wURHJ1xuMutzkIUx6OBTmHX5BO8XZRmEFHkgjC5eWJ27ArgAruJfwRXWuQfTNFD4raI9YvIiQNEzsZ0ydxwKBqJ/FJtiw69djuzQk1f4HdQo8s5gaZ7fd2U+1zbaeAvi9usyvRHZE4= url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-19T07:56:22.355Z' updated_at: '2022-09-19T08:04:22.458Z' holder_id: cust_eWgXlBBiY6THFRJwX45Iakv4 validation_rules_assignments: object: list data_ref: data data: [] total: 0 redemption: quantity: null redeemed_quantity: 1 redeemed_points: 10 object: list url: >- /v1/vouchers/LOYALTY-CARD-xLPbpbXR/redemptions?page=1&limit=10 publish: object: list count: 1 url: >- /v1/vouchers/LOYALTY-CARD-xLPbpbXR/publications?page=1&limit=10 object: voucher Gift Card: value: id: v_hS8JFl8S6lNcd1L69wLIoXgTio7eWEgk code: GIFT-CARD-xwc6X7Tk campaign: Gift Cards campaign_id: camp_kdxp3vf1clQ9CFs1jpqv3tZe category: null category_id: null type: GIFT_VOUCHER discount: null gift: amount: 55000 balance: 44700 effect: APPLY_TO_ORDER loyalty_card: null start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX19SdT2kQZokSFsMRa5NmGvsHunHReeb4gF9b5LtLA4rCTM/aTyHCYfr7kRWb2vv08WIgY/Tv53SJGW+k2keqfsTq/Ohb5shkCN3FTFsaI8gulTp616sEGn/JJoIInIoNkO9Vd1+AfrKiAjmirCmekE6cz2SVCyNAXs= url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX18vWc/qplwajJz4RIIy2wDUcAXVo1KEmyXx2IJy44xxHg608po3RizU9OYOzKelOAEjXFf7E4BS5Q01s4dds8Du70LGAp3idYMKAaXIjMTcFjMNczNO6ULK7r4eDx2Np8jvO/199U+zicnFNWqg/jF5ZCQW+6jO1q8= url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-07-08T09:44:33.179Z' updated_at: '2022-08-29T09:37:20.185Z' holder_id: cust_eWgXlBBiY6THFRJwX45Iakv4 validation_rules_assignments: object: list data_ref: data data: [] total: 0 redemption: quantity: null redeemed_quantity: 7 redeemed_amount: 10300 object: list url: >- /v1/vouchers/GIFT-CARD-xwc6X7Tk/redemptions?page=1&limit=10 publish: object: list count: 1 url: >- /v1/vouchers/GIFT-CARD-xwc6X7Tk/publications?page=1&limit=10 object: voucher Amount Discount: value: id: v_OBVfpTVf24DBz0HZmKVZa5UEl1DUg2bn code: AMOUNTDISCOUNTUSINGFORMULA campaign: null campaign_id: null category: First category_id: cat_0bb343dee3cdb5ec0c categories: - id: cat_0bb343dee3cdb5ec0c name: First hierarchy: 1 created_at: '2022-09-16T11:47:19.568Z' object: category type: DISCOUNT_VOUCHER discount: type: AMOUNT amount_off: 400 amount_off_formula: >- IF(CUSTOMER_METADATA("favorite_brands") contains "Nike";20;CUSTOMER_METADATA("age")) effect: APPLY_TO_ORDER gift: null loyalty_card: null start_date: '2022-09-01T00:00:00.000Z' expiration_date: '2022-10-31T00:00:00.000Z' validity_timeframe: null validity_day_of_week: - 1 - 2 - 3 - 4 - 5 active: true additional_info: >- This voucher discount is based on a formula, payment must be using VISA, and order must be over $100. metadata: {} assets: qr: id: >- U2FsdGVkX18tV6jdzxWPwEzjeiX4DoM06JpwaoKUNGMNx4Td5e8FwA68uIHQwPaRpJr9CUCpiP4IsSD8nEJn1YtEv6FnY83wIv7uljYoQOYmMPyhKec8Ct3zH7KurMGuj4Fhws3HNA3bqP5MYEy+aA== url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX181+WljOgxIt9Jg1Urbuv226+8Ug0DIyZiI0WtThPNYKZZEodzqQpIsGSdrDGXr2chLo+4FH3Ey8G2YXCPM6nUhZRSMF5oL3+uNjcLtBvb7MF5+ynY5fIgpXolwUK0R/BuT4Pa8prhgTg== url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-12T07:51:02.145Z' updated_at: '2022-09-19T08:29:12.566Z' holder_id: cust_eWgXlBBiY6THFRJwX45Iakv4 validation_rules_assignments: object: list data_ref: data data: - id: asgm_tO5AuzXIkkNPTC50 rule_id: val_5h0wc453_2 related_object_id: v_OBVfpTVf24DBz0HZmKVZa5UEl1DUg2bn related_object_type: voucher created_at: '2022-09-19T08:27:59.160Z' object: validation_rules_assignment total: 1 redemption: quantity: null redeemed_quantity: 2 object: list url: >- /v1/vouchers/AMOUNTDISCOUNTUSINGFORMULA/redemptions?page=1&limit=10 publish: object: list count: 1 url: >- /v1/vouchers/AMOUNTDISCOUNTUSINGFORMULA/publications?page=1&limit=10 object: voucher Percent Discount: value: id: v_2LcXRN4X0TNNgPoBceXIsE4LYs13kta1 code: PercentDiscountUsingFormula campaign: null campaign_id: null category: null category_id: null type: DISCOUNT_VOUCHER discount: type: PERCENT percent_off: 3 percent_off_formula: CUSTOMER_METADATA("age") effect: APPLY_TO_ITEMS gift: null loyalty_card: null start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX1+74dNbbuHNdVR+5SXVrdo6Zp2tUInlseZtheoYEvrayBBDEoJFaeDuC1BzQr+j8ayuFU7+BtCdNe25YRae4Mp+3Y1HsrkVudshKRzMBdS/43GT9Qi6tOXQDsYjHh70zNz13lMOC9bnaX6WZCVU0vRWM/VDXbYNxGZH6V1wpcGOkmkhkEYPSuIXBDF65FsgHOAwIPvKBxa/aQ== url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX19t8/dJWDNnnwPtxt3e0kZTDAELYiQcSHWIEO5wr6uLeDbM2KKbGYUfkKKtZRsWtiKhOQQc7zmNoCqR82UB+p0gzGM0tyXa/npbPUTe0Y5Y/arDPnomb9AaUFjK9Uq5OUBYbxi1ERqEhy/20Owr0m0e0E2I3jQmgAxkNokRm1g31zX4zheea8gTtiFwb6ZrYvGbaOhj5IxYWg== url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-15T10:20:46.467Z' updated_at: '2022-09-15T10:43:51.116Z' validation_rules_assignments: object: list data_ref: data data: - id: asgm_EuYasM5fyDR9G2r4 rule_id: val_0k19OQHjNZRT related_object_id: v_2LcXRN4X0TNNgPoBceXIsE4LYs13kta1 related_object_type: voucher created_at: '2022-09-15T10:20:46.460Z' object: validation_rules_assignment total: 1 redemption: quantity: null redeemed_quantity: 3 object: list url: >- /v1/vouchers/PercentDiscountUsingFormula/redemptions?page=1&limit=10 publish: object: list count: 0 url: >- /v1/vouchers/PercentDiscountUsingFormula/publications?page=1&limit=10 object: voucher Fixed Discount: value: id: v_zXQtyi5FYQYoRXv459hmK8M5Gi2lLoDl code: FixedDiscountUsingFormula campaign: null campaign_id: null category: null category_id: null type: DISCOUNT_VOUCHER discount: type: FIXED effect: APPLY_TO_ORDER fixed_amount: 200 fixed_amount_formula: >- IF(ORDER_UNITS_QUANTITY > 3;CUSTOMER_METADATA("age") + 2;CUSTOMER_METADATA("age") - 2) gift: null loyalty_card: null start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX1+sY8iWRFMrrPOjY6pS7JZSqJUPIzAgFO5oy5GvTj27KrukNxucE4wrA4n9QL7pua3CfJzGWe0Hc5J6XXU2m5ktik4iUNRO6pxZmL4ZuR96C1XHJAGaIiI7lM17OjJD2b72/hyyDUi8DflzcYixFdXTOR3o1rcaPoY= url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX1+af+iouhzUVUL0IocB7BAWR8rB0z8/9/OgYi32EHQ9salEEtE3XYPWtseOAxi5keMRp6K3JLDyx4RvYpw3Fe5SN0ed7PEcWr4fLUoUBntHtH0lOPFOtWxpY3tAjnyWpE/CYTR/S135KZ6GIfCS/+VQNrzbS/bFXgY= url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-15T12:46:55.818Z' updated_at: '2022-09-16T10:03:25.057Z' validation_rules_assignments: object: list data_ref: data data: [] total: 0 redemption: quantity: null redeemed_quantity: 5 object: list url: >- /v1/vouchers/FixedDiscountUsingFormula/redemptions?page=1&limit=10 publish: object: list count: 0 url: >- /v1/vouchers/FixedDiscountUsingFormula/publications?page=1&limit=10 object: voucher Unit Discount: value: id: v_JkjV4v9OKTsaIuHoqXGrkGijNaRGYNzm code: UnitDiscountUsingFormula campaign: null campaign_id: null category: null category_id: null type: DISCOUNT_VOUCHER discount: type: UNIT unit_off: 1 unit_off_formula: >- IF(ORDER_UNITS_QUANTITY > 3;CUSTOMER_METADATA("age") / 5;CUSTOMER_METADATA("age") / 10) unit_type: sku_0b661e41eccd35a8e9 effect: ADD_MISSING_ITEMS gift: null loyalty_card: null start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX1+6okuUQBKDcu0jGGg0jOU3kwYUFhX79TdwYKjXyV14BX74z/lehzciL0vdtutoiMVf8Nzl+B278gSHI5TiecPsTXChbGKSjH9gYUxZkdQev0qfmR4frKHjKKHHfT9DEcRWCLwKDJ9V+b89EAmbMouLlaDvkD63bZI= url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX19E7POETWB9YO+S4gkbGFQSm4VDNXEvqdlln6cWiyWTplnWkiUbs/2XMIva3q2rHDFP4toeKrLOGeS5mqhJcdd3yVsWXjHaALwCJIis2D4l5soDvz+Ka/vTqJdFWQzqsIl0BqEpr1tLLy8JFMGN7MY5nY3nr/ciSN8= url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-15T13:36:27.838Z' updated_at: '2022-09-16T10:03:25.057Z' validation_rules_assignments: object: list data_ref: data data: [] total: 0 redemption: quantity: null redeemed_quantity: 5 object: list url: >- /v1/vouchers/UnitDiscountUsingFormula/redemptions?page=1&limit=10 publish: object: list count: 0 url: >- /v1/vouchers/UnitDiscountUsingFormula/publications?page=1&limit=10 object: voucher Multiple Unit Discount: value: id: v_5Xgi5ht4sw432LQ7bwmyjKnUAYtOrJAh code: UnitDiscountUsingFormulaForMultipleProductVariants campaign: null campaign_id: null category: null category_id: null type: DISCOUNT_VOUCHER discount: type: UNIT effect: ADD_MANY_ITEMS units: - unit_off: 3 unit_off_formula: >- IF(ORDER_AMOUNT > 100;CUSTOMER_METADATA("age");CUSTOMER_METADATA("age") / 2) unit_type: sku_0b661e41fc8d35a8f7 effect: ADD_MISSING_ITEMS - unit_off: 4 unit_off_formula: >- IF(ORDER_AMOUNT > 100;CUSTOMER_METADATA("age") + 2;CUSTOMER_METADATA("age") - -2) unit_type: sku_0b661e41fc8d35a8f6 effect: ADD_NEW_ITEMS gift: null loyalty_card: null start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX1+qkwm+Yu29uhfotQxirJftPuWjA1P9WGxHqqmOHsU9esf6R5Ln7AeiqX8l9iIpy+D3yav5GmF2UrY6PD6fS9Y+yu+7yTVQu+agFZqdN1jvWw4DBOCHKPgynaMiNS29Cv4EIOFCY9Ux+4Lp8aVdalItCVCEH25DxWD+HUKq1lE31Y0DfWssg95oO2m73ZeGa8je7zd09eW7cg== url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX1+poCeZMw207p8HWtpoeokpaPfUQQoRIxpGXmqi5ic2ZPhQwKrUnujPDW4Sw1ODgHV6nLWQQQ9g7j3S4793YfzHDi1H8L3kZroH0TwWFNBgzQkV/QLqc387xUUckr0fvmhTBCarpsB+dWPOwlaNuVivTVB+Yyh/1FcbGbjvbj1Sm12wVNom2KZ3m1K/lJ6vBoGkXqq0jutytA== url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-16T05:44:50.722Z' updated_at: '2022-09-19T09:25:17.303Z' validation_rules_assignments: object: list data_ref: data data: [] total: 0 redemption: quantity: null redeemed_quantity: 3 object: list url: >- /v1/vouchers/UnitDiscountUsingFormulaForMultipleProductVariants/redemptions?page=1&limit=10 publish: object: list count: 0 url: >- /v1/vouchers/UnitDiscountUsingFormulaForMultipleProductVariants/publications?page=1&limit=10 object: voucher Free Shipping: value: id: v_gO13ON60WqVmP1DASWuJRF83Xt5KrVNL code: FreeShipping campaign: null campaign_id: null category: null category_id: null type: DISCOUNT_VOUCHER discount: type: UNIT unit_off: 1 unit_type: prod_5h1pp1ng effect: ADD_MISSING_ITEMS gift: null loyalty_card: null start_date: null expiration_date: null validity_timeframe: null validity_day_of_week: null active: true additional_info: null metadata: {} assets: qr: id: >- U2FsdGVkX19R0AaZSL8eog8GYSGvRcADkJ24Hhr52Awb2KNF11CE7oyTHVBq+S3gexrVR8PxHgEz/jR1Hh2YfM5h0k5CYPD24I/pXJYQVTa1CpXFBrrxVET9QyK48z5hxu2nsHHBsV7g0zK1nIVibsw06db8x1F1zaR7Un9oq6A= url: '{{internalVoucherifyURL}}' barcode: id: >- U2FsdGVkX19XHGrCUHCfcSz/VLWmN1UU13QmDsH9ezEYtzHAUAeaLvN12Yv5eBJ7h7R2Og2pNm7mdHxfMR8gBJWEgHuBkodwXch1llhO6hNy9KXebNU+McRx9iEB/DqSzagjaxCiUNB1xitLgXDlUH5cH9naOCOtCHGMrEQW4h0= url: '{{internalVoucherifyURL}}' is_referral_code: false created_at: '2022-09-16T07:19:53.945Z' updated_at: '2022-09-16T07:26:35.361Z' validation_rules_assignments: object: list data_ref: data data: [] total: 0 redemption: quantity: null redeemed_quantity: 2 object: list url: /v1/vouchers/FreeShipping/redemptions?page=1&limit=10 publish: object: list count: 0 url: /v1/vouchers/FreeShipping/publications?page=1&limit=10 object: voucher '404': description: >- Returns an error when requesting the code of a voucher that has been deleted or does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Not Found: value: code: 404 key: not_found message: Resource not found details: >- Cannot find voucher with id v_OBVfpTVf24DBz0HZmKVZa5UEl1DUg2b request_id: v-0bb3403b9a158c87b2 resource_id: v_OBVfpTVf24DBz0HZmKVZa5UEl1DUg2b resource_type: voucher security: - X-App-Id: [] X-App-Token: [] - X-Voucherify-OAuth: - api - vouchers components: schemas: ParameterCode: type: string example: 2CpRCE2c VouchersGetResponseBody: type: object title: Vouchers Get Response Body description: Response body schema for **GET** `v1/vouchers/{code}`. allOf: - $ref: '#/components/schemas/Voucher' Error: title: Error Object type: object description: Error details properties: code: type: integer description: Error's HTTP status code. key: type: string description: Short string describing the kind of error which occurred. message: type: string description: A human-readable message providing a short description of the error. details: type: string description: A human-readable message providing more details about the error. request_id: type: string example: v-0a885062c80375740f description: >- This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team. resource_id: type: string description: >- Unique resource ID that can be used in another endpoint to get more details. example: rf_0c5d710a87c8a31f86 resource_type: type: string description: The resource type. example: voucher error: type: object description: Includes additional information about the error. properties: message: type: string description: The message configured by the user in a validation rule. required: - code - message Voucher: title: Voucher description: >- This is an object representing a voucher with categories and validation rules assignments. allOf: - $ref: '#/components/schemas/VoucherBase' - type: object properties: categories: type: array description: Contains details about the category. items: $ref: '#/components/schemas/Category' validation_rules_assignments: $ref: '#/components/schemas/ValidationRulesAssignmentsList' VoucherBase: title: Voucher Base description: This is an object representing a voucher. type: object properties: id: type: string example: v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV description: Assigned by the Voucherify API, identifies the voucher. code: type: string example: WVPblOYX description: >- A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. campaign: type: string example: Gift Card Campaign description: A unique campaign name, identifies the voucher's parent campaign. campaign_id: type: string example: camp_FNYR4jhqZBM9xTptxDGgeNBV description: >- Assigned by the Voucherify API, identifies the voucher's parent campaign. category: type: string description: >- Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. category_id: type: string description: Unique category ID assigned by Voucherify. example: cat_0bb343dee3cdb5ec0c type: type: string enum: - GIFT_VOUCHER - DISCOUNT_VOUCHER - LOYALTY_CARD description: 'Defines the type of the voucher. ' discount: $ref: '#/components/schemas/Discount' gift: type: object description: >- Object representing gift parameters. Child attributes are present only if `type` is `GIFT_VOUCHER`. Defaults to `null`. properties: amount: type: integer example: 10000 description: >- Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. subtracted_amount: type: integer description: >- Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. balance: type: integer example: 500 description: >- Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. effect: type: string enum: - APPLY_TO_ORDER - APPLY_TO_ITEMS description: Defines how the credits are applied to the customer's order. loyalty_card: type: object description: >- Object representing loyalty card parameters. Child attributes are present only if `type` is `LOYALTY_CARD`. Defaults to `null`. properties: points: type: integer example: 7000 description: >- Total number of points added to the loyalty card over its lifespan. balance: type: integer example: 6970 description: >- Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`. next_expiration_date: type: string format: date example: '2023-05-30' description: >- The next closest date when the next set of points are due to expire. next_expiration_points: type: integer description: The amount of points that are set to expire next. pending_points: type: integer description: >- Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually. expired_points: type: integer description: >- Shows the total number of expired points over the lifetime of the loyalty card. subtracted_points: type: integer description: >- Shows the total number of subtracted points over the lifetime of the loyalty card. start_date: type: string example: '2021-12-01T00:00:00.000Z' format: date-time description: >- Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date. expiration_date: type: string example: '2021-12-31T00:00:00.000Z' format: date-time description: >- Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is *inactive after* this date. validity_timeframe: $ref: '#/components/schemas/ValidityTimeframe' validity_day_of_week: $ref: '#/components/schemas/ValidityDayOfWeek' validity_hours: $ref: '#/components/schemas/ValidityHours' active: type: boolean nullable: true description: >- A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher additional_info: type: string description: >- An optional field to keep any extra textual information about the code such as a code description and details. metadata: type: object description: >- The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. assets: $ref: '#/components/schemas/VoucherAssets' is_referral_code: type: boolean nullable: true description: >- Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. created_at: type: string example: '2021-12-22T10:13:06.487Z' description: >- Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. format: date-time updated_at: type: string example: '2021-12-22T10:14:45.316Z' format: date-time description: >- Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. holder_id: type: string example: cust_eWgXlBBiY6THFRJwX45Iakv4 description: >- Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. referrer_id: type: string description: Unique identifier of the referring person. example: cust_Vzck5i8U3OhcEUFY6MKhN9Rv object: type: string description: The type of the object represented by JSON. Default is `voucher`. default: voucher publish: type: object description: >- Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution. properties: object: type: string default: list description: >- The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. count: type: integer example: 0 description: Publication events counter. url: type: string example: /v1/vouchers/WVPblOYX/publications?page=1&limit=10 description: >- The endpoint where this list of publications can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/publications` redemption: type: object description: >- Stores a summary of redemptions that have been applied to the voucher. properties: quantity: type: integer description: >- How many times a voucher can be redeemed. A `null` value means unlimited. redeemed_quantity: type: integer example: 1 description: How many times a voucher has already been redeemed. redeemed_points: type: integer example: 100000 description: Total loyalty points redeemed. object: type: string default: list description: >- The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. url: type: string example: /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 description: >- The endpoint where this list of redemptions can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/redemptions` Category: title: Category description: This is an object representing a category. type: object properties: id: type: string description: Unique category ID assigned by Voucherify. name: type: string description: Category name. hierarchy: type: integer description: >- Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. minimum: 0 object: type: string default: category enum: - category description: >- The type of the object represented by the JSON. This object stores information about the category. created_at: type: string description: >- Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. example: '2022-07-14T10:45:13.156Z' format: date-time updated_at: type: string example: '2022-08-16T10:52:08.094Z' description: >- Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. format: date-time required: - id - name - hierarchy - created_at - object ValidationRulesAssignmentsList: title: Validation Rules Assignments List description: List of Validation Rules Assignments type: object properties: object: type: string default: list enum: - list description: >- The type of the object represented by JSON. This object stores information about validation rules assignments. data_ref: type: string default: data enum: - data description: >- Identifies the name of the attribute that contains the array of validation rules assignments. data: type: array description: Contains array of validation rules assignments. items: $ref: '#/components/schemas/BusValRuleAssignment' total: type: integer minimum: 0 description: Total number of validation rules assignments. required: - object - data_ref - data - total Discount: title: Discount type: object description: Contains information about discount. oneOf: - $ref: '#/components/schemas/DiscountAmount' - $ref: '#/components/schemas/DiscountUnit' - $ref: '#/components/schemas/DiscountUnitMultiple' - $ref: '#/components/schemas/DiscountPercent' - $ref: '#/components/schemas/DiscountFixed' ValidityTimeframe: title: Validity Timeframe type: object description: >- Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.`start_date` **required** when including the `validity_timeframe`. properties: duration: type: string description: >- Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a `duration` of `PT1H` will be valid for a duration of one hour. example: PT1H interval: type: string description: >- Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an `interval` of `P2D` will be valid every other day. example: P2D ValidityDayOfWeek: title: Validity Day Of Week type: array description: >- Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday items: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 ValidityHours: title: Validity Hours type: object description: Determines the hours of validity, e.g. to create a happy hours scenario. properties: daily: type: array description: >- Defines the recurring period(s) when the resource is active. The periods should not overlap. items: type: object description: Defines the recurring period(s) when the resource will be active. properties: start_time: type: string format: time description: >- Defines the starting hour of validity in the HH:mm format. The resource is *inactive before* this time. example: '12:00' days_of_week: type: array description: >- Integer array corresponding to the particular days of the week in which the resource is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday items: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 expiration_time: type: string format: time description: >- Defines the ending hour of validity in the HH:mm format. The resource is *inactive after* this time. example: '14:00' VoucherAssets: title: Voucher Assets type: object description: >- Stores links to images of QR and barcode that correspond to an encrypted voucher code. properties: qr: type: object description: Stores Quick Response (QR) representation of encrypted code. properties: id: type: string example: >- U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q== description: Encrypted voucher code ID. url: type: string example: >- https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D description: >- URL to QR code *Optional:* Attach query parameters to base URL to customize the image of the encrypted voucher code. - `size`: integer value from `1` to `100` - `format`: string, either `png` (default) or `svg` barcode: type: object description: Stores barcode representation of encrypted code. properties: id: type: string example: >- U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ== description: Encrypted voucher code ID. url: type: string example: >- https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D description: >- URL to barcode *Optional:* Attach query parameters to base URL to customize the image of the encrypted voucher code. - `size`: integer value from `1` to `100` - `format`: string, either `png` (default) or `svg` BusValRuleAssignment: title: Business Validation Rule Assignment description: Assignments of business validation rule example: id: asgm_LnY1g7UNFA9KyDrD rule_id: val_3gPNA6SnH4ae related_object_id: camp_CZOnEGiZfwIKWmSjhIoIT7Ol related_object_type: campaign object: validation_rules_assignment validation_status: PARTIALLY_VALID validation_omitted_rules: - '1' properties: id: type: string description: The unique identifier for a assignment rule_id: type: string description: The unique identifier for a rule related_object_id: type: string description: The unique identifier for a related object related_object_type: type: string description: The type of related object created_at: type: string description: >- Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. example: '2022-03-09T11:19:04.819Z' format: date-time updated_at: type: string description: >- Timestamp representing the date and time when the object was last updated in ISO 8601 format. example: '2022-03-09T11:19:04.819Z' format: date-time object: type: string description: The type of the object represented by JSON. default: validation_rules_assignment enum: - validation_rules_assignment validation_status: type: string description: The validation status of the assignment enum: - VALID - PARTIALLY_VALID - INVALID validation_omitted_rules: type: array description: The list of omitted rules items: type: string required: - id - rule_id - related_object_id - related_object_type - object DiscountAmount: type: object title: Amount properties: type: type: string default: AMOUNT enum: - AMOUNT description: Defines the type of the voucher. amount_off: type: number description: >- Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. amount_off_formula: type: string description: Formula used to dynamically calculate the discount. aggregated_amount_limit: type: integer description: Maximum discount amount per order. effect: description: Defines how the discount is applied to the customer's order. allOf: - $ref: '#/components/schemas/DiscountAmountVouchersEffectTypes' is_dynamic: type: boolean description: Flag indicating whether the discount was calculated using a formula. required: - type - amount_off DiscountUnit: type: object title: Unit properties: type: type: string default: UNIT enum: - UNIT description: Discount type. unit_off: type: integer description: Number of units to be granted a full value discount. unit_off_formula: type: string description: Formula used to dynamically calculate the number of units. effect: description: Defines how the unit is added to the customer's order. allOf: - $ref: '#/components/schemas/DiscountUnitVouchersEffectTypes' unit_type: type: string description: >- The product deemed as free, chosen from product inventory (e.g. time, items). product: description: Contains information about the product. allOf: - $ref: '#/components/schemas/SimpleProductDiscountUnit' sku: $ref: '#/components/schemas/SimpleSkuDiscountUnit' is_dynamic: type: boolean description: Flag indicating whether the discount was calculated using a formula. required: - type - unit_type DiscountUnitMultiple: type: object title: Unit Multiple properties: type: type: string default: UNIT enum: - UNIT description: Discount type. effect: type: string default: ADD_MANY_ITEMS enum: - ADD_MANY_ITEMS description: Defines how the discount is applied to the customer's order. units: type: array items: $ref: '#/components/schemas/DiscountUnitMultipleOneUnit' required: - type - units DiscountPercent: type: object title: Percent properties: type: type: string default: PERCENT enum: - PERCENT description: Defines the type of the voucher. percent_off: type: number description: The percent discount that the customer will receive. percent_off_formula: type: string description: Formula used to dynamically calculate the discount. amount_limit: type: number description: >- Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. aggregated_amount_limit: type: integer description: Maximum discount amount per order. effect: description: Defines how the discount is applied to the customer's order. allOf: - $ref: '#/components/schemas/DiscountPercentVouchersEffectTypes' is_dynamic: type: boolean description: Flag indicating whether the discount was calculated using a formula. required: - type - percent_off DiscountFixed: title: Fixed type: object properties: type: type: string default: FIXED enum: - FIXED description: Defines the type of the voucher. fixed_amount: type: number description: >- Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the `fixed_amount_formula` parameter is present in the fixed amount definition, this value becomes the **fallback value**. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value. fixed_amount_formula: type: string description: Formula used to dynamically calculate the discount. effect: description: Defines how the discount is applied to the customer's order. allOf: - $ref: '#/components/schemas/DiscountFixedVouchersEffectTypes' is_dynamic: type: boolean description: Flag indicating whether the discount was calculated using a formula. required: - type - fixed_amount DiscountAmountVouchersEffectTypes: title: Discount Amount Vouchers Effect Types enum: - APPLY_TO_ORDER - APPLY_TO_ITEMS - APPLY_TO_ITEMS_PROPORTIONALLY - APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY - APPLY_TO_ITEMS_BY_QUANTITY type: string DiscountUnitVouchersEffectTypes: title: Discount Unit Vouchers Effect Types enum: - ADD_MISSING_ITEMS - ADD_NEW_ITEMS - ADD_MANY_ITEMS - ADD_SAME_ITEMS type: string SimpleProductDiscountUnit: type: object title: Simple Product Discount Unit properties: id: type: string description: Unique product ID, assigned by Voucherify. source_id: type: string description: Product's source ID. name: type: string description: Product name. required: - id - name SimpleSkuDiscountUnit: type: object title: Simple Sku Discount Unit properties: id: type: string description: Unique SKU ID, assigned by Voucherify. source_id: type: string description: Product variant's source ID. name: type: string description: Sku name required: - id - name DiscountUnitMultipleOneUnit: type: object title: One Unit properties: unit_off: type: number description: Number of units to be granted a full value discount. unit_off_formula: type: string description: Formula used to dynamically calculate the number of units. effect: type: string enum: - ADD_NEW_ITEMS - ADD_MISSING_ITEMS description: |+ Defines how the unit is added to the customer's order. unit_type: type: string description: >- The product deemed as free, chosen from product inventory (e.g. time, items). product: description: Contains information about the product. allOf: - $ref: '#/components/schemas/SimpleProductDiscountUnit' sku: description: Contains information about the sku. allOf: - $ref: '#/components/schemas/SimpleSkuDiscountUnit' required: - effect - unit_type DiscountPercentVouchersEffectTypes: title: Discount Percent Vouchers Effect Types enum: - APPLY_TO_ORDER - APPLY_TO_ITEMS type: string DiscountFixedVouchersEffectTypes: title: Discount Fixed Vouchers Effect Types enum: - APPLY_TO_ORDER - APPLY_TO_ITEMS type: string securitySchemes: X-App-Id: type: apiKey name: X-App-Id in: header X-App-Token: type: apiKey name: X-App-Token in: header X-Voucherify-OAuth: type: oauth2 flows: implicit: authorizationUrl: https://api.voucherify.io/v1/oauth/token scopes: api: Gives access to whole server-side API. vouchers: >- Gives access to all endpoints and methods starting with `v1/vouchers`. client_api: Gives access to whole client-side API. client_vouchers: >- Gives access to all endpoints and methods starting with `/client/v1/vouchers`. promotions: >- Gives access to all endpoints and methods starting with `/v1/promotions`. client_promotions: >- Gives access to all endpoints and methods starting with `/client/v1/promotions` campaigns: >- Gives access to all endpoints and methods starting with `v1/campaigns`. client_publish: >- Gives access to all endpoints and methods starting with `/client/v1/publish`. exports: >- Gives access to all endpoints and methods starting with `/v1/exports`. publications: >- Gives access to all endpoints and methods starting with `/v1/publications`. client_validate: >- Gives access to all endpoints and methods starting with `/client/v1/validate`. validations: >- Gives access to all endpoints and methods starting with `/v1/validations`. client_validations: >- Gives access to all endpoints and methods starting with `/client/v1/validations`. qualifications: >- Gives access to all endpoints and methods starting with `/v1/qualifications`. client_qualifications: >- Gives access to all endpoints and methods starting with `/client/v1/qualifications`. client_redeem: >- Gives access to all endpoints and methods starting with `/client/v1/redeem redemptions: >- Gives access to all endpoints and methods starting with `/v1/redemptions`. client_redemptions: >- Gives access to all endpoints and methods starting with `/client/v1/redemptions` customers: >- Gives access to all endpoints and methods starting with `/v1/customers`. client_customers: >- Gives access to all endpoints and methods starting with `/client/v1/customers`. orders: >- Gives access to all endpoints and methods starting with `/v1/orders`. products: >- Gives access to all endpoints and methods starting with `/v1/products`. skus: >- Gives access to all endpoints and methods starting with `/v1/SKUs`. validation-rules: >- Gives access to all endpoints and methods starting with `/v1/validation-rules`. validation-rules-assignments: >- Gives access to all endpoints and methods starting with `/v1/validation-rules-assignments segments: >- Gives access to all endpoints and methods starting with `/v1/segments`. events: >- Gives access to all endpoints and methods starting with `/v1/events`. client_events: >- Gives access to all endpoints and methods starting with `client/v1/events`. rewards: >- Gives access to all endpoints and methods starting with `/v1/rewards`. assets: >- Gives access to all endpoints and methods starting with `/v1/assets`. task-results: >- Gives access to all endpoints and methods starting with `/v1/task-results`. loyalties: >- Gives access to all endpoints and methods starting with `/v1/loyalties`. client_consents: >- Gives access to all endpoints and methods starting with `client/v1/consents`. consents: >- Gives access to all endpoints and methods starting with `/v1/consents`. async-actions: >- Gives access to all endpoints and methods starting with `/v1/async-actions`. product-collections: >- Gives access to all endpoints and methods starting with `/v1/product-collections`. categories: >- Gives access to all endpoints and methods starting with `/v1/categories`. metadata-schemas: >- Gives access to all endpoints and methods starting with `/v1/metadata-schemas`. locations: >- Gives access to all endpoints and methods starting with `/v1/locations`. referrals: >- Gives access to all endpoints and methods starting with `/v1/referrals`. trash-bin: >- Gives access to all endpoints and methods starting with `/v1/trash-bin`. templates: >- Gives access to all endpoints and methods starting with `/v1/templates`. ````