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

Compare commits

base: HTM:db5d2ac324ffbb4cdda55f4709e91b1188b41b2c
Branches Tags
HTM:develop
HTM:features/OVPAY2475-Token-API
HTM:feature/OVPAY-2547
HTM:trial-implementation-Not-beheren
HTM:features/FIKO-voor-kassa
HTM:features/OVPAY1312-TP-orders-incl-vouchers
HTM:features/Edit-TP-notification
HTM:feature/OVPAY-1499
HTM:main
HTM:version/3
HTM:version/2
HTM:version/1
HTM:V1
..
compare: HTM:2094ef46e4b44b74ef7f9c1b0c47164110bad5ba
Branches Tags
HTM:develop
HTM:features/OVPAY2475-Token-API
HTM:feature/OVPAY-2547
HTM:trial-implementation-Not-beheren
HTM:features/FIKO-voor-kassa
HTM:features/OVPAY1312-TP-orders-incl-vouchers
HTM:features/Edit-TP-notification
HTM:feature/OVPAY-1499
HTM:main
HTM:version/3
HTM:version/2
HTM:version/1
HTM:V1

No commits in common. "db5d2ac324ffbb4cdda55f4709e91b1188b41b2c" and "2094ef46e4b44b74ef7f9c1b0c47164110bad5ba" have entirely different histories.
db5d2ac324 ... 2094ef46e4

1 changed files with 85 additions and 73 deletions
Show Stats Expand all files Collapse all files

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

@ -6,16 +6,16 @@ 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/{voucherCode}: /issuedvouchers:
get: get:
summary: Get details of a voucher, that was issued for a specific touch point summary: Get a list of issued vouchers that were issued for a specific touch point
description: description:
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 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
(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: path in: query
required: true required: false
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
@ -34,57 +34,63 @@ paths:
summary: Voucher for a single product with required attributes summary: Voucher for a single product with required attributes
value: value:
{ {
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", "issuedVouchers":
"voucherCode": "VOUCHER123", [
"fromInclusive": "2024-10-04T00:00:00.000", {
"untilInclusive": "2024-11-04T00:00:00.000", "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
"voucherStatus": { "voucherStatusId": 1, "name": "New" }, "voucherCode": "VOUCHER123",
"product": "fromInclusive": "2024-10-04T00:00:00.000",
{ "untilInclusive": "2024-11-04T00:00:00.000",
"productId": 263, "voucherStatus":
"productName": "HTM-80001", { "voucherStatusId": 1, "name": "New" },
"productDescription": "10 euro korting op Regiovrij maand.", "product":
"productCategory":
{
"productCategoryId": 9,
"isTravelProduct": false,
"name": "Voucher",
},
"amountInclTax": -1000,
"requiredProducts":
[
{ {
"productId": 126, "productId": 263,
"productName": "HTM-30001", "productName": "HTM-80001",
"productDescription": "Regiovrij maand.", "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",
},
},
},
],
"_links": "_links":
{ {
"get_details": "get_details":
{ {
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/126", "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
"method": "GET", "method": "GET",
}, },
}, },
}, },
], "mandatoryCustomerDataItems":
"_links": [
{
"get_details":
{ {
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", "mandatoryCustomerDataItemId": 8,
"method": "GET", "customerDataItem": "padBirthDate"
}, },
}, {
}, "mandatoryCustomerDataItemId": 4,
"mandatoryCustomerDataItems": "customerDataItem": "emailAddress"
[ },
{ ],
"mandatoryCustomerDataItemId": 8,
"customerDataItem": "padBirthDate",
},
{
"mandatoryCustomerDataItemId": 4,
"customerDataItem": "emailAddress",
}, },
], ],
} }
@ -92,34 +98,40 @@ paths:
summary: Voucher for a whole order summary: Voucher for a whole order
value: value:
{ {
"issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", "issuedVouchers":
"voucherCode": "VOUCHER123", [
"fromInclusive": "2024-10-04T00:00:00.000", {
"untilInclusive": "2024-11-04T00:00:00.000", "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
"voucherStatus": { "voucherStatusId": 1, "name": "New" }, "voucherCode": "VOUCHER123",
"product": "fromInclusive": "2024-10-04T00:00:00.000",
{ "untilInclusive": "2024-11-04T00:00:00.000",
"productId": 263, "voucherStatus":
"productName": "HTM-80002", { "voucherStatusId": 1, "name": "New" },
"productDescription": "10 euro korting op je gehele winkelmand.", "product":
"productCategory": {
{ "productId": 263,
"productCategoryId": 9, "productName": "HTM-80002",
"isTravelProduct": false, "productDescription": "10 euro korting op je gehele winkelmand.",
"name": "Voucher", "productCategory":
}, {
"amountInclTax": -1000, "productCategoryId": 9,
"requiredProducts": [], "isTravelProduct": false,
"_links": "name": "Voucher",
{ },
"get_details": "amountInclTax": -1000,
{ "requiredProducts": [],
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", "_links":
"method": "GET", {
}, "get_details":
}, {
}, "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263",
"mandatoryCustomerDataItems": [], "method": "GET",
},
},
},
},
"mandatoryCustomerDataItems": [],
],
} }
"403": "403":
description: Forbidden description: Forbidden