From 323f1c195c7ddb1de55534031f78be284319c5b8 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 28 Apr 2025 10:38:30 +0200 Subject: [PATCH] review commentaar --- src/openapi/orders/service_engine_orders.yaml | 361 +++++++++--------- 1 file changed, 174 insertions(+), 187 deletions(-) diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 86cb0bf..64f8fb6 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -808,7 +808,7 @@ paths: description: xTat used in order fulfillment. Note that this is a joined parameter via PurchasedProduct. tags: - Order Retrieval v1 & v2 - summary: Find orders. P3 + summary: Find orders. P1 description: Find orders. responses: "200": @@ -919,128 +919,128 @@ paths: }, }, { - "validContents": false, - "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", - "externalOrderId": null, - "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "totalAmount": 121, - "touchPoint": - { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailerId": 1001, - }, - "language": - { - "languageId": 1, - "name": "Nederlands", - "iso639Code": "nl-NL", - "ietfCode": "nl", - }, - "createdOn": "2024-03-22T09:00:00", - "lastUpdatedOn": "2024-03-22T09:00:00", - "order_OrderStatuses": - [ - { - "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": - { "orderStatusId": 1, "name": "concept" }, - "createdOn": "2024-03-22T09:00:00", - "description": "Order is aangemaakt", - }, - ], - "orderLines": - [ - { - "orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", - "externalOrderLineId": null, - "productId": 1, - "productName": "HTM Maandkorting 20%", - "fikoArticleNumber": "6609", - "productDescription": "HTM Maandkorting 20%", - "taxCode": "V21", - "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, - "amountInclTax": 121, - "quantity": 1, - "orderLineTerms": - [ - { - "orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", - "termsUrl": "generalTermsAndConditions.pdf", - }, - { - "orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87", - "termsUrl": "productTermsAndConditions.pdf", - }, - ], - "createdOn": "2024-03-22T09:00:00", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - "orderLineStatus": - { "orderLineStatusId": 1, "name": "pending" }, - "customerTokens": - [ - { - "customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e", - "tokenType": - { "tokenTypeId": 1, "name": "EMV" }, - "ovPayTokenId": 1, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 34, - "ovpasNumber": "OV34567", - "verificationCode": "A7H6", - "personalAccountData": + "validContents": false, + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, + "language": + { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl", + }, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatuses": + [ + { + "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, + "createdOn": "2024-03-22T09:00:00", + "description": "Order is aangemaakt", + }, + ], + "orderLines": + [ + { + "orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", + "externalOrderLineId": null, + "productId": 1, + "productName": "HTM Maandkorting 20%", + "fikoArticleNumber": "6609", + "productDescription": "HTM Maandkorting 20%", + "taxCode": "V21", + "taxPercentage": 21.0000, + "taxAmount": 21, + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "orderLineTerms": + [ { - "personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47", - "name": "Jan de Vries", - "birthdate": "01-01-1970", - "photo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAAWJLR0Q+SWQA4wAAAAd0SU1FB+YCBAwmK58TFQgAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjItMDItMDRUMTI6Mzg6NDMrMDA6MDBAjYOrAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIyLTAyLTA0VDEyOjM4OjQzKzAwOjAwMdA7FwAAAFd6VFh0UmF3IHByb2ZpbGUgdHlwZSBpcHRjAAB4nOPyDAhxVigoyk/LzEnlUgADIwsuYwsTIxNLkxQDEyBEgDTDZAMjs1Qgy9jUyMTMxBzEB8uASKBKLgDqFxF08kI1lQAAAYdpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0n77u/JyBpZD0nVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkJz8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIj48cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPjx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+PC9yZGY6RGVzY3JpcHRpb24+PC9yZGY6UkRGPjwveDp4bXBtZXRhPg0KPD94cGFja2V0IGVuZD0ndyc/PiyUmAsAAAANSURBVBhXY3grk/YfAAXYAm/HQierAAAAAElFTkSuQmCC", - "challengeType": - { - "challengeTypeId": 1, - "name": "email", - }, - "oneTimePassword": "H5Iiz3JTaQeIV8p", + "orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", + "termsUrl": "generalTermsAndConditions.pdf", }, - }, - ], - "orderAccountingStatuses": [], - "validationResult": false, - "additionalRemarks": - [ - { - "code": "MANDATE_REQUIRED", - "parameter": "directDebitMandateId", - }, - ], - "validationErrors": - [ - { - "detail": "Startdate of this product should be at most 60 days in the future.", - "pointer": "#/0/startDate", - }, - ], - }, + { + "orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87", + "termsUrl": "productTermsAndConditions.pdf", + }, + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "customerTokens": + [ + { + "customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e", + "tokenType": + { "tokenTypeId": 1, "name": "EMV" }, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47", + "name": "Jan de Vries", + "birthdate": "01-01-1970", + "photo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAAWJLR0Q+SWQA4wAAAAd0SU1FB+YCBAwmK58TFQgAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjItMDItMDRUMTI6Mzg6NDMrMDA6MDBAjYOrAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIyLTAyLTA0VDEyOjM4OjQzKzAwOjAwMdA7FwAAAFd6VFh0UmF3IHByb2ZpbGUgdHlwZSBpcHRjAAB4nOPyDAhxVigoyk/LzEnlUgADIwsuYwsTIxNLkxQDEyBEgDTDZAMjs1Qgy9jUyMTMxBzEB8uASKBKLgDqFxF08kI1lQAAAYdpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0n77u/JyBpZD0nVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkJz8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIj48cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPjx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+PC9yZGY6RGVzY3JpcHRpb24+PC9yZGY6UkRGPjwveDp4bXBtZXRhPg0KPD94cGFja2V0IGVuZD0ndyc/PiyUmAsAAAANSURBVBhXY3grk/YfAAXYAm/HQierAAAAAElFTkSuQmCC", + "challengeType": + { + "challengeTypeId": 1, + "name": "email", + }, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + "orderAccountingStatuses": [], + "validationResult": "invalid", + "additionalRemarks": + [ + { + "code": "MANDATE_REQUIRED", + "parameter": "directDebitMandateId", + }, + ], + "validationErrors": + [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + }, + ], + }, + ], + "payments": [], + "orderCustomer": null, + } ], - "payments": [], - "orderCustomer": null, - } - ], - "_links": - { - "self": + "_links": { - "href": "https://api.example.com/items", - "method": "GET", - "templated": true, + "self": + { + "href": "https://api.example.com/items", + "method": "GET", + "templated": true, + }, }, - }, - "href": "string", - } + "href": "string", + } post: tags: - Order Creation v2 @@ -1056,9 +1056,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Order creation v2.1 - description: Order creation v2.1 + v2.2: + summary: Order creation v2.2 + description: Order creation v2.2 value: { "externalOrderId": null, @@ -1332,7 +1332,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: + v2.2: value: { "validContents": false, @@ -1425,7 +1425,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": false, + "validationResult": "invalid", "additionalRemarks": [ { @@ -1499,7 +1499,7 @@ paths: get: tags: - Order Retrieval v1 & v2 - summary: Get a single order. + summary: Get a single order. P1 description: Get a single order. responses: "200": @@ -1712,9 +1712,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Order update v2.1 - description: Order update v2.1 + v2.2: + summary: Order update v2.2 + description: Order update v2.2 value: { "languageId": 1, @@ -1742,7 +1742,7 @@ paths: v2.1: value: { - "validContents": true, + "validContents": false, "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", @@ -1832,7 +1832,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "preliminary", "additionalRemarks": [ { @@ -2111,7 +2111,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "preliminary", "additionalRemarks": [ { @@ -2164,7 +2164,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -2231,25 +2231,15 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Update order line v2.1 - description: Update order line v2.1 + v2.2: + summary: Update order line v2.2 + description: Update order line v2.2 value: { "quantity": 1, "validFrom": "2024-03-25T09:00:00", "validUntil": null, } - v3.0: - summary: Update order line v3.0, required for prolongation - description: Update order line v3.0, required for prolongation - value: - { - "productId": 49, - "quantity": 1, - "validFrom": "2024-03-25T09:00:00", - "validUntil": null, - } v1.2: summary: Orderline update v1.2 description: Orderline update v1.2 @@ -2344,7 +2334,7 @@ paths: { "orderLineStatusId": 1, "name": "pending" }, "customerTokens": [], "orderAccountingStatuses": [], - "validationResult": false, + "validationResult": "preliminary", "additionalRemarks": [ { @@ -2356,8 +2346,7 @@ paths: "parameter": "customerTokenId", }, ], - "validationErrors": [ - ], + "validationErrors": [], }, ], "payments": [], @@ -2366,7 +2355,7 @@ paths: v2.1: value: { - "validContents": true, + "validContents": false, "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", @@ -2456,7 +2445,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [ { @@ -2631,7 +2620,7 @@ paths: v2.2: value: { - "validContents": true, + "validContents": false, "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", @@ -2709,7 +2698,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "preliminary", "additionalRemarks": [ { "code": "PERSONALACCOUNTDATA_BIRTHDATE_REQUIRED", @@ -2843,10 +2832,8 @@ paths: "personalAccountData": null} ], "orderAccountingStatuses": [], - "validationResult": true, - "additionalRemarks": [ - - ], + "validationResult": "valid", + "additionalRemarks": [], "validationErrors": [], }, ], @@ -2934,7 +2921,7 @@ paths: { "orderLineStatusId": 1, "name": "pending" }, "customerTokens": [], "orderAccountingStatuses": [], - "validationResult": false, + "validationResult": "preliminary", "additionalRemarks": [ { "code": "CUSTOMERTOKEN_REQUIRED", @@ -3082,7 +3069,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -3221,7 +3208,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": false, + "validationResult": "invalid", "additionalRemarks": [], "validationErrors": [ { @@ -3249,7 +3236,7 @@ paths: examples: v2.2: value: - { + { "validContents": true, "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, @@ -3328,7 +3315,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -3364,9 +3351,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Add a payment v2.1 - description: Add a payment v2.1 + v2.2: + summary: Add a payment v2.2 + description: Add a payment v2.2 value: { "createdOn": "2024-03-22T09:00:00", @@ -3518,7 +3505,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -3566,7 +3553,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -3661,9 +3648,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Update payment v2.1 - description: Update payment v2.1 + v2.2: + summary: Update payment v2.2 + description: Update payment v2.2 value: { "htmPaymentReference": "HTM-1234", @@ -3797,7 +3784,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -3995,7 +3982,7 @@ paths: "description": "Order is aangemaakt", }, ], - "validationResult": false, + "validationResult": "invalid", "additionalRemarks": [ { @@ -4129,9 +4116,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Add order customer v2.1 - description: Add order customer v2.1 + v2.2: + summary: Add order customer v2.2 + description: Add order customer v2.2 value: { "birthname": "Jan", @@ -4276,7 +4263,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -4339,9 +4326,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Update order customer v2.1 - description: Update order customer v2.1 + v2.2: + summary: Update order customer v2.2 + description: Update order customer v2.2 value: { "birthname": "Jan", @@ -4462,7 +4449,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": true, + "validationResult": "valid", "additionalRemarks": [], "validationErrors": [], }, @@ -4525,9 +4512,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Add order customer address v2.1 - description: Add order customer address v2.1 + v2.2: + summary: Add order customer address v2.2 + description: Add order customer address v2.2 value: { "addressTypeId": 3, @@ -4652,7 +4639,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": false, + "validationResult": "preliminary", "additionalRemarks": [ { @@ -4716,9 +4703,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.1: - summary: Update order customer address v2.1 - description: Update order customer address v2.1 + v2.2: + summary: Update order customer address v2.2 + description: Update order customer address v2.2 value: { "addressTypeId": 3, @@ -4830,7 +4817,7 @@ paths: }, ], "orderAccountingStatuses": [], - "validationResult": false, + "validationResult": "preliminary", "additionalRemarks": [ { @@ -4984,7 +4971,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Fulfillment v1.1 + - Order Fulfillment v2.2 summary: Fulfill an order without creating or updating the order as a resource. description: Fulfill an order without creating or updating the order as a resource. responses: