HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

OVPAY-2346 - Changed query param to path param.

Browse Source
This commit is contained in:
Bas Boterman 2026-04-01 14:14:15 +02:00
parent 175c81f5cd
commit db5d2ac324
1 changed files with 73 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
src/openapi/products/SE-vouchers-TP.yaml
View File

@ -6,36 +6,20 @@ info:
servers: servers:
- url: https://services.acc.api.htm.nl/abt/abtvouchersTouchpoint/1.0 - url: https://services.acc.api.htm.nl/abt/abtvouchersTouchpoint/1.0
paths: paths:
/issuedvouchers: /issuedvouchers/{voucherCode}:
get: 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: 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. (i.e. has active sellingPeriods for touchPointId of the calling touch point) are returned.
parameters: parameters:
- name: voucherCode - name: voucherCode
in: query in: path
required: false required: true
description: The unique code of the issued voucher to retrieve. description: The unique code of the issued voucher to retrieve.
schema: schema:
type: string type: string
example: VOUCHER123 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: tags:
- Vouchers - Vouchers
responses: responses:
@ -50,63 +34,57 @@ paths:
summary: Voucher for a single product with required attributes summary: Voucher for a single product with required attributes
value: value:
{ {
"issuedVouchers": "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
[ "voucherCode": "VOUCHER123",
{ "fromInclusive": "2024-10-04T00:00:00.000",
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", "untilInclusive": "2024-11-04T00:00:00.000",
"voucherCode": "VOUCHER123", "voucherStatus": { "voucherStatusId": 1, "name": "New" },
"fromInclusive": "2024-10-04T00:00:00.000", "product":
"untilInclusive": "2024-11-04T00:00:00.000", {
"voucherStatus": "productId": 263,
{ "voucherStatusId": 1, "name": "New" }, "productName": "HTM-80001",
"product": "productDescription": "10 euro korting op Regiovrij maand.",
"productCategory":
{
"productCategoryId": 9,
"isTravelProduct": false,
"name": "Voucher",
},
"amountInclTax": -1000,
"requiredProducts":
[
{ {
"productId": 263, "productId": 126,
"productName": "HTM-80001", "productName": "HTM-30001",
"productDescription": "10 euro korting op Regiovrij maand.", "productDescription": "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",
},
},
},
],
"_links": "_links":
{ {
"get_details": "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", "method": "GET",
}, },
}, },
}, },
"mandatoryCustomerDataItems": ],
[ "_links":
{
"get_details":
{ {
"mandatoryCustomerDataItemId": 8, "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
"customerDataItem": "padBirthDate" "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 summary: Voucher for a whole order
value: value:
{ {
"issuedVouchers": "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
[ "voucherCode": "VOUCHER123",
{ "fromInclusive": "2024-10-04T00:00:00.000",
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", "untilInclusive": "2024-11-04T00:00:00.000",
"voucherCode": "VOUCHER123", "voucherStatus": { "voucherStatusId": 1, "name": "New" },
"fromInclusive": "2024-10-04T00:00:00.000", "product":
"untilInclusive": "2024-11-04T00:00:00.000", {
"voucherStatus": "productId": 263,
{ "voucherStatusId": 1, "name": "New" }, "productName": "HTM-80002",
"product": "productDescription": "10 euro korting op je gehele winkelmand.",
{ "productCategory":
"productId": 263, {
"productName": "HTM-80002", "productCategoryId": 9,
"productDescription": "10 euro korting op je gehele winkelmand.", "isTravelProduct": false,
"productCategory": "name": "Voucher",
{ },
"productCategoryId": 9, "amountInclTax": -1000,
"isTravelProduct": false, "requiredProducts": [],
"name": "Voucher", "_links":
}, {
"amountInclTax": -1000, "get_details":
"requiredProducts": [], {
"_links": "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
{ "method": "GET",
"get_details": },
{ },
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", },
"method": "GET", "mandatoryCustomerDataItems": [],
},
},
},
},
"mandatoryCustomerDataItems": [],
],
} }
"403": "403":
description: Forbidden description: Forbidden