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

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

@ -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:
@ -49,16 +33,12 @@ paths:
Voucher for a product with required attributes:
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" },
"voucherStatus": { "voucherStatusId": 1, "name": "New" },
"product":
{
"productId": 263,
@ -100,29 +80,23 @@ paths:
[
{
"mandatoryCustomerDataItemId": 8,
"customerDataItem": "padBirthDate"
"customerDataItem": "padBirthDate",
},
{
"mandatoryCustomerDataItemId": 4,
"customerDataItem": "emailAddress"
},
],
"customerDataItem": "emailAddress",
},
],
}
Voucher for a whole order:
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" },
"voucherStatus": { "voucherStatusId": 1, "name": "New" },
"product":
{
"productId": 263,
@ -145,9 +119,7 @@ paths:
},
},
},
},
"mandatoryCustomerDataItems": [],
],
}
"403":
description: Forbidden