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

Added CRUD POST/PUT examples with layerInfo

Browse Source
This commit is contained in:
Max Martens 2025-08-28 10:36:22 +02:00
parent 3ecf55b6ec
commit 227fa07da0
1 changed files with 178 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

178
src/openapi/products/products-crud.yaml
View File

@ -457,6 +457,93 @@ paths:
}
]
}
postGboProductWithParent:
summary: Add new GBO product with parent and layerInfo (non-renewable)
value:
{
"parentProductId": 1,
"layerInfoId": 1,
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
"validityPeriod": {
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999"
},
"productTranslations": [
{
"language": "en",
"name": "HTM pilot 90% discount",
"description": "Travel with 90% discount during the first F&F pilot!"
}
],
"productOwnerId": 1,
"marketSegmentIds": [
1
],
"customerSegmentIds": [
5,
6
],
"allowedGboAgeProfileIds": [],
"productCategoryId": 1,
"requiredCustomerLevelId": 1,
"incompatibleProducts": [
{
"incompatibleProductId": 2,
"description": "Kan niet combineren met zichzelf"
}
],
"mandatoryCustomerDataItemIds": [
4,
7
],
"tokenTypeIds": [
1
],
"paymentMomentId": 1,
"validityDuration": "P7D",
"maxStartInFutureDuration": "P6W",
"isRenewable": false,
"sendInvoice": false,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
"productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina",
"termsUrl": "https://www.htm.nl/nog-onbekende-productvoorwaarden-pagina",
"isSellableAtHtm": true,
"needsSolvencyCheckConsumer": false,
"needsSolvencyCheckBusiness": false,
"sellingPeriods": [
{
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999",
"salesTouchpointId": 3,
"sellingPrices": [
{
"amountExclTax": 92,
"amountInclTax": 100,
"taxCode": "V09",
"taxPercentage": 9.0000,
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999",
"internalPrice": 92.0000
}
]
}
],
"purchasePrices": [
{
"amountExclTax": 0,
"amountInclTax": 0,
"taxCode": "V09",
"taxPercentage": 9.0000,
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999"
}
]
}
postGboProductMultiplePeriods:
summary: >-
Add new GBO product (non-renewable, multiple sellingPeriods/prices per period)
@ -1748,6 +1835,97 @@ paths:
}
]
}
updateGboProductWithParent:
summary: Update existing GBO product with parent and layerInfo (non-renewable)
value:
{
"parentProductId": 1,
"layerInfoId": 1,
"fikoArticleNumber": "1234",
"isValid": true,
"isArchived": false,
"gboPackageTemplateId": "30901",
"productName": "HTM pilot 90% korting",
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
"validityPeriod": {
"validityPeriodId": 1,
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999"
},
"productTranslations": [
{
"language": "en",
"name": "HTM pilot 90% discount",
"description": "Travel with 90% discount during the first F&F pilot!"
}
],
"productOwnerId": 1,
"marketSegmentIds": [
1
],
"customerSegmentIds": [
5,
6
],
"allowedGboAgeProfileIds": [],
"productCategoryId": 1,
"requiredCustomerLevelId": 1,
"incompatibleProducts": [
{
"incompatibleProductId": 2,
"description": "Kan niet combineren met zichzelf"
}
],
"mandatoryCustomerDataItemIds": [
4,
7
],
"tokenTypeIds": [
1
],
"paymentMomentId": 1,
"validityDuration": "P7D",
"maxStartInFutureDuration": "P6W",
"isRenewable": false,
"sendInvoice": false,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
"productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina",
"termsUrl": "https://www.htm.nl/nog-onbekende-productvoorwaarden-pagina",
"isSellableAtHtm": true,
"needsSolvencyCheckConsumer": false,
"needsSolvencyCheckBusiness": false,
"sellingPeriods": [
{
"sellingPeriodId": 1,
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999",
"salesTouchpointId": 3,
"sellingPrices": [
{
"sellingPriceId": 1,
"amountExclTax": 92,
"amountInclTax": 100,
"taxCode": "V09",
"taxPercentage": 9.0000,
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999",
"internalPrice": 92.0000
}
]
}
],
"purchasePrices": [
{
"purchasePriceId": 1,
"amountExclTax": 0,
"amountInclTax": 0,
"taxCode": "V09",
"taxPercentage": 9.0000,
"fromInclusive": "2024-09-01T00:00:00.000",
"toInclusive": "2024-12-31T23:59:59.999"
}
]
}
advancedUpdateGboProduct:
summary: >-
Advanced update (remove mandatoryCustomerDataItem references, add new second sellingPeriod)