Gets the list of completed order redeemable item base entities for a completed gift shop order

This endpoint will only return redeemable items for completed gift shop order entities. For other types of completed orders, such as completed standard order, this endpoint will return an empty array.

Redeemable item details are intentionally separated from completed gift shop order to avoid exposing sensitive voucher and gift card information.

Returning these details via a dedicated endpoint reduces the attack surface and helps prevent unauthorized access to redeemable items that could have direct financial value.

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the completed gift shop order

header Parameters
Connect-Region-Code
string

Region Code

Responses
200

Success

404

Order does not exist.

get/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items
Request samples
Response samples
application/json
{
  • "redeemableItems": [
    ]
}