diff --git a/src/openapi/products/SE-products-SE.yaml b/src/openapi/products/SE-products-SE.yaml index 55f1f3f..759014d 100644 --- a/src/openapi/products/SE-products-SE.yaml +++ b/src/openapi/products/SE-products-SE.yaml @@ -4,7 +4,7 @@ info: description: |- Service Engine APIs for HTM products. These are NOT the CRUD APIs to access raw data in the database. To be used by touchpoints to get information about HTM products they are allowed to see and/or sell. - version: '1.0' + version: "1.0" servers: - url: https://api.integratielaag.nl/abt/abtserviceengine/2.0 tags: @@ -30,252 +30,241 @@ paths: in: query required: false description: |- - Only return products that refer to the given parentProductId. \ - Returns parent-products (i.e. products with parentProductId = null) if left empty. + Only return products that refer to the given parentProductId. \ + Returns parent-products (i.e. products with parentProductId = null) if left empty. schema: type: integer example: 1 responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/ProductPayloadListResponse' + $ref: "#/components/schemas/ProductPayloadListResponse" examples: No products / Empty list: summary: No products / Empty list description: No products - value: - { - "Entries": [] - } + value: { "Entries": [] } List containing one product with many null attributes: summary: List containing one product with many null attributes description: |- - Most product attributes are optional on a database level and can thus be null; this example shows that all attributes as defined in the schema are always represented in the response, even if null. \ - **Empty lists/arrays show up as "[]", not as null!** + Most product attributes are optional on a database level and can thus be null; this example shows that all attributes as defined in the schema are always represented in the response, even if null. \ + **Empty lists/arrays show up as "[]", not as null!** value: { - "Entries": [ - { - "productId": 99, - "productCode": null, - "productName": null, - "productDescription": null, - "productCategory": null, - "tokenTypes": [], - "sellableTouchpointIds": [], - "amountInclTax": null, - "imageReference": null, - "productPageUrl": null, - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/99", - "method": "GET" - } - } - } - ] + "Entries": + [ + { + "productId": 99, + "productName": null, + "productDescription": null, + "productCategory": null, + "tokenTypes": [], + "sellableTouchpointIds": [], + "amountInclTax": null, + "imageReference": null, + "productPageUrl": null, + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/99", + "method": "GET", + }, + }, + }, + ], } List containing one product with 4 currently active SellingPeriods (called by touchpointId 1): summary: List containing one product with 4 currently active SellingPeriods (called by touchpointId 1) description: Only two sellingPeriods for touchpoint 1 and/or 2 (part of same retailer) are returned - the price for touchpointId 1 is returned value: { - "Entries": [ - { - "productId": 2, - "productCode": "312AB-WL", - "productName": "HTM dagkaart", - "productDescription": "Reis een dag met het openbaar vervoer bij HTM", - "productCategory": { - "productCategoryId": 6, - "isTravelProduct": false, - "name": "Barcode" + "Entries": + [ + { + "productId": 2, + "productName": "HTM dagkaart", + "productDescription": "Reis een dag met het openbaar vervoer bij HTM", + "productCategory": + { + "productCategoryId": 6, + "isTravelProduct": false, + "name": "Barcode", + }, + "tokenTypes": [], + "sellableTouchpointIds": [1, 2], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 1, - 2 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2", - "method": "GET" - } - } - } - ] + ], } List containing one product with 4 currently active SellingPeriods (called by touchpointId 3): summary: List containing one product with 4 currently active SellingPeriods (called by touchpointId 3) description: Only two sellingPeriods for touchpoint 3 and/or 4 (part of same retailer) are returned - the price for touchpointId 3 is returned value: { - "Entries": [ - { - "productId": 2, - "productCode": "312AB-WL", - "productName": "HTM dagkaart", - "productDescription": "Reis een dag met het openbaar vervoer bij HTM", - "productCategory": { - "productCategoryId": 6, - "isTravelProduct": false, - "name": "Barcode" + "Entries": + [ + { + "productId": 2, + "productName": "HTM dagkaart", + "productDescription": "Reis een dag met het openbaar vervoer bij HTM", + "productCategory": + { + "productCategoryId": 6, + "isTravelProduct": false, + "name": "Barcode", + }, + "tokenTypes": [], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2", - "method": "GET" - } - } - } - ] + ], } List containing one product which can only be sold by touchpointId 3 (called by touchpointId 4): summary: List containing one product which can only be sold by touchpointId 3 (called by touchpointId 4) description: Product is still returned (because touchpointId 3 is part of same retailer) but no price, as touchpointId 4 is not allowed to sell this product. value: { - "Entries": [ - { - "productId": 49, - "productCode": null, - "productName": "HTM Regio Vrij", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" + "Entries": + [ + { + "productId": 49, + "productName": "HTM Regio Vrij", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "tokenTypes": [], + "sellableTouchpointIds": [3], + "amountInclTax": null, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/49", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 3 - ], - "amountInclTax": null, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/49", - "method": "GET" - } - } - } - ] + ], } List containing one product which can be sold by touchpointId 3 and 4 (called by touchpointId 4): summary: List containing one product which can be sold by touchpointId 3 and 4 (called by touchpointId 4) description: Product is returned value: { - "Entries": [ - { - "productId": 126, - "productCode": null, - "productName": "HTM-30001", - "productDescription": "Reis met 20% korting op je betaalpas bij HTM.", - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" + "Entries": + [ + { + "productId": 126, + "productName": "HTM-30001", + "productDescription": "Reis met 20% korting op je betaalpas bij HTM.", + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/126", + "method": "GET", + }, + }, }, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/126", - "method": "GET" - } - } - } - ] + ], } List containing multiple products (called by touchpointId 3): summary: List containing multiple products (called by touchpointId 3) description: Only products that have active SellingPeriods for touchpoint 3 and/or 4 (part of same retailer) are returned value: { - "Entries": [ - { - "productId": 2, - "productCode": "312AB-WL", - "productName": "HTM dagkaart", - "productDescription": "Reis een dag met het openbaar vervoer bij HTM", - "productCategory": { - "productCategoryId": 6, - "isTravelProduct": false, - "name": "Barcode" + "Entries": + [ + { + "productId": 2, + "productName": "HTM dagkaart", + "productDescription": "Reis een dag met het openbaar vervoer bij HTM", + "productCategory": + { + "productCategoryId": 6, + "isTravelProduct": false, + "name": "Barcode", + }, + "tokenTypes": [], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2", - "method": "GET" - } - } - }, - { - "productId": 4, - "productCode": "30002-ML", - "productName": "HTM 40% korting", - "productDescription": "Reis een maand lang met 40% korting!", - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" + { + "productId": 4, + "productName": "HTM 40% korting", + "productDescription": "Reis een maand lang met 40% korting!", + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 800, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/4", + "method": "GET", + }, + }, }, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 800, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/4", - "method": "GET" - } - } - } - ] + ], } /products/{productId}: get: @@ -286,7 +275,7 @@ paths: Get more details for a single HTM product (including all child products/productVariants), specified by the productId. \ Only information that is allowed to be seen by the calling touchpoint is returned - i.e. only currently active selling periods and prices for the calling touchpoint are returned. Future/past prices and prices - for other touchpoints are thus filtered out. + for other touchpoints are thus filtered out. **Empty lists/arrays show up as "[]", not as null!** The response contains a product tree, including all child products (`productVariants`) of the given productId that the touchpoint is allowed to see and/or sell. @@ -306,90 +295,69 @@ paths: type: integer example: 1 responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/ProductPayloadResponse' + $ref: "#/components/schemas/ProductPayloadResponse" examples: 90% Discount F&F pilot product (called by touchpointId 3): summary: 90% Discount F&F pilot product (called by touchpointId 3) description: |- - All details (that the calling touchpoint is allowed to see) for the 90% Discount F&F pilot product.\ - Even though this product has sellingPeriods for multiple touchpoints, only the currently active sellingPeriod and price for touchpointId 3 are returned. + All details (that the calling touchpoint is allowed to see) for the 90% Discount F&F pilot product.\ + Even though this product has sellingPeriods for multiple touchpoints, only the currently active sellingPeriod and price for touchpointId 3 are returned. - This product has no child products, so its `productVariants` array is empty. + This product has no child products, so its `productVariants` array is empty. value: { "productId": 24, "parentProductId": null, - "productCode": "HTM-30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, "productName": "HTM 90% Korting", "productDescription": "Reis je regelmatig met HTM? Activeer dan HTM 90% Korting op je betaalpas of credit card en reis een week lang met korting!", - "validityPeriod": { - "validityPeriodId": 144, - "fromInclusive": "2023-12-31T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM 90% Discount", - "description": "Are you a regular traveler? Activate HTM 90% discount on your EMV card!" - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ + "validityPeriodId": 144, + "fromInclusive": "2023-12-31T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM 90% Discount", + "description": "Are you a regular traveler? Activate HTM 90% discount on your EMV card!", + }, + ], + "productOwner": { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": null, - "requiredGboPersonalAttributes": null, - "tokenTypes": [ + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "allowedGboAgeProfiles": [], + "customerSegments": [], + "productCategory": { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": [], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P7D", "maxStartInFutureDuration": "P6W", "isRenewable": false, @@ -400,126 +368,118 @@ paths: "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 78, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + "sellingPeriods": + [ + { + "sellingPeriodId": 78, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 78, + "amountExclTax": 92, + "amountInclTax": 100, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 78, - "amountExclTax": 92, - "amountInclTax": 100, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null + ], + "purchasePrices": [], + "productVariants": [], } 20% Discount product (called by touchpointId 4): summary: 20% Discount product (called by touchpointId 4) description: |- - All details (that the calling touchpoint is allowed to see) for the 20% Discount product.\ - Even though this product has sellingPeriods for multiple touchpoints (3 and 4), only the currently active sellingPeriod and price for touchpointId 4 are returned. + All details (that the calling touchpoint is allowed to see) for the 20% Discount product.\ + Even though this product has sellingPeriods for multiple touchpoints (3 and 4), only the currently active sellingPeriod and price for touchpointId 4 are returned. - This product has two `productVariants`: a single month variant and a subscription variant. + This product has two `productVariants`: a single month variant and a subscription variant. value: { "productId": 126, "parentProductId": null, - "productCode": "HTM-30001", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30001", "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM 20% Korting", "productDescription": "Reis met 20% korting op je betaalpas bij HTM.", - "validityPeriod": { - "validityPeriodId": 236, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM 20% Discount", - "description": "Travel with 20% discount using your bank card with HTM." - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ - { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" + "validityPeriodId": 236, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM 20% Discount", + "description": "Travel with 20% discount using your bank card with HTM.", + }, + ], + "productOwner": { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": null, - "tokenTypes": [ + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "customerSegments": [], + "allowedGboAgeProfiles": [], + "productCategory": { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + ], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": null, @@ -530,418 +490,397 @@ paths: "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 172, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 4, - "name": "App (Infoplaza)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 119, - "parentProductId": 126, - "productCode": "HTM-30001-ML", - "gboPackageTemplateId": "30001", - "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, - "productName": "HTM 20% Korting (losse maand)", - "productDescription": "Reis een maand lang met 20% korting op je betaalpas bij HTM.", - "validityPeriod": { - "validityPeriodId": 229, + "sellingPeriods": + [ + { + "sellingPeriodId": 172, "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM 20% Discount (single month)", - "description": "Travel with 20% discount for a month using your bank card with HTM." - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ - { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": null, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": false, - "sendInvoice": false, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 160, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "salesTouchpoint": + { "salesTouchpointId": 4, "name": "App (Infoplaza)", "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ + "forbiddenPaymentMethods": [], + "sellingPrices": [], + }, + ], + "purchasePrices": [], + "productVariants": + [ + { + "productId": 119, + "parentProductId": 126, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "30001", + "tapConnectProductCode": null, + "productName": "HTM 20% Korting (losse maand)", + "productDescription": "Reis een maand lang met 20% korting op je betaalpas bij HTM.", + "validityPeriod": + { + "validityPeriodId": 229, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", + }, + "productTranslations": + [ { - "sellingPriceId": 149, - "amountExclTax": 276, - "amountInclTax": 300, + "language": "en", + "name": "HTM 20% Discount (single month)", + "description": "Travel with 20% discount for a month using your bank card with HTM.", + }, + ], + "productOwner": + { + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "customerSegments": [], + "gboAgeProfiles": [], + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + ], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": false, + "sendInvoice": false, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 160, "fromInclusive": "2025-01-19T23:00:00.000+00:00", "toInclusive": "2028-11-17T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - }, - { - "productId": 120, - "parentProductId": 126, - "productCode": "HTM-30001-MA", - "gboPackageTemplateId": "30001", - "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" + "salesTouchpoint": + { + "salesTouchpointId": 4, + "name": "App (Infoplaza)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 149, + "amountExclTax": 276, + "amountInclTax": 300, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], }, - "productName": "HTM 20% Korting (doorlopend abonnement)", - "productDescription": "Reis gedurende je abonnement met 20% korting op je betaalpas bij HTM.", - "validityPeriod": { - "validityPeriodId": 230, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM 20% Discount (subscription)", - "description": "Travel with 20% discount for the duration of your subscription using your bank card with HTM." - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ - { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": null, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": true, - "sendInvoice": true, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 159, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 4, - "name": "App (Infoplaza)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + { + "productId": 120, + "parentProductId": 126, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "30001", + "tapConnectProductCode": null, + "productName": "HTM 20% Korting (doorlopend abonnement)", + "productDescription": "Reis gedurende je abonnement met 20% korting op je betaalpas bij HTM.", + "validityPeriod": + { + "validityPeriodId": 230, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ + "productTranslations": + [ { - "sellingPriceId": 148, - "amountExclTax": 276, - "amountInclTax": 300, + "language": "en", + "name": "HTM 20% Discount (subscription)", + "description": "Travel with 20% discount for the duration of your subscription using your bank card with HTM.", + }, + ], + "productOwner": + { + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "customerSegments": [], + "allowedGboAgeProfiles": [], + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + ], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": true, + "sendInvoice": true, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 159, "fromInclusive": "2025-01-19T23:00:00.000+00:00", "toInclusive": "2028-11-17T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - } - ] - } + "salesTouchpoint": + { + "salesTouchpointId": 4, + "name": "App (Infoplaza)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 148, + "amountExclTax": 276, + "amountInclTax": 300, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + ], + } Regio Vrij product and (part of) its productVariants (called by touchpointId 3): summary: Regio Vrij product and (part of) its productVariants (called by touchpointId 3) - description: |- - All details (that the calling touchpoint is allowed to see) for the parent Regio Vrij product - and (7 out of 84 of) its productVariants; the full tree would be too huge to be useful as an example. + description: |- + All details (that the calling touchpoint is allowed to see) for the parent Regio Vrij product + and (7 out of 84 of) its productVariants; the full tree would be too huge to be useful as an example. - The full depth of the tree is included in the example for the HL62 Reduced Fare Variant. + The full depth of the tree is included in the example for the HL62 Reduced Fare Variant. value: { "productId": 49, "parentProductId": null, - "productCode": null, + "fikoArticleNumber": "1234", "gboPackageTemplateId": null, "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM Regio Vrij", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", - "validityPeriod": { - "validityPeriodId": 161, - "fromInclusive": "2024-11-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM Regio Free", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in the chosen area. in the Rotterdam The Hague region." - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "validityPeriodId": 161, + "fromInclusive": "2024-11-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in the chosen area. in the Rotterdam The Hague region.", + }, + ], + "productOwner": { - "customerSegmentId": 3, - "name": "Jongere (12-18)" + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, + }, + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, + ], + "productCategory": { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": - [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 3, "name": "profile" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": null, @@ -952,611 +891,1014 @@ paths: "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 99, - "fromInclusive": "2024-11-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 109, - "parentProductId": 49, - "productCode": null, - "gboPackageTemplateId": null, - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 219, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - }, - { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 143, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { + "sellingPeriods": + [ + { + "sellingPeriodId": 99, + "fromInclusive": "2024-11-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { "salesTouchpointId": 3, "name": "Website (Perplex)", "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 114, - "parentProductId": 109, - "productCode": null, - "gboPackageTemplateId": "33629", - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - Voltarief - HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 224, + "forbiddenPaymentMethods": [], + "sellingPrices": [], + }, + ], + "purchasePrices": [], + "productVariants": + [ + { + "productId": 109, + "parentProductId": 49, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": null, + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 219, "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" + "toInclusive": "2099-12-30T23:00:00.000+00:00", }, - "productTranslations": [ + "productTranslations": + [ { "language": "en", - "name": "HTM Regio Free - Full Fare - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } + "name": "HTM Regio Free - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, ], - "productOwner": { + "productOwner": + { "productOwnerId": 19, "name": "MRDH", - "organization": "MRDH" + "organization": "MRDH", }, - "marketSegments": null, - "customerSegments": [ + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, }, { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, ], - "productCategory": { + "productCategory": + { "productCategoryId": 3, "isTravelProduct": true, - "name": "Afgekocht reisrecht" + "name": "Afgekocht reisrecht", }, - "requiredCustomerLevel": { + "requiredCustomerLevel": + { "requiredCustomerLevelId": 3, - "name": "profile" + "name": "profile", }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ { "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" + "customerDataItem": "birthname", }, { "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" + "customerDataItem": "surname", }, { "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" + "customerDataItem": "dateOfBirth", }, { "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" + "customerDataItem": "emailAddress", }, { "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, ], - "requiredGboPersonalAttributes": [ + "requiredGboPersonalAttributes": + [ { "requiredGboPersonalAttributeId": 1, - "name": "NAME" + "name": "NAME", }, { "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" + "name": "BIRTHDATE", }, { "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } + "name": "PHOTO", + }, ], - "tokenTypes": [ + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 148, + "sellingPeriodId": 143, "fromInclusive": "2024-10-30T23:00:00.000+00:00", "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ + "salesTouchpoint": { - "sellingPriceId": 139, - "amountExclTax": 5412, - "amountInclTax": 5900, - "fromInclusive": "2024-12-31T23:00:00.000+00:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - }, - { - "productId": 115, - "parentProductId": 109, - "productCode": null, - "gboPackageTemplateId": "33630", - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - Reductietarief - HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 225, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - Reduced Fare - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": [], }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - } ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ + "purchasePrices": [], + "productVariants": + [ { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 149, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 140, - "amountExclTax": 8899, - "amountInclTax": 9700, - "fromInclusive": "2024-12-31T23:00:00.000+0:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 116, - "parentProductId": 115, - "productCode": "33630-ML", - "gboPackageTemplateId": "33630", + "productId": 114, + "parentProductId": 109, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33629", "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, - "productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62", + "productName": "HTM Regio Vrij - Voltarief - HL62", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 226, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM Regio Free - Reduced Fare - 1 Month - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "validityPeriodId": 224, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Full Fare - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, + ], + "productCategory": { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", }, + "requiredCustomerLevel": { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" + "requiredCustomerLevelId": 3, + "name": "profile", }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", - "isRenewable": false, - "sendInvoice": false, + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 148, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 139, + "amountExclTax": 5412, + "amountInclTax": 5900, + "fromInclusive": "2024-12-31T23:00:00.000+00:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + { + "productId": 115, + "parentProductId": 109, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33630", + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - Reductietarief - HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 225, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Reduced Fare - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": null, + "sendInvoice": null, "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ + "sellingPeriods": + [ + { + "sellingPeriodId": 149, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 140, + "amountExclTax": 8899, + "amountInclTax": 9700, + "fromInclusive": "2024-12-31T23:00:00.000+0:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": + [ + { + "productId": 116, + "parentProductId": 115, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33630", + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 226, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Reduced Fare - 1 Month - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { + "paymentMomentId": 1, + "name": "prepaid", + }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": false, + "sendInvoice": false, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 150, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 141, + "amountExclTax": 8899, + "amountInclTax": 9700, + "fromInclusive": "2024-12-31T23:00:00.000+0:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + { + "productId": 117, + "parentProductId": 115, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33630", + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 227, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Reduced Fare - Renewable subscription - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { + "paymentMomentId": 1, + "name": "prepaid", + }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": true, + "sendInvoice": true, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 151, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": 572309345923, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 142, + "amountExclTax": 8899, + "amountInclTax": 9700, + "fromInclusive": "2024-12-31T23:00:00.000+0:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + ], + }, + ], + }, + { + "productId": 112, + "parentProductId": 49, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": null, + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - HL65", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65", + "validityPeriod": + { + "validityPeriodId": 222, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - HL65", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL65", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, + }, + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 146, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": { - "sellingPeriodId": 150, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { "retailerId": 1001, "name": "HTM externe touchpoints", "street": "Koningin Julianaplein", - "number": 10, + "number": "10", "numberAddition": null, "postalCode": "2595 AA", "city": "Den Haag", @@ -1564,350 +1906,24 @@ paths: "emailAddress": "info@htm.nl", "phoneNumber": "070 374 9002", "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 141, - "amountExclTax": 8899, - "amountInclTax": 9700, - "fromInclusive": "2024-12-31T23:00:00.000+0:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": [], }, - { - "productId": 117, - "parentProductId": 115, - "productCode": "33630-MA", - "gboPackageTemplateId": "33630", - "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, - "productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 227, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - Reduced Fare - Renewable subscription - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": true, - "sendInvoice": true, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 151, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 142, - "amountExclTax": 8899, - "amountInclTax": 9700, - "fromInclusive": "2024-12-31T23:00:00.000+0:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - } - ] - } - ] - }, - { - "productId": 112, - "parentProductId": 49, - "productCode": null, - "gboPackageTemplateId": null, - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - HL65", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65", - "validityPeriod": { - "validityPeriodId": 222, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" + ], + "purchasePrices": [], + "productVariants": [], }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - HL65", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL65" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - }, - { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 146, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": null - } - ] + ], } - '404': - description: '404' + "404": + description: "404" content: application/json: schema: - $ref: '#/components/schemas/rfc9457Response' + $ref: "#/components/schemas/rfc9457Response" examples: Non-existing productId: summary: Non-existing productId @@ -1917,30 +1933,32 @@ paths: "title": "Product not found.", "detail": "No product found for productId: 1000.", "instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c", - "apiErrorCode": "htm.api.err.404.2" + "apiErrorCode": "htm.api.err.404.2", } components: schemas: - TaxMetadataResponse: + GboAgeProfileResponse: type: object required: - - taxMetadataId - - taxCode - - taxPercentageAmount + - gboAgeProfileId + - name + - ageFromInclusive + - ageUntilInclusive properties: - taxMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - taxCode: - type: string - example: V09 - taxPercentageAmount: + gboAgeProfileId: type: integer - example: 21 - description: + example: 1 + name: type: string - example: BTW VERKOOP LAAG 9% + example: Kind (4 t/m 11 jaar) + ageFromInclusive: + type: integer + description: The minimum age that the GBO age profile applies to + example: 4 + ageUntilInclusive: + type: integer + description: The maximum age that the GBO age profile applies to + example: 11 ProductTranslationResponse: type: object required: @@ -1962,7 +1980,8 @@ components: required: - sellingPriceId - amountExclTax - - taxMetadata + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -1974,19 +1993,23 @@ components: amountExclTax: type: integer example: 750 - taxMetadata: - $ref: '#/components/schemas/TaxMetadataResponse' + taxCode: + type: string + example: "V09" + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 fromInclusive: type: string format: date-time-offset - example: '2022-03-01T00:00:00.000+00:00' + example: "2022-03-01T00:00:00.000+00:00" toInclusive: type: string format: date-time-offset - example: '2022-06-01T00:00:00.000+00:00' + example: "2022-06-01T00:00:00.000+00:00" internalPrice: type: number example: 908.1234 @@ -1995,7 +2018,8 @@ components: required: - purchasePriceId - amountExclTax - - taxMetadata + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -2006,19 +2030,23 @@ components: amountExclTax: type: integer example: 750 - taxMetadata: - $ref: '#/components/schemas/TaxMetadataResponse' + taxCode: + type: string + example: "V09" + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 fromInclusive: type: string format: date-time-offset - example: '2022-03-01T00:00:00.000+00:00' + example: "2022-03-01T00:00:00.000+00:00" toInclusive: type: string format: date-time-offset - example: '2022-06-01T00:00:00.000+00:00' + example: "2022-06-01T00:00:00.000+00:00" SalesTouchpointResponse: type: object required: @@ -2053,7 +2081,7 @@ components: example: Kon. Julianaplein number: type: string - example: '10' + example: "10" numberAddition: type: string example: a @@ -2072,10 +2100,10 @@ components: example: info@htm.nl phoneNumber: type: string - example: '09004864636' + example: "09004864636" taxId: type: string - example: '09004864636' + example: "09004864636" imageReference: type: string example: https://htm.azure.net/abt/retailers/htm.svg @@ -2094,9 +2122,6 @@ components: productId: type: integer example: 1 - productCode: - type: string - example: 30901-WL productName: type: string example: HTM pilot 90% korting @@ -2177,66 +2202,16 @@ components: parentProductId: type: integer example: 1 - productCode: + fikoArticleNumber: type: string - example: 30901-WL + description: The article number of the product in FIKO + example: 1234 gboPackageTemplateId: type: string - example: '30901' + example: "30901" tapConnectProductCode: type: string example: 1234AB - productGroupMetadata: - type: object - required: - - productGroupMetadataId - - productGroupCode - - department - - costCenter - - costType - - description - - documentCode - - user - - timestampUpdated - - validFrom - properties: - productGroupMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - productGroupCode: - type: string - example: TBD - department: - type: string - example: TBD - costCenter: - type: string - example: TBD - costType: - type: string - example: TBD - description: - type: string - example: TBD - documentCode: - type: string - example: TBD - user: - type: string - example: TBD - timestampUpdated: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validFrom: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validUntil: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' productName: type: string example: HTM pilot 90% korting @@ -2256,15 +2231,15 @@ components: fromInclusive: type: string format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' + example: "2024-09-03T10:01:34.000+00:00" toInclusive: type: string format: date-time-offset - example: '2024-09-03T23:59:59.999+00:00' + example: "2024-09-03T23:59:59.999+00:00" productTranslations: type: array items: - $ref: '#/components/schemas/ProductTranslationResponse' + $ref: "#/components/schemas/ProductTranslationResponse" productOwner: type: object required: @@ -2308,6 +2283,10 @@ components: name: type: string example: Kind (4-11) + allowedGboAgeProfiles: + type: array + items: + $ref: "#/components/schemas/GboAgeProfileResponse" productCategory: type: object required: @@ -2500,13 +2479,13 @@ components: fromInclusive: type: string format: date-time-offset - example: '2022-03-01T00:00:00.000+00:00' + example: "2022-03-01T00:00:00.000+00:00" toInclusive: type: string format: date-time-offset - example: '2022-06-01T00:00:00.000+00:00' + example: "2022-06-01T00:00:00.000+00:00" salesTouchpoint: - $ref: '#/components/schemas/SalesTouchpointResponse' + $ref: "#/components/schemas/SalesTouchpointResponse" forbiddenPaymentMethods: type: array items: @@ -2527,11 +2506,11 @@ components: sellingPrices: type: array items: - $ref: '#/components/schemas/SellingPriceResponse' + $ref: "#/components/schemas/SellingPriceResponse" purchasePrices: type: array items: - $ref: '#/components/schemas/PurchasePriceResponse' + $ref: "#/components/schemas/PurchasePriceResponse" auditTrail: type: array items: @@ -2554,7 +2533,7 @@ components: timestamp: type: string format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' + example: "2024-09-03T10:01:34.000+00:00" rfc9457Response: type: object properties: @@ -2580,9 +2559,9 @@ components: example: "additionalValue1" additionalProperty2: type: array - description: "Example of an additional property array to be used for error reporting." + description: "Example of an additional property array to be used for error reporting." items: type: string example: - "additionalValue2-1" - - "additionalValue2-2" \ No newline at end of file + - "additionalValue2-2" diff --git a/src/openapi/products/SE-products-TP.yaml b/src/openapi/products/SE-products-TP.yaml index fe42ee4..163ee34 100644 --- a/src/openapi/products/SE-products-TP.yaml +++ b/src/openapi/products/SE-products-TP.yaml @@ -4,7 +4,7 @@ info: description: |- Service Engine APIs for HTM products. These are NOT the CRUD APIs to access raw data in the database. To be used by touchpoints to get information about HTM products they are allowed to see and/or sell. - version: '1.0' + version: "1.0" servers: - url: https://api.integratielaag.nl/abt/touchpoint/2.0 tags: @@ -30,252 +30,241 @@ paths: in: query required: false description: |- - Only return products that refer to the given parentProductId. \ - Returns parent-products (i.e. products with parentProductId = null) if left empty. + Only return products that refer to the given parentProductId. \ + Returns parent-products (i.e. products with parentProductId = null) if left empty. schema: type: integer example: 1 responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/ProductPayloadListResponse' + $ref: "#/components/schemas/ProductPayloadListResponse" examples: No products / Empty list: summary: No products / Empty list description: No products - value: - { - "Entries": [] - } + value: { "Entries": [] } List containing one product with many null attributes: summary: List containing one product with many null attributes description: |- - Most product attributes are optional on a database level and can thus be null; this example shows that all attributes as defined in the schema are always represented in the response, even if null. \ - **Empty lists/arrays show up as "[]", not as null!** + Most product attributes are optional on a database level and can thus be null; this example shows that all attributes as defined in the schema are always represented in the response, even if null. \ + **Empty lists/arrays show up as "[]", not as null!** value: { - "Entries": [ - { - "productId": 99, - "productCode": null, - "productName": null, - "productDescription": null, - "productCategory": null, - "tokenTypes": [], - "sellableTouchpointIds": [], - "amountInclTax": null, - "imageReference": null, - "productPageUrl": null, - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/99", - "method": "GET" - } - } - } - ] + "Entries": + [ + { + "productId": 99, + "productName": null, + "productDescription": null, + "productCategory": null, + "tokenTypes": [], + "sellableTouchpointIds": [], + "amountInclTax": null, + "imageReference": null, + "productPageUrl": null, + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/99", + "method": "GET", + }, + }, + }, + ], } List containing one product with 4 currently active SellingPeriods (called by touchpointId 1): summary: List containing one product with 4 currently active SellingPeriods (called by touchpointId 1) description: Only two sellingPeriods for touchpoint 1 and/or 2 (part of same retailer) are returned - the price for touchpointId 1 is returned value: { - "Entries": [ - { - "productId": 2, - "productCode": "312AB-WL", - "productName": "HTM dagkaart", - "productDescription": "Reis een dag met het openbaar vervoer bij HTM", - "productCategory": { - "productCategoryId": 6, - "isTravelProduct": false, - "name": "Barcode" + "Entries": + [ + { + "productId": 2, + "productName": "HTM dagkaart", + "productDescription": "Reis een dag met het openbaar vervoer bij HTM", + "productCategory": + { + "productCategoryId": 6, + "isTravelProduct": false, + "name": "Barcode", + }, + "tokenTypes": [], + "sellableTouchpointIds": [1, 2], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 1, - 2 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2", - "method": "GET" - } - } - } - ] + ], } List containing one product with 4 currently active SellingPeriods (called by touchpointId 3): summary: List containing one product with 4 currently active SellingPeriods (called by touchpointId 3) description: Only two sellingPeriods for touchpoint 3 and/or 4 (part of same retailer) are returned - the price for touchpointId 3 is returned value: { - "Entries": [ - { - "productId": 2, - "productCode": "312AB-WL", - "productName": "HTM dagkaart", - "productDescription": "Reis een dag met het openbaar vervoer bij HTM", - "productCategory": { - "productCategoryId": 6, - "isTravelProduct": false, - "name": "Barcode" + "Entries": + [ + { + "productId": 2, + "productName": "HTM dagkaart", + "productDescription": "Reis een dag met het openbaar vervoer bij HTM", + "productCategory": + { + "productCategoryId": 6, + "isTravelProduct": false, + "name": "Barcode", + }, + "tokenTypes": [], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2", - "method": "GET" - } - } - } - ] + ], } List containing one product which can only be sold by touchpointId 3 (called by touchpointId 4): summary: List containing one product which can only be sold by touchpointId 3 (called by touchpointId 4) description: Product is still returned (because touchpointId 3 is part of same retailer) but no price, as touchpointId 4 is not allowed to sell this product. value: { - "Entries": [ - { - "productId": 49, - "productCode": null, - "productName": "HTM Regio Vrij", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" + "Entries": + [ + { + "productId": 49, + "productName": "HTM Regio Vrij", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "tokenTypes": [], + "sellableTouchpointIds": [3], + "amountInclTax": null, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/49", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 3 - ], - "amountInclTax": null, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/49", - "method": "GET" - } - } - } - ] + ], } List containing one product which can be sold by touchpointId 3 and 4 (called by touchpointId 4): summary: List containing one product which can be sold by touchpointId 3 and 4 (called by touchpointId 4) description: Product is returned value: { - "Entries": [ - { - "productId": 126, - "productCode": null, - "productName": "HTM-30001", - "productDescription": "Reis met 20% korting op je betaalpas bij HTM.", - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" + "Entries": + [ + { + "productId": 126, + "productName": "HTM-30001", + "productDescription": "Reis met 20% korting op je betaalpas bij HTM.", + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/126", + "method": "GET", + }, + }, }, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/126", - "method": "GET" - } - } - } - ] + ], } List containing multiple products (called by touchpointId 3): summary: List containing multiple products (called by touchpointId 3) description: Only products that have active SellingPeriods for touchpoint 3 and/or 4 (part of same retailer) are returned value: { - "Entries": [ - { - "productId": 2, - "productCode": "312AB-WL", - "productName": "HTM dagkaart", - "productDescription": "Reis een dag met het openbaar vervoer bij HTM", - "productCategory": { - "productCategoryId": 6, - "isTravelProduct": false, - "name": "Barcode" + "Entries": + [ + { + "productId": 2, + "productName": "HTM dagkaart", + "productDescription": "Reis een dag met het openbaar vervoer bij HTM", + "productCategory": + { + "productCategoryId": 6, + "isTravelProduct": false, + "name": "Barcode", + }, + "tokenTypes": [], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 300, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2", + "method": "GET", + }, + }, }, - "tokenTypes": [], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 300, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2", - "method": "GET" - } - } - }, - { - "productId": 4, - "productCode": "30002-ML", - "productName": "HTM 40% korting", - "productDescription": "Reis een maand lang met 40% korting!", - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" + { + "productId": 4, + "productName": "HTM 40% korting", + "productDescription": "Reis een maand lang met 40% korting!", + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "sellableTouchpointIds": [3, 4], + "amountInclTax": 800, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/4", + "method": "GET", + }, + }, }, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "sellableTouchpointIds": [ - 3, - 4 - ], - "amountInclTax": 800, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina", - "_links": { - "get_details": { - "href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/4", - "method": "GET" - } - } - } - ] + ], } /products/{productId}: get: @@ -286,7 +275,7 @@ paths: Get more details for a single HTM product (including all child products/productVariants), specified by the productId. \ Only information that is allowed to be seen by the calling touchpoint is returned - i.e. only currently active selling periods and prices for the calling touchpoint are returned. Future/past prices and prices - for other touchpoints are thus filtered out. + for other touchpoints are thus filtered out. **Empty lists/arrays show up as "[]", not as null!** The response contains a product tree, including all child products (`productVariants`) of the given productId that the touchpoint is allowed to see and/or sell. @@ -306,90 +295,69 @@ paths: type: integer example: 1 responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/ProductPayloadResponse' + $ref: "#/components/schemas/ProductPayloadResponse" examples: 90% Discount F&F pilot product (called by touchpointId 3): summary: 90% Discount F&F pilot product (called by touchpointId 3) description: |- - All details (that the calling touchpoint is allowed to see) for the 90% Discount F&F pilot product.\ - Even though this product has sellingPeriods for multiple touchpoints, only the currently active sellingPeriod and price for touchpointId 3 are returned. + All details (that the calling touchpoint is allowed to see) for the 90% Discount F&F pilot product.\ + Even though this product has sellingPeriods for multiple touchpoints, only the currently active sellingPeriod and price for touchpointId 3 are returned. - This product has no child products, so its `productVariants` array is empty. + This product has no child products, so its `productVariants` array is empty. value: { "productId": 24, "parentProductId": null, - "productCode": "HTM-30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, "productName": "HTM 90% Korting", "productDescription": "Reis je regelmatig met HTM? Activeer dan HTM 90% Korting op je betaalpas of credit card en reis een week lang met korting!", - "validityPeriod": { - "validityPeriodId": 144, - "fromInclusive": "2023-12-31T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM 90% Discount", - "description": "Are you a regular traveler? Activate HTM 90% discount on your EMV card!" - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ + "validityPeriodId": 144, + "fromInclusive": "2023-12-31T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM 90% Discount", + "description": "Are you a regular traveler? Activate HTM 90% discount on your EMV card!", + }, + ], + "productOwner": { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": null, - "requiredGboPersonalAttributes": null, - "tokenTypes": [ + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "allowedGboAgeProfiles": [], + "customerSegments": [], + "productCategory": { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": [], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P7D", "maxStartInFutureDuration": "P6W", "isRenewable": false, @@ -400,126 +368,118 @@ paths: "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 78, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + "sellingPeriods": + [ + { + "sellingPeriodId": 78, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 78, + "amountExclTax": 92, + "amountInclTax": 100, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 78, - "amountExclTax": 92, - "amountInclTax": 100, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null + ], + "purchasePrices": [], + "productVariants": [], } 20% Discount product (called by touchpointId 4): summary: 20% Discount product (called by touchpointId 4) description: |- - All details (that the calling touchpoint is allowed to see) for the 20% Discount product.\ - Even though this product has sellingPeriods for multiple touchpoints (3 and 4), only the currently active sellingPeriod and price for touchpointId 4 are returned. + All details (that the calling touchpoint is allowed to see) for the 20% Discount product.\ + Even though this product has sellingPeriods for multiple touchpoints (3 and 4), only the currently active sellingPeriod and price for touchpointId 4 are returned. - This product has two `productVariants`: a single month variant and a subscription variant. + This product has two `productVariants`: a single month variant and a subscription variant. value: { "productId": 126, "parentProductId": null, - "productCode": "HTM-30001", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30001", "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM 20% Korting", "productDescription": "Reis met 20% korting op je betaalpas bij HTM.", - "validityPeriod": { - "validityPeriodId": 236, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM 20% Discount", - "description": "Travel with 20% discount using your bank card with HTM." - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ - { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" + "validityPeriodId": 236, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM 20% Discount", + "description": "Travel with 20% discount using your bank card with HTM.", + }, + ], + "productOwner": { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": null, - "tokenTypes": [ + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "customerSegments": [], + "allowedGboAgeProfiles": [], + "productCategory": { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + ], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": null, @@ -530,418 +490,397 @@ paths: "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 172, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 4, - "name": "App (Infoplaza)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 119, - "parentProductId": 126, - "productCode": "HTM-30001-ML", - "gboPackageTemplateId": "30001", - "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, - "productName": "HTM 20% Korting (losse maand)", - "productDescription": "Reis een maand lang met 20% korting op je betaalpas bij HTM.", - "validityPeriod": { - "validityPeriodId": 229, + "sellingPeriods": + [ + { + "sellingPeriodId": 172, "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM 20% Discount (single month)", - "description": "Travel with 20% discount for a month using your bank card with HTM." - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ - { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": null, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": false, - "sendInvoice": false, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 160, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "salesTouchpoint": + { "salesTouchpointId": 4, "name": "App (Infoplaza)", "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ + "forbiddenPaymentMethods": [], + "sellingPrices": [], + }, + ], + "purchasePrices": [], + "productVariants": + [ + { + "productId": 119, + "parentProductId": 126, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "30001", + "tapConnectProductCode": null, + "productName": "HTM 20% Korting (losse maand)", + "productDescription": "Reis een maand lang met 20% korting op je betaalpas bij HTM.", + "validityPeriod": + { + "validityPeriodId": 229, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", + }, + "productTranslations": + [ { - "sellingPriceId": 149, - "amountExclTax": 276, - "amountInclTax": 300, + "language": "en", + "name": "HTM 20% Discount (single month)", + "description": "Travel with 20% discount for a month using your bank card with HTM.", + }, + ], + "productOwner": + { + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "customerSegments": [], + "gboAgeProfiles": [], + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + ], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": false, + "sendInvoice": false, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 160, "fromInclusive": "2025-01-19T23:00:00.000+00:00", "toInclusive": "2028-11-17T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - }, - { - "productId": 120, - "parentProductId": 126, - "productCode": "HTM-30001-MA", - "gboPackageTemplateId": "30001", - "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" + "salesTouchpoint": + { + "salesTouchpointId": 4, + "name": "App (Infoplaza)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 149, + "amountExclTax": 276, + "amountInclTax": 300, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], }, - "productName": "HTM 20% Korting (doorlopend abonnement)", - "productDescription": "Reis gedurende je abonnement met 20% korting op je betaalpas bij HTM.", - "validityPeriod": { - "validityPeriodId": 230, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-25T04:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM 20% Discount (subscription)", - "description": "Travel with 20% discount for the duration of your subscription using your bank card with HTM." - } - ], - "productOwner": { - "productOwnerId": 17, - "name": "Corneel Verstoep", - "organization": "HTM" - }, - "marketSegments": [ - { - "marketSegmentId": 1, - "name": "B2C" - } - ], - "customerSegments": null, - "productCategory": { - "productCategoryId": 1, - "isTravelProduct": true, - "name": "Kortingsabonnement" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 1, - "name": "guest" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": null, - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": true, - "sendInvoice": true, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 159, - "fromInclusive": "2025-01-19T23:00:00.000+00:00", - "toInclusive": "2028-11-17T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 4, - "name": "App (Infoplaza)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + { + "productId": 120, + "parentProductId": 126, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "30001", + "tapConnectProductCode": null, + "productName": "HTM 20% Korting (doorlopend abonnement)", + "productDescription": "Reis gedurende je abonnement met 20% korting op je betaalpas bij HTM.", + "validityPeriod": + { + "validityPeriodId": 230, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-25T04:00:00.000+00:00", }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ + "productTranslations": + [ { - "sellingPriceId": 148, - "amountExclTax": 276, - "amountInclTax": 300, + "language": "en", + "name": "HTM 20% Discount (subscription)", + "description": "Travel with 20% discount for the duration of your subscription using your bank card with HTM.", + }, + ], + "productOwner": + { + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM", + }, + "marketSegments": + [{ "marketSegmentId": 1, "name": "B2C" }], + "customerSegments": [], + "allowedGboAgeProfiles": [], + "productCategory": + { + "productCategoryId": 1, + "isTravelProduct": true, + "name": "Kortingsabonnement", + }, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 1, "name": "guest" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + ], + "requiredGboPersonalAttributes": [], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": true, + "sendInvoice": true, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-20-korting", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-20-korting", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 159, "fromInclusive": "2025-01-19T23:00:00.000+00:00", "toInclusive": "2028-11-17T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - } - ] - } + "salesTouchpoint": + { + "salesTouchpointId": 4, + "name": "App (Infoplaza)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 148, + "amountExclTax": 276, + "amountInclTax": 300, + "fromInclusive": "2025-01-19T23:00:00.000+00:00", + "toInclusive": "2028-11-17T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + ], + } Regio Vrij product and (part of) its productVariants (called by touchpointId 3): summary: Regio Vrij product and (part of) its productVariants (called by touchpointId 3) - description: |- - All details (that the calling touchpoint is allowed to see) for the parent Regio Vrij product - and (7 out of 84 of) its productVariants; the full tree would be too huge to be useful as an example. + description: |- + All details (that the calling touchpoint is allowed to see) for the parent Regio Vrij product + and (7 out of 84 of) its productVariants; the full tree would be too huge to be useful as an example. - The full depth of the tree is included in the example for the HL62 Reduced Fare Variant. + The full depth of the tree is included in the example for the HL62 Reduced Fare Variant. value: { "productId": 49, "parentProductId": null, - "productCode": null, + "fikoArticleNumber": "1234", "gboPackageTemplateId": null, "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM Regio Vrij", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", - "validityPeriod": { - "validityPeriodId": 161, - "fromInclusive": "2024-11-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM Regio Free", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in the chosen area. in the Rotterdam The Hague region." - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "validityPeriodId": 161, + "fromInclusive": "2024-11-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in the chosen area. in the Rotterdam The Hague region.", + }, + ], + "productOwner": { - "customerSegmentId": 3, - "name": "Jongere (12-18)" + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, + }, + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, + ], + "productCategory": { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": - [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "requiredCustomerLevel": + { "requiredCustomerLevelId": 3, "name": "profile" }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": null, @@ -952,962 +891,1039 @@ paths: "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 99, - "fromInclusive": "2024-11-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 109, - "parentProductId": 49, - "productCode": null, - "gboPackageTemplateId": null, - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 219, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - }, - { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 143, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { + "sellingPeriods": + [ + { + "sellingPeriodId": 99, + "fromInclusive": "2024-11-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { "salesTouchpointId": 3, "name": "Website (Perplex)", "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 114, - "parentProductId": 109, - "productCode": null, - "gboPackageTemplateId": "33629", - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - Voltarief - HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 224, + "forbiddenPaymentMethods": [], + "sellingPrices": [], + }, + ], + "purchasePrices": [], + "productVariants": + [ + { + "productId": 109, + "parentProductId": 49, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": null, + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 219, "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" + "toInclusive": "2099-12-30T23:00:00.000+00:00", }, - "productTranslations": [ + "productTranslations": + [ { "language": "en", - "name": "HTM Regio Free - Full Fare - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } + "name": "HTM Regio Free - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, ], - "productOwner": { + "productOwner": + { "productOwnerId": 19, "name": "MRDH", - "organization": "MRDH" + "organization": "MRDH", }, - "marketSegments": null, - "customerSegments": [ + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, }, { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, ], - "productCategory": { + "productCategory": + { "productCategoryId": 3, "isTravelProduct": true, - "name": "Afgekocht reisrecht" + "name": "Afgekocht reisrecht", }, - "requiredCustomerLevel": { + "requiredCustomerLevel": + { "requiredCustomerLevelId": 3, - "name": "profile" + "name": "profile", }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ { "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" + "customerDataItem": "birthname", }, { "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" + "customerDataItem": "surname", }, { "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" + "customerDataItem": "dateOfBirth", }, { "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" + "customerDataItem": "emailAddress", }, { "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, ], - "requiredGboPersonalAttributes": [ + "requiredGboPersonalAttributes": + [ { "requiredGboPersonalAttributeId": 1, - "name": "NAME" + "name": "NAME", }, { "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" + "name": "BIRTHDATE", }, { "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } + "name": "PHOTO", + }, ], - "tokenTypes": [ + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 148, + "sellingPeriodId": 143, "fromInclusive": "2024-10-30T23:00:00.000+00:00", "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ + "salesTouchpoint": { - "sellingPriceId": 139, - "amountExclTax": 5412, - "amountInclTax": 5900, - "fromInclusive": "2024-12-31T23:00:00.000+00:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - }, - { - "productId": 115, - "parentProductId": 109, - "productCode": null, - "gboPackageTemplateId": "33630", - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - Reductietarief - HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 225, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - Reduced Fare - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 149, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 140, - "amountExclTax": 8899, - "amountInclTax": 9700, - "fromInclusive": "2024-12-31T23:00:00.000+0:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": [ - { - "productId": 116, - "parentProductId": 115, - "productCode": "33630-ML", - "gboPackageTemplateId": "33630", - "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, - "productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 226, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - Reduced Fare - 1 Month - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": false, - "sendInvoice": false, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 150, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { "retailerId": 1001, "name": "HTM externe touchpoints", "street": "Koningin Julianaplein", - "number": 10, + "number": "10", "numberAddition": null, "postalCode": "2595 AA", "city": "Den Haag", "country": "Nederland", "emailAddress": "info@htm.nl", "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 141, - "amountExclTax": 8899, - "amountInclTax": 9700, - "fromInclusive": "2024-12-31T23:00:00.000+0:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": [], }, + ], + "purchasePrices": [], + "productVariants": + [ { - "productId": 117, - "parentProductId": 115, - "productCode": "33630-MA", - "gboPackageTemplateId": "33630", + "productId": 114, + "parentProductId": 109, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33629", "tapConnectProductCode": null, - "productGroupMetadata": { - "productGroupMetadataId": "WIP", - "productGroupCode": "WIP", - "department": "WIP", - "costCenter": "WIP", - "costType": "WIP", - "description": "Work in Progress - will follow later, when FIKO is implemented", - "user": "WIP", - "documentCode": "WIP", - "timestampUpdated": "2024-09-03T15:07:53.470+00:00", - "validFrom": "2024-08-01T00:00:00.000+00:00", - "validUntil": "2025-08-01T00:00:00.000+00:00" - }, - "productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62", + "productName": "HTM Regio Vrij - Voltarief - HL62", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", - "validityPeriod": { - "validityPeriodId": 227, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" - }, - "productTranslations": [ + "validityPeriod": { - "language": "en", - "name": "HTM Regio Free - Reduced Fare - Renewable subscription - HL62", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "validityPeriodId": 224, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Full Fare - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, + ], + "productCategory": { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", }, + "requiredCustomerLevel": { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" + "requiredCustomerLevelId": 3, + "name": "profile", }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", - "isRenewable": true, - "sendInvoice": true, + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 148, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 139, + "amountExclTax": 5412, + "amountInclTax": 5900, + "fromInclusive": "2024-12-31T23:00:00.000+00:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + { + "productId": 115, + "parentProductId": 109, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33630", + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - Reductietarief - HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 225, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Reduced Fare - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": null, + "sendInvoice": null, "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", "isSellableAtHtm": true, "needsSolvencyCheckConsumer": false, "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ + "sellingPeriods": + [ + { + "sellingPeriodId": 149, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 140, + "amountExclTax": 8899, + "amountInclTax": 9700, + "fromInclusive": "2024-12-31T23:00:00.000+0:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": + [ + { + "productId": 116, + "parentProductId": 115, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33630", + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 226, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Reduced Fare - 1 Month - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { + "paymentMomentId": 1, + "name": "prepaid", + }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": false, + "sendInvoice": false, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 150, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 141, + "amountExclTax": 8899, + "amountInclTax": 9700, + "fromInclusive": "2024-12-31T23:00:00.000+0:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + { + "productId": 117, + "parentProductId": 115, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": "33630", + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62", + "validityPeriod": + { + "validityPeriodId": 227, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - Reduced Fare - Renewable subscription - HL62", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL62", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": + [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { + "paymentMomentId": 1, + "name": "prepaid", + }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": true, + "sendInvoice": true, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://www.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://www.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 151, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": "10", + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": + [ + { + "sellingPriceId": 142, + "amountExclTax": 8899, + "amountInclTax": 9700, + "fromInclusive": "2024-12-31T23:00:00.000+0:00", + "toInclusive": "2025-12-31T23:00:00.000+00:00", + "internalPrice": 0.0000, + "taxCode": "V09", + "taxPercentage": 9.0000, + }, + ], + }, + ], + "purchasePrices": [], + "productVariants": [], + }, + ], + }, + ], + }, + { + "productId": 112, + "parentProductId": 49, + "fikoArticleNumber": "1234", + "gboPackageTemplateId": null, + "tapConnectProductCode": null, + "productName": "HTM Regio Vrij - HL65", + "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65", + "validityPeriod": + { + "validityPeriodId": 222, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + }, + "productTranslations": + [ + { + "language": "en", + "name": "HTM Regio Free - HL65", + "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL65", + }, + ], + "productOwner": + { + "productOwnerId": 19, + "name": "MRDH", + "organization": "MRDH", + }, + "marketSegments": [], + "customerSegments": [], + "allowedGboAgeProfiles": + [ + { + "gboAgeProfileId": 1, + "name": "Baby/peuter (0 t/m 3 jaar)", + "ageFromInclusive": 0, + "ageToInclusive": 3, + }, + { + "ageProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, + { + "ageProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageToInclusive": 18, + }, + { + "ageProfileId": 4, + "name": "Volwassene (19 t/m 64 jaar)", + "ageFromInclusive": 19, + "ageToInclusive": 64, + }, + { + "ageProfileId": 5, + "name": "Oudere (65 jaar of ouder)", + "ageFromInclusive": 65, + "ageToInclusive": 999, + }, + ], + "productCategory": + { + "productCategoryId": 3, + "isTravelProduct": true, + "name": "Afgekocht reisrecht", + }, + "requiredCustomerLevel": + { + "requiredCustomerLevelId": 3, + "name": "profile", + }, + "requiredProducts": [], + "incompatibleProducts": [], + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 1, + "customerDataItem": "birthname", + }, + { + "mandatoryCustomerDataItemId": 2, + "customerDataItem": "surname", + }, + { + "mandatoryCustomerDataItemId": 3, + "customerDataItem": "dateOfBirth", + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress", + }, + { + "mandatoryCustomerDataItemId": 7, + "customerDataItem": "ovPayToken", + }, + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate", + }, + ], + "requiredGboPersonalAttributes": + [ + { + "requiredGboPersonalAttributeId": 1, + "name": "NAME", + }, + { + "requiredGboPersonalAttributeId": 2, + "name": "BIRTHDATE", + }, + { + "requiredGboPersonalAttributeId": 3, + "name": "PHOTO", + }, + ], + "tokenTypes": [{ "tokenTypeId": 1, "name": "EMV" }], + "paymentMoment": + { "paymentMomentId": 1, "name": "prepaid" }, + "serviceOptions": [], + "validityDuration": "P1M", + "maxStartInFutureDuration": "P6W", + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", + "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": + [ + { + "sellingPeriodId": 146, + "fromInclusive": "2024-10-30T23:00:00.000+00:00", + "toInclusive": "2029-12-30T23:00:00.000+00:00", + "salesTouchpoint": { - "sellingPeriodId": 151, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": + { "retailerId": 1001, "name": "HTM externe touchpoints", "street": "Koningin Julianaplein", - "number": 10, + "number": "10", "numberAddition": null, "postalCode": "2595 AA", "city": "Den Haag", "country": "Nederland", "emailAddress": "info@htm.nl", "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": [ - { - "sellingPriceId": 142, - "amountExclTax": 8899, - "amountInclTax": 9700, - "fromInclusive": "2024-12-31T23:00:00.000+0:00", - "toInclusive": "2025-12-31T23:00:00.000+00:00", - "internalPrice": 0.0000, - "taxMetadata": { - "taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - } - } - ] - } - ], - "purchasePrices": null, - "productVariants": null - } - ] - } - ] - }, - { - "productId": 112, - "parentProductId": 49, - "productCode": null, - "gboPackageTemplateId": null, - "tapConnectProductCode": null, - "productGroupMetadata": null, - "productName": "HTM Regio Vrij - HL65", - "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65", - "validityPeriod": { - "validityPeriodId": 222, - "fromInclusive": "2024-09-30T23:00:00.000+00:00", - "toInclusive": "2099-12-30T23:00:00.000+00:00" + "taxId": "572309345923", + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", + }, + }, + "forbiddenPaymentMethods": [], + "sellingPrices": [], + }, + ], + "purchasePrices": [], + "productVariants": [], }, - "productTranslations": [ - { - "language": "en", - "name": "HTM Regio Free - HL65", - "description": "For a fixed amount unlimited travel with EBS, HTM and RET in region HL65" - } - ], - "productOwner": { - "productOwnerId": 19, - "name": "MRDH", - "organization": "MRDH" - }, - "marketSegments": null, - "customerSegments": [ - { - "customerSegmentId": 2, - "name": "Kind (4-11)" - }, - { - "customerSegmentId": 3, - "name": "Jongere (12-18)" - }, - { - "customerSegmentId": 4, - "name": "Volwassene (19-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" - } - ], - "productCategory": { - "productCategoryId": 3, - "isTravelProduct": true, - "name": "Afgekocht reisrecht" - }, - "requiredCustomerLevel": { - "requiredCustomerLevelId": 3, - "name": "profile" - }, - "requiredProducts": null, - "incompatibleProducts": null, - "mandatoryCustomerDataItems": [ - { - "mandatoryCustomerDataItemId": 1, - "customerDataItem": "birthname" - }, - { - "mandatoryCustomerDataItemId": 2, - "customerDataItem": "surname" - }, - { - "mandatoryCustomerDataItemId": 3, - "customerDataItem": "dateOfBirth" - }, - { - "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" - }, - { - "mandatoryCustomerDataItemId": 7, - "customerDataItem": "ovPayToken" - } - ], - "requiredGboPersonalAttributes": [ - { - "requiredGboPersonalAttributeId": 1, - "name": "NAME" - }, - { - "requiredGboPersonalAttributeId": 2, - "name": "BIRTHDATE" - }, - { - "requiredGboPersonalAttributeId": 3, - "name": "PHOTO" - } - ], - "tokenTypes": [ - { - "tokenTypeId": 1, - "name": "EMV" - } - ], - "paymentMoment": { - "paymentMomentId": 1, - "name": "prepaid" - }, - "serviceOptions": null, - "validityDuration": "P1M", - "maxStartInFutureDuration": "P6W", - "isRenewable": null, - "sendInvoice": null, - "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", - "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/htm-regio-vrij", - "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/htm-regio-vrij/", - "isSellableAtHtm": true, - "needsSolvencyCheckConsumer": false, - "needsSolvencyCheckBusiness": false, - "sellingPeriods": [ - { - "sellingPeriodId": 146, - "fromInclusive": "2024-10-30T23:00:00.000+00:00", - "toInclusive": "2029-12-30T23:00:00.000+00:00", - "salesTouchpoint": { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailer": { - "retailerId": 1001, - "name": "HTM externe touchpoints", - "street": "Koningin Julianaplein", - "number": 10, - "numberAddition": null, - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "Nederland", - "emailAddress": "info@htm.nl", - "phoneNumber": "070 374 9002", - "taxId": 572309345923, - "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" - } - }, - "forbiddenPaymentMethods": null, - "sellingPrices": null - } - ], - "purchasePrices": null, - "productVariants": null - } - ] + ], } - '404': - description: '404' + "404": + description: "404" content: application/json: schema: - $ref: '#/components/schemas/rfc9457Response' + $ref: "#/components/schemas/rfc9457Response" examples: Non-existing productId: summary: Non-existing productId @@ -1917,30 +1933,32 @@ paths: "title": "Product not found.", "detail": "No product found for productId: 1000.", "instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c", - "apiErrorCode": "htm.api.err.404.2" + "apiErrorCode": "htm.api.err.404.2", } components: schemas: - TaxMetadataResponse: + GboAgeProfileResponse: type: object required: - - taxMetadataId - - taxCode - - taxPercentageAmount + - gboAgeProfileId + - name + - ageFromInclusive + - ageUntilInclusive properties: - taxMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - taxCode: - type: string - example: V09 - taxPercentageAmount: + gboAgeProfileId: type: integer - example: 21 - description: + example: 1 + name: type: string - example: BTW VERKOOP LAAG 9% + example: Kind (4 t/m 11 jaar) + ageFromInclusive: + type: integer + description: The minimum age that the GBO age profile applies to + example: 4 + ageUntilInclusive: + type: integer + description: The maximum age that the GBO age profile applies to + example: 11 ProductTranslationResponse: type: object required: @@ -1962,7 +1980,8 @@ components: required: - sellingPriceId - amountExclTax - - taxMetadata + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -1974,19 +1993,23 @@ components: amountExclTax: type: integer example: 750 - taxMetadata: - $ref: '#/components/schemas/TaxMetadataResponse' + taxCode: + type: string + example: "V09" + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 fromInclusive: type: string format: date-time-offset - example: '2022-03-01T00:00:00.000+00:00' + example: "2022-03-01T00:00:00.000+00:00" toInclusive: type: string format: date-time-offset - example: '2022-06-01T00:00:00.000+00:00' + example: "2022-06-01T00:00:00.000+00:00" internalPrice: type: number example: 908.1234 @@ -1995,7 +2018,8 @@ components: required: - purchasePriceId - amountExclTax - - taxMetadata + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -2006,19 +2030,23 @@ components: amountExclTax: type: integer example: 750 - taxMetadata: - $ref: '#/components/schemas/TaxMetadataResponse' + taxCode: + type: string + example: "V09" + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 fromInclusive: type: string format: date-time-offset - example: '2022-03-01T00:00:00.000+00:00' + example: "2022-03-01T00:00:00.000+00:00" toInclusive: type: string format: date-time-offset - example: '2022-06-01T00:00:00.000+00:00' + example: "2022-06-01T00:00:00.000+00:00" SalesTouchpointResponse: type: object required: @@ -2053,7 +2081,7 @@ components: example: Kon. Julianaplein number: type: string - example: '10' + example: "10" numberAddition: type: string example: a @@ -2072,10 +2100,10 @@ components: example: info@htm.nl phoneNumber: type: string - example: '09004864636' + example: "09004864636" taxId: type: string - example: '09004864636' + example: "09004864636" imageReference: type: string example: https://htm.azure.net/abt/retailers/htm.svg @@ -2094,9 +2122,6 @@ components: productId: type: integer example: 1 - productCode: - type: string - example: 30901-WL productName: type: string example: HTM pilot 90% korting @@ -2156,7 +2181,7 @@ components: properties: href: type: string - example: https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/1 + example: https://api.integratielaag.nl/abt/touchpoint/2.0/products/1 method: type: string example: GET @@ -2177,66 +2202,16 @@ components: parentProductId: type: integer example: 1 - productCode: + fikoArticleNumber: type: string - example: 30901-WL + description: The article number of the product in FIKO + example: 1234 gboPackageTemplateId: type: string - example: '30901' + example: "30901" tapConnectProductCode: type: string example: 1234AB - productGroupMetadata: - type: object - required: - - productGroupMetadataId - - productGroupCode - - department - - costCenter - - costType - - description - - documentCode - - user - - timestampUpdated - - validFrom - properties: - productGroupMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - productGroupCode: - type: string - example: TBD - department: - type: string - example: TBD - costCenter: - type: string - example: TBD - costType: - type: string - example: TBD - description: - type: string - example: TBD - documentCode: - type: string - example: TBD - user: - type: string - example: TBD - timestampUpdated: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validFrom: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validUntil: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' productName: type: string example: HTM pilot 90% korting @@ -2256,15 +2231,15 @@ components: fromInclusive: type: string format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' + example: "2024-09-03T10:01:34.000+00:00" toInclusive: type: string format: date-time-offset - example: '2024-09-03T23:59:59.999+00:00' + example: "2024-09-03T23:59:59.999+00:00" productTranslations: type: array items: - $ref: '#/components/schemas/ProductTranslationResponse' + $ref: "#/components/schemas/ProductTranslationResponse" productOwner: type: object required: @@ -2308,6 +2283,10 @@ components: name: type: string example: Kind (4-11) + allowedGboAgeProfiles: + type: array + items: + $ref: "#/components/schemas/GboAgeProfileResponse" productCategory: type: object required: @@ -2500,13 +2479,13 @@ components: fromInclusive: type: string format: date-time-offset - example: '2022-03-01T00:00:00.000+00:00' + example: "2022-03-01T00:00:00.000+00:00" toInclusive: type: string format: date-time-offset - example: '2022-06-01T00:00:00.000+00:00' + example: "2022-06-01T00:00:00.000+00:00" salesTouchpoint: - $ref: '#/components/schemas/SalesTouchpointResponse' + $ref: "#/components/schemas/SalesTouchpointResponse" forbiddenPaymentMethods: type: array items: @@ -2527,11 +2506,11 @@ components: sellingPrices: type: array items: - $ref: '#/components/schemas/SellingPriceResponse' + $ref: "#/components/schemas/SellingPriceResponse" purchasePrices: type: array items: - $ref: '#/components/schemas/PurchasePriceResponse' + $ref: "#/components/schemas/PurchasePriceResponse" auditTrail: type: array items: @@ -2554,7 +2533,7 @@ components: timestamp: type: string format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' + example: "2024-09-03T10:01:34.000+00:00" rfc9457Response: type: object properties: @@ -2580,9 +2559,9 @@ components: example: "additionalValue1" additionalProperty2: type: array - description: "Example of an additional property array to be used for error reporting." + description: "Example of an additional property array to be used for error reporting." items: type: string example: - "additionalValue2-1" - - "additionalValue2-2" \ No newline at end of file + - "additionalValue2-2" diff --git a/src/openapi/products/productreference-crud.yaml b/src/openapi/products/productreference-crud.yaml new file mode 100644 index 0000000..dc0f9d7 --- /dev/null +++ b/src/openapi/products/productreference-crud.yaml @@ -0,0 +1,2662 @@ +openapi: 3.0.1 +info: + title: ABTProductReference + description: >- + CRUD APIs for HTM product reference tables (based on the new domainmodel v2.4). + Internal use only; external touchpoints can get (some)) access via the HTM + Service Engine, using a different endpoint. + version: '1.0' +servers: + - url: https://api.integratielaag.nl/abt/productreference/1.0 +tags: + - name: ABTProductReference CRUD + description: >- + Internal use only; external touchpoints can get (some) access + via the HTM Service Engine. +paths: + /clientattributes: + get: + description: | + This method will get the list of all client attributes. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/clientAttributesGetEntity' + description: A list of client attributes + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get all client attributes. + tags: + - ABTProductReference CRUD + post: + description: "This method will create a single client attribute. \n" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/clientAttributesPostEntity' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a client attribute. + tags: + - ABTProductReference CRUD + /clientattributes/{clientAttributeId}: + delete: + description: "This method will delete the client attributes when provided the\n\ + clientAttributeId. \n" + parameters: + - explode: false + in: path + name: clientAttributeId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a client attribute. + tags: + - ABTProductReference CRUD + put: + description: "This method will update the client attributes when provided the\n\ + clientAttributesId. \n" + parameters: + - explode: false + in: path + name: clientAttributeId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/clientAttributesPutEntity' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Modify a client attribute. + tags: + - ABTProductReference CRUD + /productowners: + get: + description: | + This method will get the list of all productowners. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/productOwners' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get all productowners. + tags: + - ABTProductReference CRUD + post: + description: "This method will create a single productowner. \n" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/productOwner' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a productowners. + tags: + - ABTProductReference CRUD + /productowners/{productOwnerId}: + delete: + description: "This method will delete the productOwner when provided the\nproductOwnerId.\ + \ \n" + parameters: + - explode: false + in: path + name: productOwnerId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a productowner. + tags: + - ABTProductReference CRUD + put: + description: "This method will update the productOwner when provided the\nproductOwnerId.\ + \ \n" + parameters: + - explode: false + in: path + name: productOwnerId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/productOwner' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Modify a productowner. + tags: + - ABTProductReference CRUD + /productcategories: + get: + description: | + This method will get the list of productCategories + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/productCategories' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get all productcategories. + tags: + - ABTProductReference CRUD + post: + description: | + This method will create a single product category. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/productCategory' + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a product category. + tags: + - ABTProductReference CRUD + /productcategories/{productCategoryId}: + delete: + description: | + This method will delete the productCategory when provided the + productCategoryId. + parameters: + - explode: false + in: path + name: productCategoryId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a product category. + tags: + - ABTProductReference CRUD + put: + description: | + This method will update productCategory when provided the + productCategoryId. + parameters: + - explode: false + in: path + name: productCategoryId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/productCategory' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Modify a product category. + tags: + - ABTProductReference CRUD + /customersegments: + get: + description: This method will get the list of customer segments. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/customerSegments' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get all customer segments. + tags: + - ABTProductReference CRUD + post: + description: This method will create a single customer segment. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/customerSegment' + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a customer segment. + tags: + - ABTProductReference CRUD + /customersegments/{customerSegmentId}: + delete: + description: | + This method will delete a customer segment when provided the customerSegmentId. + parameters: + - explode: false + in: path + name: customerSegmentId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a customer segment. + tags: + - ABTProductReference CRUD + put: + description: | + This method will update a customer segment when provided the customerSegmentId. + parameters: + - explode: false + in: path + name: customerSegmentId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/customerSegment' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Modify a customer segment. + tags: + - ABTProductReference CRUD + /marketsegments: + get: + description: This method will get the list of market segments. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/marketSegments' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get all market segments. + tags: + - ABTProductReference CRUD + post: + description: This method will create a single market segment. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/marketSegment' + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a market segment. + tags: + - ABTProductReference CRUD + /marketsegments/{marketSegmentId}: + delete: + description: | + This method will delete a market segment when provided the marketSegmentId. + parameters: + - explode: false + in: path + name: marketSegmentId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a market segment. + tags: + - ABTProductReference CRUD + put: + description: | + This method will update a market segment when provided the marketSegmentId. + parameters: + - explode: false + in: path + name: marketSegmentId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/marketSegment' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Modify a market segment. + tags: + - ABTProductReference CRUD + /paymentmoments: + get: + description: | + This method will retrieve the list of payment moments. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/paymentMoments' + description: A list of payment moments + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of payment moments. + tags: + - ABTProductReference CRUD + /retailers: + get: + description: | + This method will retrieve the list of retailers. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/retailers' + description: A list of retailers + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of retailers. + tags: + - ABTProductReference CRUD + post: + description: | + This method will create a new retailer. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/retailer' + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a retailer. + tags: + - ABTProductReference CRUD + /retailers/{retailerId}: + delete: + description: | + This method will delete a retailer when provided the retailerId. + parameters: + - explode: false + in: path + name: retailerId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a retailer. + tags: + - ABTProductReference CRUD + put: + description: | + This method will update a retailer when provided the retailerId. + parameters: + - explode: false + in: path + name: retailerId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/retailer' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Update a retailer. + tags: + - ABTProductReference CRUD + /salestouchpoints: + get: + description: | + This method will get the list of sales touchpoints. It can also return + sales touchpoints based on retailerId. + parameters: + - description: retailerId + explode: true + in: query + name: retailerId + required: false + schema: + format: integer + type: integer + style: form + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/salesTouchpoints' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of salestouchpoints or a single salestouchpoints for a + given retailerId. + tags: + - ABTProductReference CRUD + post: + description: | + This method will create a new salestouchpoint. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/salesTouchpoint' + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a salestouchpoint. + tags: + - ABTProductReference CRUD + /salestouchpoints/{salesTouchpointId}: + delete: + description: | + This method will delete salesTouchpoint when provided the + salesTouchpointId. + parameters: + - explode: false + in: path + name: salesTouchpointId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a retailer. + tags: + - ABTProductReference CRUD + put: + description: | + This method will update sales touchpoints when provided the + salesTouchpointId. + parameters: + - explode: false + in: path + name: salesTouchpointId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/salesTouchpoint' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Update a salestouchpoints. + tags: + - ABTProductReference CRUD + /serviceoptions: + get: + description: | + This method will retrieve the list of serviceoptions. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/serviceOptions' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of serviceoptions. + tags: + - ABTProductReference CRUD + post: + description: | + This method will create a new serviceoptions. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/serviceOption' + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a serviceoptions. + tags: + - ABTProductReference CRUD + /serviceoptions/{serviceOptionId}: + delete: + description: | + This method will delete serviceoptions when provided the + serviceoptionsId. + parameters: + - explode: false + in: path + name: serviceOptionId + required: true + schema: + format: integer + type: integer + style: simple + responses: + "202": + description: Deleted record successfully + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Delete a serviceoptions. + tags: + - ABTProductReference CRUD + put: + description: | + This method will create a new serviceoption. + parameters: + - explode: false + in: path + name: serviceOptionId + required: true + schema: + format: integer + type: integer + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/serviceOption' + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes_post_201_response' + description: ok + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/_clientattributes__clientAttributeId__put_404_response' + description: Not Found + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/409Response' + description: Conflict + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Create a serviceoption. + tags: + - ABTProductReference CRUD + /mandatorycustomerdataitems: + get: + description: | + This method will retrieve the list of mandatorycustomerdataitems. + responses: + "200": + content: + application/json: + example: + Entries: + - mandatoryCustomerDataItemId: 1 + customerDataItem: birthname + - mandatoryCustomerDataItemId: 2 + customerDataItem: surname + - mandatoryCustomerDataItemId: 3 + customerDataItem: dateOfBirth + - mandatoryCustomerDataItemId: 4 + customerDataItem: emailAddress + - mandatoryCustomerDataItemId: 5 + customerDataItem: address + - mandatoryCustomerDataItemId: 6 + customerDataItem: phone + - mandatoryCustomerDataItemId: 7 + customerDataItem: ovPayToken + - mandatoryCustomerDataItemId: 8 + customerDataItem: padBirthDate + - mandatoryCustomerDataItemId: 9 + customerDataItem: shippingAddress + - mandatoryCustomerDataItemId: 10 + customerDataItem: billingAddress + schema: + $ref: '#/components/schemas/mandatoryCustomerDataItems' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of mandatorycustomerdataitems. + tags: + - ABTProductReference CRUD + /requiredcustomerlevels: + get: + description: | + This method will retrieve the list of requiredcustomerlevels. + responses: + "200": + content: + application/json: + example: + Entries: + - requiredCustomerLevelId: 1 + name: guest + - requiredCustomerLevelId: 2 + name: contact + - requiredCustomerLevelId: 3 + name: profile + schema: + $ref: '#/components/schemas/requiredCustomerLevels' + description: A list of users + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of requiredcustomerlevels. + tags: + - ABTProductReference CRUD + /forbiddenpaymentmethod: + get: + description: This method will retrieve the list of forbidden payments. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/getforbiddenPaymentMethodList' + description: A list of forbidden payment methods + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of forbidden payments. + tags: + - ABTProductReference CRUD + /requiredgbopersonalattribute: + get: + description: | + This method will retrieve the list of required personal attribute. + parameters: [] + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/requiredGboPersonalAttributes' + description: A list of Required GBO personal attributes + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of required personal attribute . + tags: + - ABTProductReference CRUD + /gboageprofiles: + get: + description: | + This method will retrieve the list of GBO age profiles. + parameters: [] + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GboAgeProfileList' + description: A list of GBO age profiles + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: Get the list of required personal attribute . + tags: + - ABTProductReference CRUD + /productreferences: + get: + description: gives list of all possible product reference values availbale + parameters: [] + responses: + "200": + content: + application/json: + example: + Entries: + clientAttributes: + type: array + items: + type: object + properties: + - clientAttributeId: 1 + clientId: htm + description: description + isActive: "true" + retailerId: 1 + salesTouchpointId: 2 + productOwners: + - productOwnerId: 123 + name: name + organization: org + productCategories: + - isTravelProduct: true + name: name + productCategoryId: 21 + customerSegments: + - name: name + customerSegmentId: 123 + marketSegments: + - name: name + marketSegmentId: 123 + paymentMoments: + - paymentMomentId: 123 + name: name + retailers: + - name: name + street: StreetName + number: "12" + numberAddition: E + postalCode: 2222 BV + city: Amsterdam + country: NL + emailAddress: sample@email.com + phoneNumber: "6123456789" + taxId: taxId + imageReference: imageReference + retailerId: 123 + salesTouchpoints: + - isActive: true + name: name + retailerId: 21 + salesTouchPointId: 123 + serviceOptions: + - action: action + description: description + serviceOptionId: 123 + mandatoryCustomerDataItems: + - mandatoryCustomerDataItemId: 123 + customerDataItem: customerDataItem + requiredCustomerLevels: + - requiredCustomerLevelId: 123 + name: requiredCustomerLevel + forbiddenPaymentMethods: + - forbiddenPaymentMethodId: 123 + name: requiredCustomerLevel + issuer: Kane + requiredGboPersonalAttributes: + - requiredGboPersonalAttributeId: 123 + name: requiredCustomerLevel + schema: + $ref: '#/components/schemas/_productreferences_get_200_response' + description: Successful retrieved list of all possible product reference + values + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + description: Bad Request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' + description: Internal Server Error + summary: List of all possible product reference values + tags: + - ABTProductReference CRUD +components: + schemas: + clientAttribute: + properties: + clientId: + example: htm + type: string + description: + example: description + type: string + isActive: + example: "true" + type: string + retailerId: + example: 1 + type: integer + salesTouchpointId: + example: 2 + type: integer + type: object + clientAttributesGetList: + items: + $ref: '#/components/schemas/clientAttributesGetList_inner' + type: array + clientAttributesGetEntity: + example: + Entries: + - clientId: htm + description: description + clientAttributeId: 1 + isActive: "true" + retailerId: 1 + salesTouchpointId: 2 + - clientId: htm + description: description + clientAttributeId: 1 + isActive: "true" + retailerId: 1 + salesTouchpointId: 2 + properties: + Entries: + items: + $ref: '#/components/schemas/clientAttributesGetList_inner' + type: array + type: object + clientAttributesPostEntity: + properties: + clientId: + example: htm + type: string + description: + example: description + type: string + isActive: + example: true + type: boolean + retailerId: + example: 1 + type: integer + salesTouchpointId: + example: 2 + type: integer + type: object + clientAttributesPutEntity: + properties: + description: + example: description + type: string + isActive: + example: true + type: boolean + retailerId: + example: 1 + type: integer + clientId: + example: retailer001 + type: string + salesTouchpointId: + example: 1 + type: integer + type: object + productOwner: + properties: + organization: + example: org + type: string + name: + example: name + type: string + type: object + productOwnerIdList: + items: + $ref: '#/components/schemas/productOwnerIdList_inner' + type: array + productOwners: + example: + Entries: + - productOwnerId: 123 + organization: org + name: name + - productOwnerId: 123 + organization: org + name: name + properties: + Entries: + items: + $ref: '#/components/schemas/productOwnerIdList_inner' + type: array + type: object + productCategory: + properties: + isTravelProduct: + example: true + type: boolean + name: + example: name + type: string + type: object + productCategoryIdList: + items: + $ref: '#/components/schemas/productCategoryIdList_inner' + type: array + productCategories: + example: + Entries: + - productCategoryId: 21 + name: name + isTravelProduct: true + - productCategoryId: 21 + name: name + isTravelProduct: true + properties: + Entries: + items: + $ref: '#/components/schemas/productCategoryIdList_inner' + type: array + type: object + customerSegment: + properties: + name: + example: name + type: string + type: object + customerSegmentIdList: + items: + $ref: '#/components/schemas/customerSegmentIdList_inner' + type: array + customerSegments: + example: + Entries: + - name: name + customerSegmentId: 123 + - name: name + customerSegmentId: 123 + properties: + Entries: + items: + $ref: '#/components/schemas/customerSegmentIdList_inner' + type: array + type: object + paymentMoment: + properties: + results: + $ref: '#/components/schemas/paymentMoment_results' + paymentMomentIdList: + items: + $ref: '#/components/schemas/paymentMoment_results' + type: array + paymentMoments: + example: + Entries: + - paymentMomentId: 123 + name: name + - paymentMomentId: 123 + name: name + properties: + Entries: + items: + $ref: '#/components/schemas/paymentMoment_results' + type: array + type: object + marketSegment: + properties: + name: + example: name + type: string + marketSegmentIdList: + items: + $ref: '#/components/schemas/marketSegmentIdList_inner' + type: array + marketSegments: + example: + Entries: + - name: name + marketSegmentId: 123 + - name: name + marketSegmentId: 123 + properties: + Entries: + items: + $ref: '#/components/schemas/marketSegmentIdList_inner' + type: array + type: object + retailer: + properties: + name: + example: name + type: string + street: + example: StreetName + type: string + number: + example: "12" + type: string + numberAddition: + example: E + type: string + postalCode: + example: 2222 BV + type: string + city: + example: Amsterdam + type: string + country: + example: NL + type: string + emailAddress: + example: sample@email.com + type: string + phoneNumber: + example: "6123456789" + type: string + taxId: + example: taxId + type: string + imageReference: + example: imageReference + type: string + retailerIdList: + items: + $ref: '#/components/schemas/retailerIdList_inner' + type: array + retailers: + example: + Entries: + - number: "12" + country: NL + emailAddress: sample@email.com + phoneNumber: "6123456789" + city: Amsterdam + street: StreetName + taxId: taxId + postalCode: 2222 BV + name: name + numberAddition: E + imageReference: imageReference + retailerId: 123 + - number: "12" + country: NL + emailAddress: sample@email.com + phoneNumber: "6123456789" + city: Amsterdam + street: StreetName + taxId: taxId + postalCode: 2222 BV + name: name + numberAddition: E + imageReference: imageReference + retailerId: 123 + properties: + Entries: + items: + $ref: '#/components/schemas/retailerIdList_inner' + type: array + type: object + salesTouchpoint: + properties: + isActive: + example: true + type: boolean + name: + example: name + type: string + retailerId: + example: 21 + type: integer + type: object + salesTouchpointIdList: + items: + $ref: '#/components/schemas/salesTouchpointIdList_inner' + type: array + salesTouchpoints: + example: + Entries: + - name: name + isActive: true + retailerId: 21 + salesTouchpointId: 123 + - name: name + isActive: true + retailerId: 21 + salesTouchpointId: 123 + properties: + Entries: + items: + $ref: '#/components/schemas/salesTouchpointIdList_inner' + type: array + type: object + serviceOption: + properties: + action: + example: action + type: string + description: + example: description + type: string + type: object + serviceOptionIdList: + items: + $ref: '#/components/schemas/serviceOptionIdList_inner' + type: array + serviceOptions: + example: + Entries: + - serviceOptionId: 123 + action: action + description: description + - serviceOptionId: 123 + action: action + description: description + properties: + Entries: + items: + $ref: '#/components/schemas/serviceOptionIdList_inner' + type: array + type: object + mandatoryCustomerDataItem: + properties: + customerDataItem: + example: customerDataItem + type: string + type: object + mandatoryCustomerDataItemIdList: + items: + $ref: '#/components/schemas/mandatoryCustomerDataItemIdList_inner' + type: array + mandatoryCustomerDataItems: + example: + Entries: + - mandatoryCustomerDataItemId: 1 + customerDataItem: birthname + - mandatoryCustomerDataItemId: 1 + customerDataItem: birthname + properties: + Entries: + items: + $ref: '#/components/schemas/mandatoryCustomerDataItemIdList_inner' + type: array + type: object + requiredCustomerLevelIdList: + items: + $ref: '#/components/schemas/requiredCustomerLevelIdList_inner' + type: array + requiredCustomerLevels: + example: + Entries: + - requiredCustomerLevelId: 123 + name: requiredCustomerLevel + - requiredCustomerLevelId: 123 + name: requiredCustomerLevel + properties: + Entries: + items: + $ref: '#/components/schemas/requiredCustomerLevelIdList_inner' + type: array + type: object + forbiddenPaymentMethodList: + items: + $ref: '#/components/schemas/forbiddenPaymentMethodList_inner' + type: array + getforbiddenPaymentMethodList: + example: + Entries: + - forbiddenPaymentMethodId: 123 + name: requiredCustomerLevel + issuer: Kane + - forbiddenPaymentMethodId: 123 + name: requiredCustomerLevel + issuer: Kane + properties: + Entries: + items: + $ref: '#/components/schemas/forbiddenPaymentMethodList_inner' + type: array + type: object + GetRequiredGboPersonalAttribute: + items: + $ref: '#/components/schemas/GetRequiredGboPersonalAttribute_inner' + type: array + requiredGboPersonalAttributes: + example: + Entries: + - name: NAME + requiredGboPersonalAttributeId: 1 + - name: BIRTHDATE + requiredGboPersonalAttributeId: 2 + - name: PHOTO + requiredGboPersonalAttributeId: 3 + properties: + Entries: + items: + $ref: '#/components/schemas/GetRequiredGboPersonalAttribute_inner' + type: array + type: object + GboAgeProfileList: + items: + $ref: '#/components/schemas/GboAgeProfile' + type: array + example: + Entries: + - gboAgeProfileId: 1 + name: Kind (0 t/m 3 jaar) + ageFromInclusive: 0 + ageToInclusive: 3 + - gboAgeProfileId: 2 + name: Kind (4 t/m 11 jaar) + ageFromInclusive: 4 + ageToInclusive: 11 + - gboAgeProfileId: 3 + name: Jongere (12 t/m 18 jaar) + ageFromInclusive: 12 + ageToInclusive: 18 + - gboAgeProfileId: 4 + name: Volwassene (19 t/m 64 jaar) + ageFromInclusive: 19 + ageToInclusive: 64 + - gboAgeProfileId: 5 + name: Oudere (65 jaar of ouder) + ageFromInclusive: 65 + ageToInclusive: 999 + GboAgeProfile: + type: object + required: + - gboAgeProfileId + - name + - ageFromInclusive + - ageToInclusive + properties: + gboAgeProfileId: + type: integer + example: 1 + name: + type: string + example: Kind (4 t/m 11 jaar) + ageFromInclusive: + type: integer + description: The minimum age that the GBO age profile applies to + example: 4 + ageToInclusive: + type: integer + description: The maximum age that the GBO age profile applies to + example: 11 + GetproductReferences: + properties: + Entries: + $ref: '#/components/schemas/GetproductReferences_Entries' + type: object + "400Response": + properties: + code: + example: "400" + type: string + type: + type: string + message: + example: Bad Request + type: string + description: + example: '''2023-02-01 00:00:00'' is not a valid Datetime' + type: string + type: object + "401Response": + properties: + code: + example: "900901" + type: string + type: + type: string + message: + example: Invalid Credentials + type: string + description: + example: Invalid Credentials. Make sure you have provided the correct security + credentials + type: string + type: object + "404Response": + properties: + code: + example: "404" + type: string + type: + example: Status report + type: string + message: + example: Not Found + type: string + description: + example: The requested resource is not available. + type: string + type: object + "404ResponseId": + properties: + error: + example: "No record found for id: 5" + type: string + type: object + "409Response": + properties: + error: + example: Entry already exists + type: string + type: object + "500Response": + properties: + code: + example: "500" + type: string + type: + type: string + message: + example: Internal Server Error + type: string + description: + type: string + type: object + _clientattributes_post_201_response: + example: + id: 1 + properties: + id: + example: 1 + type: integer + type: object + _clientattributes__clientAttributeId__put_404_response: + oneOf: + - $ref: '#/components/schemas/404ResponseId' + - $ref: '#/components/schemas/404Response' + _productreferences_get_200_response: + allOf: + - $ref: '#/components/schemas/GetproductReferences' + clientAttributesGetList_inner: + example: + clientId: htm + description: description + clientAttributeId: 1 + isActive: "true" + retailerId: 1 + salesTouchpointId: 2 + properties: + clientAttributeId: + example: 1 + type: integer + clientId: + example: htm + type: string + description: + example: description + type: string + isActive: + example: "true" + type: string + retailerId: + example: 1 + type: integer + salesTouchpointId: + example: 2 + type: integer + productOwnerIdList_inner: + example: + productOwnerId: 123 + organization: org + name: name + properties: + productOwnerId: + example: 123 + type: integer + name: + example: name + type: string + organization: + example: org + type: string + productCategoryIdList_inner: + example: + productCategoryId: 21 + name: name + isTravelProduct: true + properties: + isTravelProduct: + example: true + type: boolean + name: + example: name + type: string + productCategoryId: + example: 21 + type: integer + customerSegmentIdList_inner: + example: + name: name + customerSegmentId: 123 + properties: + name: + example: name + type: string + customerSegmentId: + example: 123 + type: integer + paymentMoment_results: + example: + paymentMomentId: 123 + name: name + properties: + paymentMomentId: + example: 123 + type: integer + name: + example: name + type: string + marketSegmentIdList_inner: + example: + name: name + marketSegmentId: 123 + properties: + name: + example: name + type: string + marketSegmentId: + example: 123 + type: integer + retailerIdList_inner: + example: + number: "12" + country: NL + emailAddress: sample@email.com + phoneNumber: "6123456789" + city: Amsterdam + street: StreetName + taxId: taxId + postalCode: 2222 BV + name: name + numberAddition: E + imageReference: imageReference + retailerId: 123 + properties: + name: + example: name + type: string + street: + example: StreetName + type: string + number: + example: "12" + type: string + numberAddition: + example: E + type: string + postalCode: + example: 2222 BV + type: string + city: + example: Amsterdam + type: string + country: + example: NL + type: string + emailAddress: + example: sample@email.com + type: string + phoneNumber: + example: "6123456789" + type: string + taxId: + example: taxId + type: string + imageReference: + example: imageReference + type: string + retailerId: + example: 123 + type: integer + salesTouchpointIdList_inner: + example: + name: name + isActive: true + retailerId: 21 + salesTouchpointId: 123 + properties: + isActive: + example: true + type: boolean + name: + example: name + type: string + retailerId: + example: 21 + type: integer + salesTouchpointId: + example: 123 + type: integer + serviceOptionIdList_inner: + example: + serviceOptionId: 123 + action: action + description: description + properties: + action: + example: action + type: string + description: + example: description + type: string + serviceOptionId: + example: 123 + type: integer + mandatoryCustomerDataItemIdList_inner: + example: + mandatoryCustomerDataItemId: 1 + customerDataItem: birthname + properties: + mandatoryCustomerDataItemId: + example: 1 + type: integer + customerDataItem: + example: birthname + type: string + requiredCustomerLevelIdList_inner: + example: + requiredCustomerLevelId: 123 + name: requiredCustomerLevel + properties: + requiredCustomerLevelId: + example: 123 + type: integer + name: + example: requiredCustomerLevel + type: string + forbiddenPaymentMethodList_inner: + example: + forbiddenPaymentMethodId: 123 + name: requiredCustomerLevel + issuer: Kane + properties: + forbiddenPaymentMethodId: + example: 123 + type: integer + name: + example: CreditCard + type: string + issuer: + example: American Express + type: string + type: object + GetRequiredGboPersonalAttribute_inner: + example: + requiredGboPersonalAttributeId: 1 + name: NAME + properties: + requiredGboPersonalAttributeId: + example: 1 + type: integer + name: + example: NAME + type: string + type: object + GetproductReferences_Entries: + oneOf: + - $ref: '#/components/schemas/clientAttributesGetEntity' + - $ref: '#/components/schemas/productOwners' + - $ref: '#/components/schemas/productCategories' + - $ref: '#/components/schemas/customerSegments' + - $ref: '#/components/schemas/marketSegments' + - $ref: '#/components/schemas/paymentMoments' + - $ref: '#/components/schemas/retailers' + - $ref: '#/components/schemas/salesTouchpoints' + - $ref: '#/components/schemas/serviceOptions' + - $ref: '#/components/schemas/mandatoryCustomerDataItems' + - $ref: '#/components/schemas/requiredCustomerLevels' + - $ref: '#/components/schemas/getforbiddenPaymentMethodList' + - $ref: '#/components/schemas/requiredGboPersonalAttributes' + - $ref: '#/components/schemas/GboAgeProfileList' \ No newline at end of file diff --git a/src/openapi/products/products-crud-v2.2.yaml b/src/openapi/products/products-crud.yaml similarity index 91% rename from src/openapi/products/products-crud-v2.2.yaml rename to src/openapi/products/products-crud.yaml index dfdd8f1..493e49e 100644 --- a/src/openapi/products/products-crud-v2.2.yaml +++ b/src/openapi/products/products-crud.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: ABTProducts description: >- - CRUD APIs for HTM products (based on the new domainmodel v2.2). Internal use + CRUD APIs for HTM products (based on the new domainmodel v2.4). Internal use only; external touchpoints can get read-only, filtered access via the HTM Service Engine, using a different endpoint. version: '1.0' @@ -60,7 +60,6 @@ paths: "Entries": [ { "productId": 1, - "productCode": "30901-WL", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "productCategory": { @@ -89,7 +88,6 @@ paths: "Entries": [ { "productId": 2, - "productCode": "312AB-WL", "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { @@ -118,7 +116,6 @@ paths: "Entries": [ { "productId": 2, - "productCode": "312AB-WL", "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { @@ -145,7 +142,6 @@ paths: "Entries": [ { "productId": 1, - "productCode": "30901-WL", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "productCategory": { @@ -166,7 +162,6 @@ paths: }, { "productId": 2, - "productCode": "312AB-WL", "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { @@ -187,7 +182,6 @@ paths: }, { "productId": 3, - "productCode": "30001-ML", "productName": "HTM 20% korting", "productDescription": "Reis een maand lang met 20% korting!", "productCategory": { @@ -211,7 +205,6 @@ paths: }, { "productId": 4, - "productCode": "30002-ML", "productName": "HTM 40% korting", "productDescription": "Reis een maand lang met 40% korting!", "productCategory": { @@ -243,7 +236,6 @@ paths: "Entries": [ { "productId": 2, - "productCode": "312AB-WL", "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { @@ -262,7 +254,6 @@ paths: }, { "productId": 4, - "productCode": "30002-ML", "productName": "HTM 40% korting", "productDescription": "Reis een maand lang met 40% korting!", "productCategory": { @@ -343,7 +334,7 @@ paths: summary: Add new GBO product (non-renewable) value: { - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", @@ -363,10 +354,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 1, "requiredCustomerLevelId": 1, @@ -402,8 +395,9 @@ paths: "sellingPrices": [ { "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 @@ -414,8 +408,9 @@ paths: "purchasePrices": [ { "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999" } @@ -427,7 +422,7 @@ paths: sellingPeriods/prices per period) value: { - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", @@ -447,10 +442,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 1, "requiredCustomerLevelId": 1, @@ -486,16 +483,18 @@ paths: "sellingPrices": [ { "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 }, { "amountExclTax": 101, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 110, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2025-01-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999", "internalPrice": 101.0000 @@ -509,16 +508,18 @@ paths: "sellingPrices": [ { "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 }, { "amountExclTax": 101, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 110, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2025-01-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999", "internalPrice": 101.0000 @@ -529,8 +530,9 @@ paths: "purchasePrices": [ { "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999" } @@ -542,7 +544,7 @@ paths: forbiddenPaymentMethods) value: { - "productCode": "35301-MA", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "35301", "productName": "HTM Regio Vrij DH73", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", @@ -562,10 +564,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 3, "requiredCustomerLevelId": 3, @@ -623,8 +627,9 @@ paths: "sellingPrices": [ { "amountExclTax": 5413, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 5900, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 5413.0000 @@ -635,8 +640,9 @@ paths: "purchasePrices": [ { "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999" } @@ -724,10 +730,9 @@ paths: { "productId": 1, "parentProductId": null, - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "validityPeriod": { @@ -755,20 +760,26 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "customerSegmentId": 6, + "name": "Student" }, { - "customerSegmentId": 3, - "name": "Jongere (12-17)" + "customerSegmentId": 7, + "name": "Ooievaarspas-gerechtigde" + } + ], + "allowedGboAgeProfiles": [ + { + "gboAgeProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageUntilInclusive": 11 }, { - "customerSegmentId": 4, - "name": "Volwassene (18-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" + "gboAgeProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageUntilInclusive": 18 } ], "productCategory": { @@ -849,13 +860,9 @@ paths: { "sellingPriceId": 1, "amountExclTax": 92, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - }, "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2024-12-31T23:59:59.999+00:00", "internalPrice": 92.0000 @@ -867,12 +874,8 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", - "taxCode": "V0", - "taxPercentageAmount": 0, - "description": "BTW VERKOOP NUL" - }, + "taxCode": "V09", + "taxPercentage": 9.0000, "amountInclTax": 0, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2024-12-31T23:59:59.999+00:00" @@ -899,10 +902,9 @@ paths: { "productId": 2, "parentProductId": null, - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", "validityPeriod": { @@ -930,20 +932,26 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "customerSegmentId": 6, + "name": "Student" }, { - "customerSegmentId": 3, - "name": "Jongere (12-17)" + "customerSegmentId": 7, + "name": "Ooievaarspas-gerechtigde" + } + ], + "allowedGboAgeProfiles": [ + { + "gboAgeProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageUntilInclusive": 11 }, { - "customerSegmentId": 4, - "name": "Volwassene (18-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" + "gboAgeProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageUntilInclusive": 18 } ], "productCategory": { @@ -1024,12 +1032,8 @@ paths: { "sellingPriceId": 1, "amountExclTax": 92, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - }, + "taxCode": "V09", + "taxPercentage": 9.0000, "amountInclTax": 100, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2024-12-31T23:59:59.999+00:00", @@ -1038,12 +1042,8 @@ paths: { "sellingPriceId": 2, "amountExclTax": 101, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - }, + "taxCode": "V09", + "taxPercentage": 9.0000, "amountInclTax": 110, "fromInclusive": "2025-01-01T00:00:00.000+00:00", "toInclusive": "2025-12-31T23:59:59.999+00:00", @@ -1079,13 +1079,9 @@ paths: { "sellingPriceId": 3, "amountExclTax": 92, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - }, "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2024-12-31T23:59:59.999+00:00", "internalPrice": 92.0000 @@ -1093,13 +1089,9 @@ paths: { "sellingPriceId": 4, "amountExclTax": 101, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - }, "amountInclTax": 110, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2025-01-01T00:00:00.000+00:00", "toInclusive": "2025-12-31T23:59:59.999+00:00", "internalPrice": 101.0000 @@ -1111,13 +1103,9 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", - "taxCode": "V0", - "taxPercentageAmount": 0, - "description": "BTW VERKOOP NUL" - }, "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2025-12-31T23:59:59.999+00:00" } @@ -1143,10 +1131,9 @@ paths: { "productId": 3, "parentProductId": null, - "productCode": "35301-MA", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "35301", "tapConnectProductCode": null, - "productGroupMetadata": null, "productName": "HTM Regio Vrij DH73", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", "validityPeriod": { @@ -1174,20 +1161,26 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 2, - "name": "Kind (4-11)" + "customerSegmentId": 6, + "name": "Student" }, { - "customerSegmentId": 3, - "name": "Jongere (12-17)" + "customerSegmentId": 7, + "name": "Ooievaarspas-gerechtigde" + } + ], + "allowedGboAgeProfiles": [ + { + "gboAgeProfileId": 2, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageUntilInclusive": 11 }, { - "customerSegmentId": 4, - "name": "Volwassene (18-64)" - }, - { - "customerSegmentId": 5, - "name": "Oudere (65+)" + "gboAgeProfileId": 3, + "name": "Jongere (12 t/m 18 jaar)", + "ageFromInclusive": 12, + "ageUntilInclusive": 18 } ], "productCategory": { @@ -1314,13 +1307,9 @@ paths: { "sellingPriceId": 5, "amountExclTax": 5413, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", - "taxCode": "V09", - "taxPercentageAmount": 9, - "description": "BTW VERKOOP LAAG 9%" - }, "amountInclTax": 5900, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2024-12-31T23:59:59.999+00:00", "internalPrice": 5413.0000 @@ -1332,12 +1321,8 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadata": { - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", - "taxCode": "V0", - "taxPercentageAmount": 0, - "description": "BTW VERKOOP NUL" - }, + "taxCode": "V09", + "taxPercentage": 9.0000, "amountInclTax": 0, "fromInclusive": "2024-09-01T00:00:00.000+00:00", "toInclusive": "2024-12-31T23:59:59.999+00:00" @@ -1440,7 +1425,7 @@ paths: summary: Update existing GBO product (non-renewable) value: { - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", @@ -1461,10 +1446,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 1, "requiredCustomerLevelId": 1, @@ -1502,8 +1489,9 @@ paths: { "sellingPriceId": 1, "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 @@ -1515,8 +1503,9 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999" } @@ -1528,7 +1517,7 @@ paths: add new second sellingPeriod) value: { - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", @@ -1549,10 +1538,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 1, "requiredCustomerLevelId": 1, @@ -1587,7 +1578,8 @@ paths: { "sellingPriceId": 1, "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", + "taxCode": "V09", + "taxPercentage": 9.0000, "amountInclTax": 100, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", @@ -1602,16 +1594,18 @@ paths: "sellingPrices": [ { "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 }, { "amountExclTax": 101, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 110, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2025-01-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999", "internalPrice": 101.0000 @@ -1623,8 +1617,9 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999" } @@ -1636,7 +1631,7 @@ paths: sellingPeriods/prices per period) value: { - "productCode": "30901-WL", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "30901", "productName": "HTM pilot 90% korting", "productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!", @@ -1657,10 +1652,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 1, "requiredCustomerLevelId": 1, @@ -1698,8 +1695,9 @@ paths: { "sellingPriceId": 1, "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 @@ -1707,8 +1705,9 @@ paths: { "sellingPriceId": 2, "amountExclTax": 101, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 110, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2025-01-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999", "internalPrice": 101.0000 @@ -1724,8 +1723,9 @@ paths: { "sellingPriceId": 3, "amountExclTax": 92, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 100, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 92.0000 @@ -1733,8 +1733,9 @@ paths: { "sellingPriceId": 4, "amountExclTax": 101, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 110, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2025-01-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999", "internalPrice": 101.0000 @@ -1746,8 +1747,9 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2025-12-31T23:59:59.999" } @@ -1759,7 +1761,7 @@ paths: serviceOptions, forbiddenPaymentMethods) value: { - "productCode": "35301-MA", + "fikoArticleNumber": "1234", "gboPackageTemplateId": "35301", "productName": "HTM Regio Vrij DH73", "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.", @@ -1780,10 +1782,12 @@ paths: 1 ], "customerSegmentIds": [ - 2, - 3, - 4, - 5 + 6, + 7 + ], + "allowedGboAgeProfileIds": [ + 1, + 2 ], "productCategoryId": 3, "requiredCustomerLevelId": 3, @@ -1843,8 +1847,9 @@ paths: { "sellingPriceId": 1, "amountExclTax": 5413, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E", "amountInclTax": 5900, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999", "internalPrice": 5413.0000 @@ -1856,8 +1861,9 @@ paths: { "purchasePriceId": 1, "amountExclTax": 0, - "taxMetadataId": "501B17EF-36C4-4039-B92C-6517969B464F", "amountInclTax": 0, + "taxCode": "V09", + "taxPercentage": 9.0000, "fromInclusive": "2024-09-01T00:00:00.000", "toInclusive": "2024-12-31T23:59:59.999" } @@ -1914,26 +1920,28 @@ paths: $ref: '#/components/schemas/500Response' components: schemas: - TaxMetadataResponse: + GboAgeProfileResponse: type: object required: - - taxMetadataId - - taxCode - - taxPercentageAmount + - gboAgeProfileId + - name + - ageFromInclusive + - ageUntilInclusive properties: - taxMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - taxCode: - type: string - example: V09 - taxPercentageAmount: + gboAgeProfileId: type: integer - example: 21 - description: + example: 1 + name: type: string - example: BTW VERKOOP LAAG 9% + example: Kind (4 t/m 11 jaar) + ageFromInclusive: + type: integer + description: The minimum age that the GBO age profile applies to + example: 4 + ageUntilInclusive: + type: integer + description: The maximum age that the GBO age profile applies to + example: 11 ProductTranslationResponse: type: object required: @@ -1955,7 +1963,8 @@ components: required: - sellingPriceId - amountExclTax - - taxMetadata + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -1967,8 +1976,12 @@ components: amountExclTax: type: integer example: 750 - taxMetadata: - $ref: '#/components/schemas/TaxMetadataResponse' + taxCode: + type: string + example: 'V09' + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 @@ -1988,7 +2001,6 @@ components: required: - purchasePriceId - amountExclTax - - taxMetadata - amountInclTax - fromInclusive - toInclusive @@ -1999,8 +2011,12 @@ components: amountExclTax: type: integer example: 750 - taxMetadata: - $ref: '#/components/schemas/TaxMetadataResponse' + taxCode: + type: string + example: 'V09' + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 @@ -2087,9 +2103,6 @@ components: productId: type: integer example: 1 - productCode: - type: string - example: 30901-WL productName: type: string example: HTM pilot 90% korting @@ -2157,66 +2170,16 @@ components: parentProductId: type: integer example: 1 - productCode: + fikoArticleNumber: type: string - example: 30901-WL + description: The article number of the product in FIKO + example: 1234 gboPackageTemplateId: type: string example: '30901' tapConnectProductCode: type: string example: 1234AB - productGroupMetadata: - type: object - required: - - productGroupMetadataId - - productGroupCode - - department - - costCenter - - costType - - description - - documentCode - - user - - timestampUpdated - - validFrom - properties: - productGroupMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E - productGroupCode: - type: string - example: TBD - department: - type: string - example: TBD - costCenter: - type: string - example: TBD - costType: - type: string - example: TBD - description: - type: string - example: TBD - documentCode: - type: string - example: TBD - user: - type: string - example: TBD - timestampUpdated: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validFrom: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' - validUntil: - type: string - format: date-time-offset - example: '2024-09-03T10:01:34.000+00:00' productName: type: string example: HTM pilot 90% korting @@ -2288,6 +2251,11 @@ components: name: type: string example: Kind (4-11) + allowedGboAgeProfiles: + type: array + items: + type: object + $ref: '#/components/schemas/GboAgeProfileResponse' productCategory: type: object required: @@ -2548,10 +2516,10 @@ components: type: integer description: The ID of the parent product (if any) example: 1 - productCode: + fikoArticleNumber: type: string - description: The HTM-internal product code - example: 30901-WL + description: The article number of the product in FIKO + example: 1234 gboPackageTemplateId: type: string description: >- @@ -2564,11 +2532,6 @@ components: The productCode of the TapConnect product that should be issued after buying this product example: 1234AB - productGroupMetadataId: - type: string - format: uuid - description: The ID of the productGroupMetadata for administration in U4F - example: 501B17EF-36C4-4039-B92C-6517969B464E productName: type: string description: The name of the product @@ -2635,6 +2598,12 @@ components: items: type: integer example: 1 + allowedGboAgeProfileIds: + type: array + description: The IDs of the allowed GBO age profiles + items: + type: integer + example: 1 productCategoryId: type: integer description: The ID of the category the product belongs to @@ -2823,7 +2792,8 @@ components: type: object required: - amountExclTax - - taxMetadataId + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -2832,10 +2802,12 @@ components: amountExclTax: type: integer example: 750 - taxMetadataId: + taxCode: type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E + example: 'V09' + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 @@ -2865,7 +2837,8 @@ components: type: object required: - amountExclTax - - taxMetadataId + - taxCode + - taxPercentage - amountInclTax - fromInclusive - toInclusive @@ -2873,10 +2846,12 @@ components: amountExclTax: type: integer example: 750 - taxMetadataId: + taxCode: type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E + example: 'V09' + taxPercentage: + type: number + example: 9.0000 amountInclTax: type: integer example: 908 @@ -2907,10 +2882,10 @@ components: type: integer description: The ID of the parent product (if any) example: 1 - productCode: + fikoArticleNumber: type: string - description: The HTM-internal product code - example: 30901-WL + description: The article number of the product in FIKO + example: 1234 gboPackageTemplateId: type: string description: >- @@ -2923,11 +2898,6 @@ components: The productCode of the TapConnect product that should be issued after buying this product example: 1234AB - productGroupMetadataId: - type: string - format: uuid - description: The ID of the productGroupMetadata for administration in U4F - example: 501B17EF-36C4-4039-B92C-6517969B464E productName: type: string description: The name of the product @@ -3001,6 +2971,12 @@ components: items: type: integer example: 1 + allowedGboAgeProfileIds: + type: array + description: The IDs of the allowed GBO age profiles + items: + type: integer + example: 1 productCategoryId: type: integer description: The ID of the category the product belongs to @@ -3196,8 +3172,9 @@ components: type: object required: - amountExclTax - - taxMetadataId - amountInclTax + - taxCode + - taxPercentage - fromInclusive - toInclusive - internalPrice @@ -3212,13 +3189,15 @@ components: amountExclTax: type: integer example: 750 - taxMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E amountInclTax: type: integer example: 908 + taxCode: + type: string + example: V09 + taxPercentage: + type: number + example: 9.0000 fromInclusive: type: string format: date-time @@ -3245,8 +3224,9 @@ components: type: object required: - amountExclTax - - taxMetadataId - amountInclTax + - taxCode + - taxPercentage - fromInclusive - toInclusive properties: @@ -3260,13 +3240,15 @@ components: amountExclTax: type: integer example: 750 - taxMetadataId: - type: string - format: uuid - example: 501B17EF-36C4-4039-B92C-6517969B464E amountInclTax: type: integer example: 908 + taxCode: + type: string + example: V09 + taxPercentage: + type: number + example: 9.0000 fromInclusive: type: string format: date-time