Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Vouchers

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
post/ocapi/v1/orders/{orderId}/vouchers

Path parameters

orderIdstring required

The unique identifier of the in progress order base being modified

Headers

Connect-Region-Codestring

Region Code

Request body

OR
OR

Response

Success

availableRedemptionsinteger required

Gets the maximum number of times that the order voucher details Voucher can be redeemed

Example response

{
  "voucher": {
    "maskedBarcode": "12.......6789",
    "voucherTypeDescription": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    }
  }
}