From db5d2ac324ffbb4cdda55f4709e91b1188b41b2c Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Wed, 1 Apr 2026 14:14:15 +0200 Subject: [PATCH] OVPAY-2346 - Changed query param to path param. --- src/openapi/products/SE-vouchers-TP.yaml | 174 ++++++++++------------- 1 file changed, 73 insertions(+), 101 deletions(-) diff --git a/src/openapi/products/SE-vouchers-TP.yaml b/src/openapi/products/SE-vouchers-TP.yaml index b176784..8b8c724 100644 --- a/src/openapi/products/SE-vouchers-TP.yaml +++ b/src/openapi/products/SE-vouchers-TP.yaml @@ -6,36 +6,20 @@ info: servers: - url: https://services.acc.api.htm.nl/abt/abtvouchersTouchpoint/1.0 paths: - /issuedvouchers: + /issuedvouchers/{voucherCode}: get: - summary: Get a list of issued vouchers that were issued for a specific touch point + summary: Get details of a voucher, that was issued for a specific touch point description: - Retrieve all issued vouchers for a specific touch point. This means that only products that the calling touch point is allowed to see or sell + Get details of an issued voucher for a specific touch point. This means that only products that the calling touch point is allowed to see or sell (i.e. has active sellingPeriods for touchPointId of the calling touch point) are returned. parameters: - name: voucherCode - in: query - required: false + in: path + required: true description: The unique code of the issued voucher to retrieve. schema: type: string example: VOUCHER123 - - name: highestVoucherStatusId - in: query - required: false - explode: false - description: |- - The highest voucher status id to filter the issued vouchers on. - - 1 = new - - 2 = issued - - 3 = redeemed - - 4 = revoked - - 5 = expired - schema: - type: array - items: - type: integer - example: [1, 2] tags: - Vouchers responses: @@ -50,63 +34,57 @@ paths: summary: Voucher for a single product with required attributes value: { - "issuedVouchers": - [ - { - "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", - "voucherCode": "VOUCHER123", - "fromInclusive": "2024-10-04T00:00:00.000", - "untilInclusive": "2024-11-04T00:00:00.000", - "voucherStatus": - { "voucherStatusId": 1, "name": "New" }, - "product": + "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", + "voucherCode": "VOUCHER123", + "fromInclusive": "2024-10-04T00:00:00.000", + "untilInclusive": "2024-11-04T00:00:00.000", + "voucherStatus": { "voucherStatusId": 1, "name": "New" }, + "product": + { + "productId": 263, + "productName": "HTM-80001", + "productDescription": "10 euro korting op Regiovrij maand.", + "productCategory": + { + "productCategoryId": 9, + "isTravelProduct": false, + "name": "Voucher", + }, + "amountInclTax": -1000, + "requiredProducts": + [ { - "productId": 263, - "productName": "HTM-80001", - "productDescription": "10 euro korting op Regiovrij maand.", - "productCategory": - { - "productCategoryId": 9, - "isTravelProduct": false, - "name": "Voucher", - }, - "amountInclTax": -1000, - "requiredProducts": - [ - { - "productId": 126, - "productName": "HTM-30001", - "productDescription": "Regiovrij maand.", - "_links": - { - "get_details": - { - "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/126", - "method": "GET", - }, - }, - }, - ], + "productId": 126, + "productName": "HTM-30001", + "productDescription": "Regiovrij maand.", "_links": { "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/126", "method": "GET", }, }, }, - "mandatoryCustomerDataItems": - [ + ], + "_links": + { + "get_details": { - "mandatoryCustomerDataItemId": 8, - "customerDataItem": "padBirthDate" + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", + "method": "GET", }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - ], + }, + }, + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", }, ], } @@ -114,40 +92,34 @@ paths: summary: Voucher for a whole order value: { - "issuedVouchers": - [ - { - "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", - "voucherCode": "VOUCHER123", - "fromInclusive": "2024-10-04T00:00:00.000", - "untilInclusive": "2024-11-04T00:00:00.000", - "voucherStatus": - { "voucherStatusId": 1, "name": "New" }, - "product": - { - "productId": 263, - "productName": "HTM-80002", - "productDescription": "10 euro korting op je gehele winkelmand.", - "productCategory": - { - "productCategoryId": 9, - "isTravelProduct": false, - "name": "Voucher", - }, - "amountInclTax": -1000, - "requiredProducts": [], - "_links": - { - "get_details": - { - "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", - "method": "GET", - }, - }, - }, - }, - "mandatoryCustomerDataItems": [], - ], + "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", + "voucherCode": "VOUCHER123", + "fromInclusive": "2024-10-04T00:00:00.000", + "untilInclusive": "2024-11-04T00:00:00.000", + "voucherStatus": { "voucherStatusId": 1, "name": "New" }, + "product": + { + "productId": 263, + "productName": "HTM-80002", + "productDescription": "10 euro korting op je gehele winkelmand.", + "productCategory": + { + "productCategoryId": 9, + "isTravelProduct": false, + "name": "Voucher", + }, + "amountInclTax": -1000, + "requiredProducts": [], + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", + "method": "GET", + }, + }, + }, + "mandatoryCustomerDataItems": [], } "403": description: Forbidden