---
title: "Adds a voucher to an in progress order base"
method: POST
path: "/ocapi/v1/orders/{orderId}/vouchers"
tags: ["Orders", "Vouchers"]
---

# Adds a voucher to an in progress order base

`POST /ocapi/v1/orders/{orderId}/vouchers`

## Request

- Base URL: `https://developer.vista.co` (the document declares no server; this is the origin it was published from)
- URL: `https://developer.vista.co/ocapi/v1/orders/{orderId}/vouchers`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/vouchers/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint is not available for in progress tab order entities.


This endpoint validates the provided voucher credentials and stores a successfully validated voucher against the order for later use.
#### Licenses Required


- Vista.Ocapi

## Path parameters

- `orderId` string, required

## Headers

- `Connect-Region-Code` string

## Request body

- union: Represents the information required to add an order voucher to an in progress order base
  - OcapiV1OrdersVouchersRequestsOrderDealVoucherRequest: Represents the information required to add an order voucher to an in progress order base
    - `type` 'Ticket' | 'Subscription' | 'Deal', required: Represents the type of a voucher
    - `credentials` OcapiV1VouchersVoucherCredentials, required: Represents the details required to validate a voucher
      - `barcode` string, required: Gets the barcode
      - `pin` string, nullable: Gets the PIN
  - OcapiV1OrdersVouchersRequestsOrderSubscriptionVoucherRequest: Represents the information required to add an order voucher to an in progress order base
    - `type` 'Ticket' | 'Subscription' | 'Deal', required: Represents the type of a voucher
    - `credentials` OcapiV1VouchersVoucherCredentials, required: Represents the details required to validate a voucher
      - `barcode` string, required: Gets the barcode
      - `pin` string, nullable: Gets the PIN
  - OcapiV1OrdersVouchersRequestsOrderTicketVoucherRequest: Represents the information required to add an order voucher to an in progress order base
    - `type` 'Ticket' | 'Subscription' | 'Deal', required: Represents the type of a voucher
    - `credentials` OcapiV1VouchersVoucherCredentials, required: Represents the details required to validate a voucher
      - `barcode` string, required: Gets the barcode
      - `pin` string, nullable: Gets the PIN

## Response `200`

Success

- OcapiV1OrdersVouchersOrderVoucherDetails: Represents a voucher that has been added to the order
  - `voucher` OcapiV1OrdersVouchersOrderVoucher, required: Represents a voucher that has been added to an order base
    - `id` string, required: Gets the identifier that can be used to uniquely identify the voucher within the order base
    - `type` 'Ticket' | 'Subscription' | 'Deal', required: Represents the type of a voucher
    - `maskedBarcode` string, required: Gets a masked representation of the barcode
    - `voucherTypeCode` string, required: Gets the unique identifier of the voucher type
    - `voucherTypeDescription` OcapiV1Translatable: Represents some customer-visible translatable Text in the default language, and a list of translation entities
      - `text` string, required: Gets the text in the default language
      - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages
        - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
        - `text` string, required: Gets the translated text
  - `availableRedemptions` integer, required: Gets the maximum number of times that the order voucher details Voucher can be redeemed

## Other responses

- `400`: Request property is invalid or missing, or invalid order type/voucher.
- `404`: Order does not exist.
- `429`: Too many requests. Try again later.

## Changes

- **2026-10-09** `41415d239083`: 1 info
  - api tag `Orders` added

[Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/:orderId/vouchers/post.md)

---

[API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)