Adds a voucher to an in progress order base

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

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the in progress order base being modified

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

The details of the voucher to be added to the in progress order base

One of:

Represents the information required to add an order voucher of type voucher type Deal to an in progress standard order

type
required
string (VoucherType)

Gets the type

Enum: "Ticket" "Subscription" "Deal"
required
object (VoucherCredentials)

Gets the credentials

Responses
200

Success

400

Request property is invalid or missing, or invalid order type/voucher.

404

Order does not exist.

429

Too many requests. Try again later.

post/ocapi/v1/orders/{orderId}/vouchers
Request samples
{
  • "type": "Ticket",
  • "credentials": {
    }
}
Response samples
application/json
{
  • "voucher": {
    },
  • "availableRedemptions": 0
}