From caf927cae5b33b4aed8fedf96789a4b5fc51277d Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 24 Feb 2025 12:16:41 +0100 Subject: [PATCH 1/9] creating orderv2.3 --- src/openapi/orders/service_engine_orders.yaml | 1375 +++++++++++++---- 1 file changed, 1048 insertions(+), 327 deletions(-) diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 058a3dc..0c8ce0a 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -35,30 +35,6 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v1: - summary: Order validation v1 - description: Order validation v1 - value: - [ - { - "ovPayTokenId": 2, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 34, - "ovpasNumber": "OV34567", - "productId": 2, - "startDate": "2024-03-22T09:00:00z", - "quantity": 1, - }, - { - "ovPayTokenId": 3, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 89, - "ovpasNumber": "OV34567", - "productId": 4, - "startDate": "2024-03-22T09:00:00z", - "quantity": 4, - }, - ] v2: summary: Order validation v2 description: Order validation v2 @@ -125,6 +101,30 @@ paths: ], }, } + v1: + summary: Order validation v1 + description: Order validation v1 + value: + [ + { + "ovPayTokenId": 2, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "productId": 2, + "startDate": "2024-03-22T09:00:00z", + "quantity": 1, + }, + { + "ovPayTokenId": 3, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 89, + "ovpasNumber": "OV34567", + "productId": 4, + "startDate": "2024-03-22T09:00:00z", + "quantity": 4, + }, + ] responses: "200": description: OK @@ -322,44 +322,98 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v1: - summary: Order fulfillment v1 - description: Order fulfillment v1 + v2.2: + summary: Order fulfillment v2.2 + description: Order fulfillment v2.2 value: { - "customerProfileID": 123415, - "customerProfileData": { "dateOfBirth": "09-03-1989" }, - "personalAccountData": { "birthdate": "09-03-1989" }, - "directDebitMandate": - { - "consumerName": "J. de Tèster", - "consumerBic": "RABONL2U", - "consumerIban": "NL44RABO0123456789", - }, - "orderContents": + "externalOrderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9", + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "createdOn": "2024-03-22T09:00:00", + "orderStatusId": 4, + "orderLines": [ { - "ovPayTokenId": 123, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 450, - "ovpasNumber": "63AW974", - "productId": 2, - "startDate": "2024-03-22T09:00:00Z", + "externalOrderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f", + "productId": 1, "quantity": 1, - "orderlineId": "2d7fadc9-b64b-4516-9a7d-cf550f201372", - }, - { - "ovPayTokenId": 123, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 450, - "ovpasNumber": "63AW974", - "productId": 3, - "startDate": "2024-03-16T09:00:00Z", - "quantity": 1, - "orderlineId": "9d7fadc9-b64b-4516-9a7d-cf550f201378", + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatusId": 4, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], }, ], - "orderStatus": "succeededPayment", + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ], + }, } v2: summary: Order fulfillment v2 @@ -469,98 +523,44 @@ paths: ], }, } - v2.2: - summary: Order fulfillment v2.2 - description: Order fulfillment v2.2 + v1: + summary: Order fulfillment v1 + description: Order fulfillment v1 value: { - "externalOrderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9", - "languageId": 1, - "billingAddressId": 1, - "shippingAddressId": 1, - "createdOn": "2024-03-22T09:00:00", - "orderStatusId": 4, - "orderLines": - [ - { - "externalOrderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f", - "productId": 1, - "quantity": 1, - "createdOn": "2024-03-22T09:00:00", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - "orderLineStatusId": 4, - "tokens": - [ - { - "tokenTypeId": 1, - "ovPayTokenId": 1, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 34, - "ovpasNumber": "OV34567", - "verificationCode": "A7H6", - "personalAccountData": - { - "name": "Jan de Vries", - "dateOfBirth": "01-01-1970", - "photoReference": "DSC_0502.JPG", - "fileType": "image/jpg", - "challengeTypeId": 1, - "oneTimePassword": "H5Iiz3JTaQeIV8p", - }, - }, - ], - }, - ], - "payments": - [ - { - "createdOn": "2024-03-22T09:00:00", - "amountDebit": 121, - "paymentMethodId": 1, - "isRefund": false, - "htmPaymentReference": "HTM-1234", - "pspPaymentReference": "Buckaroo-1234", - "paymentStatuses": - [ - { - "createdOn": "2024-03-22T09:00:00", - "statusCode": "190", - "statusDescription": "Success", - "statusSubCode": "S001", - "statusSubDescription": "PaymentSuccessFul", - }, - ], - "payPush": - { - "consumerIssuer": "ABN AMRO", - "transactionId": "0000000000000001", - "consumerName": "J. de Vries", - "consumerIBAN": "NL44RABO0123456789", - "consumerBIC": "RABONL2U", - }, - }, - ], - "customer": + "customerProfileID": 123415, + "customerProfileData": { "dateOfBirth": "09-03-1989" }, + "personalAccountData": { "birthdate": "09-03-1989" }, + "directDebitMandate": { - "birthname": "Jan", - "surname": "Vries", - "prefix": "de", - "emailAddress": "jandevries@outlook.com", - "dateOfBirth": "1970-01-01", - "addresses": - [ - { - "addressTypeId": 1, - "street": "Kon. Julianaplein", - "houseNumber": 10, - "houseNumberSuffix": "a", - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "NL", - }, - ], + "consumerName": "J. de Tèster", + "consumerBic": "RABONL2U", + "consumerIban": "NL44RABO0123456789", }, + "orderContents": + [ + { + "ovPayTokenId": 123, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 450, + "ovpasNumber": "63AW974", + "productId": 2, + "startDate": "2024-03-22T09:00:00Z", + "quantity": 1, + "orderlineId": "2d7fadc9-b64b-4516-9a7d-cf550f201372", + }, + { + "ovPayTokenId": 123, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 450, + "ovpasNumber": "63AW974", + "productId": 3, + "startDate": "2024-03-16T09:00:00Z", + "quantity": 1, + "orderlineId": "9d7fadc9-b64b-4516-9a7d-cf550f201378", + }, + ], + "orderStatus": "succeededPayment", } responses: "201": @@ -954,6 +954,209 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: + v2.3: + summary: Order creation v2.3 + description: Order creation v2.3 + value: + { + "externalOrderId": null, + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "createdOn": "2024-03-22T09:00:00", + "orderStatusId": 1, + "orderLines": + [ + { + "externalOrderLineId": null, + "productId": 1, + "quantity": 1, + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatusId": 1, + "createdOn": "2024-03-22T09:00:00", + "customerTokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + } + } + ] + } + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "mandateInput": + { + "directDebitMandateTypeId": 1, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + "place": "Den Haag", + }, + }, + ], + "orderCustomer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "orderCustomerAddresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + summary: Order creation v2.2 + description: Order creation v2.2 + value: + { + "externalOrderId": null, + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "createdOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "orderStatusId": 1, + "createdOn": "2024-03-22T09:00:00", + "description": "Concept order", + }, + ], + "orderLines": + [ + { + "externalOrderLineId": null, + "productId": 1, + "quantity": 1, + "validFrom": "2024-03-22T09:00:00", + "validUntil": "2025-03-22T09:00:00", + "orderLineStatusId": 4, + "createdOn": "2024-03-22T09:00:00", + "customerTokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + "orderAccountingStatuses": + [ + { + "accountingStatusId": 1, + "createdOn": "2024-03-22T09:00:00", + "description": "Financiele transactie voor de FIKO.", + }, + ], + }, + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "mandateInput": + { + "directDebitMandateTypeId": 1, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + "place": "Den Haag", + }, + }, + ], + "orderCustomer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "orderCustomerAddresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ], + }, + } v2: summary: Order creation v2.1 description: Order creation v2.1 @@ -1082,126 +1285,166 @@ paths: ], }, } - v2.2: - summary: Order creation v2.2 - description: Order creation v2.2 - value: - { - "externalOrderId": null, - "languageId": 1, - "billingAddressId": 1, - "shippingAddressId": 1, - "createdOn": "2024-03-22T09:00:00", - "order_OrderStatus": - [ - { - "orderStatusId": 1, - "createdOn": "2024-03-22T09:00:00", - "description": "Concept order", - }, - ], - "orderLines": - [ - { - "externalOrderLineId": null, - "productId": 1, - "quantity": 1, - "validFrom": "2024-03-22T09:00:00", - "validUntil": "2025-03-22T09:00:00", - "orderLineStatusId": 4, - "createdOn": "2024-03-22T09:00:00", - "customerTokens": - [ - { - "tokenTypeId": 1, - "ovPayTokenId": 1, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 34, - "ovpasNumber": "OV34567", - "verificationCode": "A7H6", - "personalAccountData": - { - "name": "Jan de Vries", - "dateOfBirth": "01-01-1970", - "photoReference": "DSC_0502.JPG", - "fileType": "image/jpg", - "challengeTypeId": 1, - "oneTimePassword": "H5Iiz3JTaQeIV8p", - }, - }, - ], - "orderAccountingStatuses": - [ - { - "accountingStatusId": 1, - "createdOn": "2024-03-22T09:00:00", - "description": "Financiele transactie voor de FIKO.", - }, - ], - }, - ], - "payments": - [ - { - "createdOn": "2024-03-22T09:00:00", - "amountDebit": 121, - "paymentMethodId": 1, - "isRefund": false, - "htmPaymentReference": "HTM-1234", - "pspPaymentReference": "Buckaroo-1234", - "paymentStatuses": - [ - { - "createdOn": "2024-03-22T09:00:00", - "statusCode": "190", - "statusDescription": "Success", - "statusSubCode": "S001", - "statusSubDescription": "PaymentSuccessFul", - }, - ], - "mandateInput": - { - "directDebitMandateTypeId": 1, - "createdOn": "2024-03-22T09:00:00", - "bic": "RABONL2U", - "iban": "NL44RABO0123456789", - "ascription": "J. de Vries", - "place": "Den Haag", - }, - }, - ], - "orderCustomer": - { - "birthname": "Jan", - "surname": "Vries", - "prefix": "de", - "emailAddress": "jandevries@outlook.com", - "dateOfBirth": "1970-01-01", - "orderCustomerAddresses": - [ - { - "addressTypeId": 1, - "street": "Kon. Julianaplein", - "houseNumber": 10, - "houseNumberSuffix": "a", - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "NL", - }, - ], - }, - } responses: "201": description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + v2.3: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + }, + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchPointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "orderNumber": "ORD-123456", + } + "400": + description: Bad request content: application/json: schema: $ref: "#/components/schemas/unavailable" example: - { - "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", - "orderNumber": "ORD-123456", + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + "ovPayTokenId": 123, + "productId": 2 + }, + { + "detail": "Combination of product and token type is not valid.", + "pointer": "#/1/ovPayTokenId", + "ovPayTokenId": 123, + "productId": 3 + } + ] } /orders/{orderId}: parameters: @@ -1249,6 +1492,7 @@ paths: }, "billingAddressId": 1, "shippingAddressId": 1, + "touchpointId": 3, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -1413,15 +1657,27 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "customerProfileId": 1337, - "totalAmount": 121, - "languageId": 1, - "billingAddressId": 1, - "shippingAddressId": 1, - "lastUpdatedOn": "2024-03-22T09:00:00", - } + examples: + v2.3: + summary: Order update v2.3 + description: Order update v2.3 + value: { + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "lastUpdatedOn": "2024-03-22T09:00:00", + } + v2.2: + summary: Order update v2.2 + description: Order update v2.2 + value: { + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "lastUpdatedOn": "2024-03-22T09:00:00", + } responses: "200": description: OK @@ -1429,11 +1685,133 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", - "orderNumber": "ORD-123456", - } + examples: + v2.3: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + }, + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchPointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "orderNumber": "ORD-123456", + } delete: tags: - Order Creation v2.1 @@ -1469,53 +1847,82 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "externalOrderLineId": null, - "productId": 1, - "productName": "HTM Maandkorting 20%", - "productCode": "HTM-MND-20", - "productDescription": "HTM Maandkorting 20%", - "taxAmount": 21, - "taxMetadataId": "1d6f1725-1072-4f08-982c-3df51dd854a1", - "amountExclTax": 100, - "amountInclTax": 121, - "quantity": 1, - "orderLineTerms": - [{ "termsUrl": "generalTermsAndConditions.pdf" }], - "validFrom": "2024-03-22T09:00:00", - "validUntil": "2025-03-22T09:00:00", - "orderLineStatusId": 4, - "createdOn": "2024-03-22T09:00:00", - "customerTokens": - [ - { - "tokenTypeId": 1, - "ovPayTokenId": 1, - "serviceReferenceId": "NLOV1234567ABCDEFG", - "amount": 34, - "ovpasNumber": "OV34567", - "verificationCode": "A7H6", - "personalAccountData": + examples: + v2.3: + summary: Create orderLine v2.3 + description: Create orderLine v2.3 + value: + { + "externalOrderLineId": null, + "productId": 2, + "quantity": 1, + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatusId": 1, + "createdOn": "2024-03-22T09:00:00", + "customerTokens": + [ { - "name": "Jan de Vries", - "dateOfBirth": "01-01-1970", - "photoReference": "DSC_0502.JPG", - "fileType": "image/jpg", - "challengeTypeId": 1, - "oneTimePassword": "H5Iiz3JTaQeIV8p", + "tokenTypeId": 1, + "ovPayTokenId": 4, + "serviceReferenceId": null, + "amount": null , + "ovpasNumber": null , + "verificationCode": null , + "personalAccountData": null }, - }, - ], - "orderAccountingStatuses": - [ - { - "accountingStatusId": 1, - "createdOn": "2024-03-22T09:00:00", - "description": "Financiele transactie voor de FIKO.", - }, - ], - } + ] + } + v2.2: + summary: Create orderLine v2.2 + description: Create orderLine v2.2 + value: + { + "externalOrderLineId": null, + "productId": 1, + "productName": "HTM Maandkorting 20%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxMetadataId": "1d6f1725-1072-4f08-982c-3df51dd854a1", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "orderLineTerms": + [{ "termsUrl": "generalTermsAndConditions.pdf" }], + "validFrom": "2024-03-22T09:00:00", + "validUntil": "2025-03-22T09:00:00", + "orderLineStatusId": 4, + "createdOn": "2024-03-22T09:00:00", + "customerTokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + "orderAccountingStatuses": + [ + { + "accountingStatusId": 1, + "createdOn": "2024-03-22T09:00:00", + "description": "Financiele transactie voor de FIKO.", + }, + ], + } responses: "200": description: OK @@ -1523,7 +1930,164 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } + examples: + v2.3: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + }, + { + "orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71", + "externalOrderLineId": null, + "productId": 2, + "productName": "HTM Maandkorting 40%", + "productCode": "HTM-MND-40", + "productDescription": "HTM Maandkorting 40%", + "taxAmount": 42, + "taxCode": "V21", + "amountExclTax": 200, + "amountInclTax": 242, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 4, + "serviceReferenceId": null, + "amount": null , + "ovpasNumber": null , + "verificationCode": null , + "personalAccountData": null + } + ] + } + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchPointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } /orderlines/{orderLineId}: parameters: - in: path @@ -1551,17 +2115,30 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "taxAmount": 21, - "taxMetadataId": "0574440e-7fa0-401f-b907-539c91633a5d", - "amountExclTax": 100, - "amountInclTax": 121, - "quantity": 1, - "validFrom": "2024-03-22T09:00:00", - "validUntil": "2025-03-22T09:00:00", - "orderLineStatusId": 4, - } + examples: + v2.3: + summary: Order creation v2.3 + description: Order creation v2.3 + value: + { + "quantity": 1, + "validFrom": "2024-03-25T09:00:00", + "validUntil": null + } + v2.2: + summary: Order creation v2.2 + description: Order creation v2.2 + value: + { + "taxAmount": 21, + "taxMetadataId": "0574440e-7fa0-401f-b907-539c91633a5d", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "validFrom": "2024-03-22T09:00:00", + "validUntil": "2025-03-22T09:00:00", + "orderLineStatusId": 4, + } responses: "200": description: OK @@ -1569,7 +2146,130 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } + examples: + v2.3: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-25T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + } + } + ] + }, + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchPointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } delete: tags: - Order Creation v2.1 @@ -1578,6 +2278,27 @@ paths: responses: "200": description: OK + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Product requires product with productId=2", + "pointer": "#/1/orderLine", + "orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d", + "productId": 3 + } + ] + } /orders/{orderId}/payments: parameters: - in: path From 76c5fd1804c613ea4df840de923ddbb9183e8c42 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 24 Feb 2025 13:59:28 +0100 Subject: [PATCH 2/9] v3.0 orders --- src/openapi/orders/service_engine_orders.yaml | 1205 +++++++++++++++-- 1 file changed, 1110 insertions(+), 95 deletions(-) diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 0c8ce0a..fc587a2 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -685,6 +685,33 @@ paths: ], }, } + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + "ovPayTokenId": 123, + "productId": 2 + }, + { + "detail": "Combination of product and token type is not valid.", + "pointer": "#/1/ovPayTokenId", + "ovPayTokenId": 123, + "productId": 3 + } + ] + } /customers/{customerProfileId}/orders: parameters: - in: path @@ -945,25 +972,24 @@ paths: } post: tags: - - Order Creation v2.1 - summary: Create a new order. - description: Create a new order. + - Order Creation v3.0 + summary: Create a new order v3.0. + description: Create a new order v3.0. requestBody: content: application/json: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: - summary: Order creation v2.3 - description: Order creation v2.3 + v3.0: + summary: Order creation v3.0 + description: Order creation v3.0 value: { "externalOrderId": null, "languageId": 1, "billingAddressId": 1, "shippingAddressId": 1, - "createdOn": "2024-03-22T09:00:00", "orderStatusId": 1, "orderLines": [ @@ -974,7 +1000,6 @@ paths: "validFrom": "2024-03-22T09:00:00", "validUntil": null, "orderLineStatusId": 1, - "createdOn": "2024-03-22T09:00:00", "customerTokens": [ { @@ -1293,7 +1318,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: + v3.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -1649,7 +1674,7 @@ paths: } patch: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Update an existing order. description: Update an existing order. requestBody: @@ -1658,9 +1683,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: - summary: Order update v2.3 - description: Order update v2.3 + v3.0: + summary: Order update v3.0 + description: Order update v3.0 value: { "languageId": 1, "billingAddressId": 2, @@ -1686,7 +1711,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: + v3.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -1812,9 +1837,36 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderNumber": "ORD-123456", } + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + "ovPayTokenId": 123, + "productId": 2 + }, + { + "detail": "Combination of product and token type is not valid.", + "pointer": "#/1/ovPayTokenId", + "ovPayTokenId": 123, + "productId": 3 + } + ] + } delete: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Delete an existing order. description: Delete an existing order. responses: @@ -1839,7 +1891,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Add a new order line to an existing order. description: Add a new order line to an existing order. requestBody: @@ -1848,9 +1900,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: - summary: Create orderLine v2.3 - description: Create orderLine v2.3 + v3.0: + summary: Create orderLine v3.0 + description: Create orderLine v3.0 value: { "externalOrderLineId": null, @@ -1931,7 +1983,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: + v3.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -2088,6 +2140,33 @@ paths: } v2.2: value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + "ovPayTokenId": 123, + "productId": 2 + }, + { + "detail": "Combination of product and token type is not valid.", + "pointer": "#/1/ovPayTokenId", + "ovPayTokenId": 123, + "productId": 3 + } + ] + } /orderlines/{orderLineId}: parameters: - in: path @@ -2107,7 +2186,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). patch: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Update an existing order line. description: Update an existing order line. requestBody: @@ -2116,9 +2195,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: - summary: Order creation v2.3 - description: Order creation v2.3 + v3.0: + summary: Order creation v3.0 + description: Order creation v3.0 value: { "quantity": 1, @@ -2147,7 +2226,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.3: + v3.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -2270,14 +2349,86 @@ paths: v2.2: value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The start date of the product is not allowed. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + "ovPayTokenId": 123, + "productId": 2 + } + ] + } delete: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Delete an existing order line. description: Delete an existing order line. responses: "200": description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 0, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", + "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "createdOn": "2024-03-22T09:00:00", + "description": "Order is aangemaakt", + } + ], + "orderLines": null, + "payments": null, + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } "400": description: Bad request content: @@ -2318,7 +2469,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Add a payment to an existing order. description: Add a payment to an existing order. requestBody: @@ -2326,35 +2477,70 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "createdOn": "2024-03-22T09:00:00", - "amountDebit": 121, - "paymentMethodId": 1, - "touchPointId": 1, - "isRefund": false, - "htmPaymentReference": "HTM-1234", - "pspPaymentReference": "Buckaroo-1234", - "paymentStatuses": - [ - { - "createdOn": "2024-03-22T09:00:00", - "statusCode": "190", - "statusDescription": "Success", - "statusSubCode": "S001", - "statusSubDescription": "PaymentSuccessFul", - }, - ], - "mandateInput": + examples: + v3.0: + summary: Order creation v3.0 + description: Order creation v3.0 + value: { - "directDebitMandateTypeId": 1, "createdOn": "2024-03-22T09:00:00", - "bic": "RABONL2U", - "iban": "NL44RABO0123456789", - "ascription": "J. de Vries", - "place": "Den Haag", - }, - } + "amountDebit": 121, + "paymentMethodId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "mandateInput": + { + "directDebitMandateTypeId": 1, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + "place": "Den Haag", + }, + } + v2.2: + summary: Order creation v2.2 + description: Order creation v2.2 + value: + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchpointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "mandateInput": + { + "directDebitMandateTypeId": 1, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + "place": "Den Haag", + }, + } responses: "201": description: Created @@ -2362,7 +2548,165 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } + examples: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + }, + { + "orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71", + "externalOrderLineId": null, + "productId": 2, + "productName": "HTM Maandkorting 40%", + "productCode": "HTM-MND-40", + "productDescription": "HTM Maandkorting 40%", + "taxAmount": 42, + "taxCode": "V21", + "amountExclTax": 200, + "amountInclTax": 242, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 4, + "serviceReferenceId": null, + "amount": null , + "ovpasNumber": null , + "verificationCode": null , + "personalAccountData": null + } + ] + } + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchPointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } /payments/{paymentId}: parameters: - in: path @@ -2382,7 +2726,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). patch: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Update a payment on an existing order. description: Update a payment on an existing order. requestBody: @@ -2390,11 +2734,42 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "htmPaymentReference": "HTM-1234", - "pspPaymentReference": "Buckaroo-1234", - } + examples: + v3.0: + summary: Order payment update v3.0 + description: Order payment update v3.0 + value: + { + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "mandateInput": + { + "directDebitMandateTypeId": 1, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + "place": "Den Haag", + } + } + v2.2: + summary: Order payment update v2.2 + description: Order payment update v2.2 + value: + { + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + } responses: "200": description: OK @@ -2402,7 +2777,137 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } + examples: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + } + ], + "payments": + [ + { + "createdOn": "2024-03-22T09:00:00", + "amountDebit": 121, + "paymentMethodId": 1, + "touchPointId": 1, + "isRefund": false, + "htmPaymentReference": "HTM-1234", + "pspPaymentReference": "Buckaroo-1234", + "paymentStatuses": + [ + { + "createdOn": "2024-03-22T09:00:00", + "statusCode": "791", + "statusDescription": "Pending processing", + "statusSubCode": "S001", + "statusSubDescription": "PendingProcessing", + }, + { + "createdOn": "2024-03-22T09:01:00", + "statusCode": "190", + "statusDescription": "Success", + "statusSubCode": "S001", + "statusSubDescription": "PaymentSuccessFul", + }, + ], + "payPush": + { + "consumerIssuer": "ABN AMRO", + "transactionId": "0000000000000001", + "consumerName": "J. de Vries", + "consumerIBAN": "NL44RABO0123456789", + "consumerBIC": "RABONL2U", + }, + }, + ], + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } /orders/{orderId}/ordercustomers: parameters: - in: path @@ -2422,7 +2927,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Add a customer to an existing order. description: Add a customer to an existing order. requestBody: @@ -2430,26 +2935,53 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "birthname": "Jan", - "surname": "Vries", - "prefix": "de", - "emailAddress": "jandevries@outlook.com", - "dateOfBirth": "1970-01-01", - "orderCustomerAddresses": - [ - { - "addressTypeId": 1, - "street": "Kon. Julianaplein", - "houseNumber": 10, - "houseNumberSuffix": "a", - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "NL", - }, - ], - } + examples: + v3.0: + summary: Order payment update v3.0 + description: Order payment update v3.0 + value: + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "orderCustomerAddresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ], + } + v2.2: + summary: Order payment update v2.2 + description: Order payment update v2.2 + value: + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "orderCustomerAddresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ], + } responses: "201": description: Created @@ -2457,8 +2989,101 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } + examples: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + } + ], + "payments": null, + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } /ordercustomers/{orderCustomerId}: patch: parameters: @@ -2478,7 +3103,7 @@ paths: example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: The JWT of the logged in customer (in case of a web shop). tags: - - Order Creation v2.1 + - Order Creation v3.0 summary: Update a customer on an existing order. description: Update a customer on an existing order. requestBody: @@ -2487,13 +3112,28 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - { - "birthname": "Jan", - "surname": "Vries", - "prefix": "de", - "emailAddress": "jandevries@outlook.com", - "dateOfBirth": "1970-01-01", - } + v3.0: + summary: Order customer update v2.2 + description: Order customer update v2.2 + value: + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + } + v2.2: + summary: Order customer update v2.2 + description: Order customer update v2.2 + value: + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + } responses: "200": description: OK @@ -2501,8 +3141,383 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } + examples: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + } + ], + "payments": null, + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + v2.2: + value: + { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } + /ordercustomers/{orderCustomerId}/orderCustomerAddress: + post: + parameters: + - in: path + name: orderCustomerId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: a0ef57fa-395c-4a03-96e9-234c26dccea9 + - in: header + name: X-HM-JWT-AUTH-HEADER + schema: + type: string + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + description: The JWT of the logged in customer (in case of a web shop). + tags: + - Order Creation v3.0 + summary: Create a customer address for an existing order. + description: Create a customer address for an existing order. + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + v3.0: + summary: Order customer address create v2.2 + description: Order customer address create v2.2 + value: + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + } + ], + "payments": null, + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } + /orderCustomerAddress/{orderCustomerAddressId}: + patch: + parameters: + - in: path + name: orderCustomerAddressId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: a0ef57fa-395c-4a03-96e9-234c26dccea9 + - in: header + name: X-HM-JWT-AUTH-HEADER + schema: + type: string + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + description: The JWT of the logged in customer (in case of a web shop). + tags: + - Order Creation v3.0 + summary: Update a customer address for an existing order. + description: Update a customer address for an existing order. + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + v3.0: + summary: Order customer address create v2.2 + description: Order customer address create v2.2 + value: + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 101, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + v3.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "touchpointId": 3, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "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%", + "productCode": "HTM-MND-20", + "productDescription": "HTM Maandkorting 20%", + "taxAmount": 21, + "taxCode": "V21", + "amountExclTax": 100, + "amountInclTax": 121, + "quantity": 1, + "terms": + [ + "generalTermsAndConditions.pdf", + "productTermsAndConditions.pdf", + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "tokens": + [ + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ], + } + ], + "payments": null, + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": + [ + { + "addressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 101, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + ] + } + } /orders/{orderId}/fulfill: parameters: - in: path From f190a007b8ebc8384d4ee073a1ad64da3780644d Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 24 Feb 2025 14:23:16 +0100 Subject: [PATCH 3/9] mandate create in crud --- src/openapi/orders/orders-crud.yaml | 38 ++++ src/openapi/orders/service_engine_orders.yaml | 191 ++++++++++++++---- 2 files changed, 193 insertions(+), 36 deletions(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index 8ae1a81..e9e47cc 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -1846,6 +1846,44 @@ paths: "place": "Den Haag", }, ] + /payments/{paymentId}/mandateinputs: + parameters: + - in: path + name: paymentId + schema: + type: string + format: uuid + example: fd09f3c5-35d9-4a1b-a98b-e46addb663f2 + required: true + description: The id of the payment to process. + post: + summary: P2. Create a mandateInput. + description: Create a mandateInput.. + tags: + - Payment + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "directDebitMandateTypeId": 1, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + "place": "Den Haag", + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: { "mandateInputId": "dbbc3913-414e-4528-9c95-6c11a11e04ac" } + /mandateinputs/{mandateInputId}: parameters: - in: path diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index fc587a2..5905fe8 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -882,7 +882,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - { + { "orders": [ { @@ -1326,10 +1326,22 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, + "language": + { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -1507,7 +1519,15 @@ paths: "orderNumber": "123456", "customerProfileId": 42, "totalAmount": 121, - "touchPointId": 1, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, + "billingAddressId": 1, + "shippingAddressId": 1, "language": { "languageId": 1, @@ -1515,9 +1535,6 @@ paths: "iso639Code": "nl-NL", "ietfCode": "nl", }, - "billingAddressId": 1, - "shippingAddressId": 1, - "touchpointId": 3, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -1719,10 +1736,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -1991,10 +2019,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -2234,10 +2273,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -2391,10 +2441,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 0, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -2557,10 +2618,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -2786,8 +2858,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, "touchpointId": 3, "createdOn": "2024-03-22T09:00:00", @@ -2998,10 +3075,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -3150,10 +3238,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -3277,7 +3376,6 @@ paths: "city": "Den Haag", "country": "NL", } - responses: "200": description: OK @@ -3294,10 +3392,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, "billingAddressId": 2, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": @@ -3418,7 +3527,6 @@ paths: "city": "Den Haag", "country": "NL", } - responses: "200": description: OK @@ -3435,10 +3543,21 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "languageId": 1, - "billingAddressId": 2, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, "shippingAddressId": 1, - "touchpointId": 3, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatus": From 8c470c790c1fadf9255ea6ff002127314a586d96 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 24 Feb 2025 15:54:37 +0100 Subject: [PATCH 4/9] small fix --- src/openapi/orders/service_engine_orders.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 5905fe8..3745780 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -3199,10 +3199,10 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: + examples: v3.0: - summary: Order customer update v2.2 - description: Order customer update v2.2 + summary: Order customer update v3.0 + description: Order customer update v3.0 value: { "birthname": "Jan", From 2bf79f1fa093f43b19088c5155c7de90ab16d8a3 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Wed, 26 Feb 2025 15:53:12 +0100 Subject: [PATCH 5/9] versionering and additional remarks --- src/openapi/orders/service_engine_orders.yaml | 205 +++++++++++------- 1 file changed, 123 insertions(+), 82 deletions(-) diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 3745780..8515281 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -4,12 +4,12 @@ info: version: "1.0" description: Order APIs available in the Service Engine for order validation and fulfillment. servers: - - url: https://api.integratielaag.nl/v2 + - url: https://api.integratielaag.nl/v1 paths: /orders/validation: post: tags: - - Order Validation v1 & v2 + - Order Validation v1 & v1 summary: Validate order. description: Validate order. parameters: @@ -133,9 +133,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v1: - summary: Order validation v1 - description: Order validation v1 + v2: + summary: Order validation v2 + description: Order validation v2 value: { "validContents": true, @@ -166,9 +166,9 @@ paths: }, ], } - v2: - summary: Order validation v2 - description: Order validation v2 + v1: + summary: Order validation v1 + description: Order validation v1 value: { "validContents": true, @@ -186,7 +186,7 @@ paths: "validFrom": "2024-03-22T09:00:00", "validUntil": null, "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "isRenewable": true, @@ -232,7 +232,7 @@ paths: "validFrom": "2024-03-22T09:00:00", "validUntil": null, "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "isRenewable": true, @@ -437,7 +437,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -599,7 +599,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -730,7 +730,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). get: tags: - - Order Retrieval v2.1 + - Order Retrieval v1.1 summary: Get all orders for a specific customer. description: Get all orders for a specific customer. responses: @@ -871,7 +871,7 @@ paths: example: 7208e73e-87a6-46d9-bb6d-867ffc460c9b description: xTat used in order fulfillment. Note that this is a joined parameter via PurchasedProduct. tags: - - Order Retrieval v2.1 + - Order Retrieval v1.1 summary: Find orders. description: Find orders. responses: @@ -1073,9 +1073,9 @@ paths: ] } } - v2.2: - summary: Order creation v2.2 - description: Order creation v2.2 + v1.2: + summary: Order creation v1.2 + description: Order creation v1.2 value: { "externalOrderId": null, @@ -1182,9 +1182,9 @@ paths: ], }, } - v2: - summary: Order creation v2.1 - description: Order creation v2.1 + v1: + summary: Order creation v1.1 + description: Order creation v1.1 value: { "externalOrderId": null, @@ -1363,7 +1363,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -1394,9 +1394,10 @@ paths: "fileType": "image/jpg", "challengeTypeId": 1, "oneTimePassword": "H5Iiz3JTaQeIV8p", - }, + } }, ], + "additionalRemarks" : [] }, ], "payments": @@ -1450,7 +1451,7 @@ paths: ] } } - v2.2: + v1.2: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -1502,7 +1503,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). get: tags: - - Order Retrieval v2.1 + - Order Retrieval v1.1 summary: Get a single order. description: Get a single order. responses: @@ -1566,7 +1567,7 @@ paths: "taxMetadata": { "taxMetadataId": "06270769-a263-4325-82d6-f49396f39d03", - "taxCode": "V21", + "taxCode": "V11", "taxPercentageAmount": 21, "description": "21% BTW", }, @@ -1709,9 +1710,9 @@ paths: "shippingAddressId": 1, "lastUpdatedOn": "2024-03-22T09:00:00", } - v2.2: - summary: Order update v2.2 - description: Order update v2.2 + v1.2: + summary: Order update v1.2 + description: Order update v1.2 value: { "customerProfileId": 1337, "totalAmount": 121, @@ -1772,7 +1773,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -1805,7 +1806,14 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], + ], + "additionalRemarks" : + [ + { + "code": "MANDATE_REQUIRED", + "parameter": "directDebitMandateId" + } + ] }, ], "payments": @@ -1859,7 +1867,7 @@ paths: ] } } - v2.2: + v1.2: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -1900,6 +1908,9 @@ paths: responses: "200": description: OK + "400": + description: "Bad request" + /orders/{orderId}/orderlines: parameters: - in: path @@ -1953,9 +1964,9 @@ paths: }, ] } - v2.2: - summary: Create orderLine v2.2 - description: Create orderLine v2.2 + v1.2: + summary: Create orderLine v1.2 + description: Create orderLine v1.2 value: { "externalOrderLineId": null, @@ -2055,7 +2066,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2088,7 +2099,14 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], + ], + "additionalRemarks" : + [ + { + "code": "MANDATE_REQUIRED", + "parameter": "directDebitMandateId" + } + ] }, { "orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71", @@ -2098,7 +2116,7 @@ paths: "productCode": "HTM-MND-40", "productDescription": "HTM Maandkorting 40%", "taxAmount": 42, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 200, "amountInclTax": 242, "quantity": 1, @@ -2123,9 +2141,10 @@ paths: "verificationCode": null , "personalAccountData": null } - ] + ], + "additionalRemarks" : [] } - ], + ], "payments": [ { @@ -2177,7 +2196,7 @@ paths: ] } } - v2.2: + v1.2: value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } "400": description: Bad request @@ -2243,9 +2262,9 @@ paths: "validFrom": "2024-03-25T09:00:00", "validUntil": null } - v2.2: - summary: Order creation v2.2 - description: Order creation v2.2 + v1.2: + summary: Order creation v1.2 + description: Order creation v1.2 value: { "taxAmount": 21, @@ -2309,7 +2328,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2342,7 +2361,14 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", } } - ] + ], + "additionalRemarks" : + [ + { + "code": "MANDATE_REQUIRED", + "parameter": "directDebitMandateId" + } + ] }, ], "payments": @@ -2396,7 +2422,7 @@ paths: ] } } - v2.2: + v1.2: value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } "400": @@ -2570,9 +2596,9 @@ paths: "place": "Den Haag", }, } - v2.2: - summary: Order creation v2.2 - description: Order creation v2.2 + v1.2: + summary: Order creation v1.2 + description: Order creation v1.2 value: { "createdOn": "2024-03-22T09:00:00", @@ -2654,7 +2680,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2697,7 +2723,7 @@ paths: "productCode": "HTM-MND-40", "productDescription": "HTM Maandkorting 40%", "taxAmount": 42, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 200, "amountInclTax": 242, "quantity": 1, @@ -2776,7 +2802,7 @@ paths: ] } } - v2.2: + v1.2: value: { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } /payments/{paymentId}: @@ -2834,9 +2860,9 @@ paths: "place": "Den Haag", } } - v2.2: - summary: Order payment update v2.2 - description: Order payment update v2.2 + v1.2: + summary: Order payment update v1.2 + description: Order payment update v1.2 value: { "htmPaymentReference": "HTM-1234", @@ -2888,7 +2914,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2982,7 +3008,7 @@ paths: ] } } - v2.2: + v1.2: value: { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } /orders/{orderId}/ordercustomers: @@ -3036,9 +3062,9 @@ paths: }, ], } - v2.2: - summary: Order payment update v2.2 - description: Order payment update v2.2 + v1.2: + summary: Order payment update v1.2 + description: Order payment update v1.2 value: { "birthname": "Jan", @@ -3111,7 +3137,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3169,7 +3195,7 @@ paths: ] } } - v2.2: + v1.2: value: { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } /ordercustomers/{orderCustomerId}: @@ -3211,9 +3237,9 @@ paths: "emailAddress": "jandevries@outlook.com", "dateOfBirth": "1970-01-01", } - v2.2: - summary: Order customer update v2.2 - description: Order customer update v2.2 + v1.2: + summary: Order customer update v1.2 + description: Order customer update v1.2 value: { "birthname": "Jan", @@ -3274,7 +3300,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3307,9 +3333,10 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], + ], + "additionalRemarks" : [] } - ], + ], "payments": null, "customer": { @@ -3332,7 +3359,7 @@ paths: ] } } - v2.2: + v1.2: value: { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } /ordercustomers/{orderCustomerId}/orderCustomerAddress: @@ -3364,8 +3391,8 @@ paths: $ref: "#/components/schemas/unavailable" example: v3.0: - summary: Order customer address create v2.2 - description: Order customer address create v2.2 + summary: Order customer address create v1.2 + description: Order customer address create v1.2 value: { "addressTypeId": 1, @@ -3428,7 +3455,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3461,9 +3488,16 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - } - ], + ], + "additionalRemarks" : + [ + { + "code": "MANDATE_REQUIRED", + "parameter": "directDebitMandateId" + } + ] + } + ], "payments": null, "customer": { @@ -3515,8 +3549,8 @@ paths: $ref: "#/components/schemas/unavailable" example: v3.0: - summary: Order customer address create v2.2 - description: Order customer address create v2.2 + summary: Order customer address create v1.2 + description: Order customer address create v1.2 value: { "addressTypeId": 1, @@ -3579,7 +3613,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V21", + "taxCode": "V11", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3612,9 +3646,16 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - } - ], + ], + "additionalRemarks" : + [ + { + "code": "MANDATE_REQUIRED", + "parameter": "directDebitMandateId" + } + ] + } + ], "payments": null, "customer": { @@ -3656,7 +3697,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Fulfillment v2.1 + - Order Fulfillment v1.1 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: From 8461b117bd0f1d3510565b91613abbb3e02822ad Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Wed, 26 Feb 2025 16:11:39 +0100 Subject: [PATCH 6/9] added delete on order address --- src/openapi/orders/orders-crud.yaml | 36 +++ src/openapi/orders/service_engine_orders.yaml | 226 +++++++++++++----- 2 files changed, 206 insertions(+), 56 deletions(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index e9e47cc..c3b3115 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -1395,6 +1395,42 @@ paths: $ref: "#/components/schemas/unavailable" example: { "customerTokenId": "0aedb483-2477-4720-aee6-7abcd016843b" } + /customertokens/{customerTokenId}/personalaccountdata: + parameters: + - in: path + name: customerTokenId + schema: + type: string + format: uuid + example: 510194ef-0038-45ef-94c7-262df93ef1d7 + required: true + description: The id of the customer token. + post: + summary: P3. Add personal account data to token. + description: Add personal account data to token. + tags: + - Order Line + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "personalAccountDataId": "0aedb483-2477-4720-aee6-7abcd016843b" } /personalaccountdata: get: summary: P5. Find personal account data. diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 8515281..d0de7bd 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -9,7 +9,7 @@ paths: /orders/validation: post: tags: - - Order Validation v1 & v1 + - Order Validation v1 & v2 summary: Validate order. description: Validate order. parameters: @@ -972,18 +972,18 @@ paths: } post: tags: - - Order Creation v3.0 - summary: Create a new order v3.0. - description: Create a new order v3.0. + - Order Creation v2.0 + summary: Create a new order v2.0. + description: Create a new order v2.0. requestBody: content: application/json: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order creation v3.0 - description: Order creation v3.0 + v2.0: + summary: Order creation v2.0 + description: Order creation v2.0 value: { "externalOrderId": null, @@ -1318,7 +1318,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -1692,7 +1692,7 @@ paths: } patch: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Update an existing order. description: Update an existing order. requestBody: @@ -1701,9 +1701,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order update v3.0 - description: Order update v3.0 + v2.0: + summary: Order update v2.0 + description: Order update v2.0 value: { "languageId": 1, "billingAddressId": 2, @@ -1729,7 +1729,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -1902,15 +1902,32 @@ paths: } delete: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Delete an existing order. description: Delete an existing order. responses: "200": description: OK "400": - description: "Bad request" - + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The order can not be deleted.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Order status is paid", + "pointer": "#/order_OrderStatus/1/orderStatus/orderStatusId", + "orderStatusId": 4 + } + ] + } /orders/{orderId}/orderlines: parameters: - in: path @@ -1930,7 +1947,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Add a new order line to an existing order. description: Add a new order line to an existing order. requestBody: @@ -1939,9 +1956,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Create orderLine v3.0 - description: Create orderLine v3.0 + v2.0: + summary: Create orderLine v2.0 + description: Create orderLine v2.0 value: { "externalOrderLineId": null, @@ -2022,7 +2039,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -2244,7 +2261,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). patch: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Update an existing order line. description: Update an existing order line. requestBody: @@ -2253,9 +2270,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order creation v3.0 - description: Order creation v3.0 + v2.0: + summary: Orderline update v2.0 + description: Orderline update v2.0 value: { "quantity": 1, @@ -2263,8 +2280,8 @@ paths: "validUntil": null } v1.2: - summary: Order creation v1.2 - description: Order creation v1.2 + summary: Orderline updatev1.2 + description: Orderline update v1.2 value: { "taxAmount": 21, @@ -2284,7 +2301,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -2448,7 +2465,7 @@ paths: } delete: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Delete an existing order line. description: Delete an existing order line. responses: @@ -2459,7 +2476,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -2556,7 +2573,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Add a payment to an existing order. description: Add a payment to an existing order. requestBody: @@ -2565,9 +2582,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order creation v3.0 - description: Order creation v3.0 + v2.0: + summary: Order creation v2.0 + description: Order creation v2.0 value: { "createdOn": "2024-03-22T09:00:00", @@ -2636,7 +2653,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -2824,7 +2841,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). patch: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Update a payment on an existing order. description: Update a payment on an existing order. requestBody: @@ -2833,9 +2850,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order payment update v3.0 - description: Order payment update v3.0 + v2.0: + summary: Order payment update v2.0 + description: Order payment update v2.0 value: { "htmPaymentReference": "HTM-1234", @@ -2876,7 +2893,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -3030,7 +3047,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). post: tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Add a customer to an existing order. description: Add a customer to an existing order. requestBody: @@ -3039,9 +3056,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order payment update v3.0 - description: Order payment update v3.0 + v2.0: + summary: Order payment update v2.0 + description: Order payment update v2.0 value: { "birthname": "Jan", @@ -3093,7 +3110,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -3217,7 +3234,7 @@ paths: example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: The JWT of the logged in customer (in case of a web shop). tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Update a customer on an existing order. description: Update a customer on an existing order. requestBody: @@ -3226,9 +3243,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: - summary: Order customer update v3.0 - description: Order customer update v3.0 + v2.0: + summary: Order customer update v2.0 + description: Order customer update v2.0 value: { "birthname": "Jan", @@ -3256,7 +3273,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -3381,7 +3398,7 @@ paths: example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: The JWT of the logged in customer (in case of a web shop). tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Create a customer address for an existing order. description: Create a customer address for an existing order. requestBody: @@ -3390,7 +3407,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - v3.0: + v2.0: summary: Order customer address create v1.2 description: Order customer address create v1.2 value: @@ -3411,7 +3428,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -3539,7 +3556,7 @@ paths: example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: The JWT of the logged in customer (in case of a web shop). tags: - - Order Creation v3.0 + - Order Creation v2.0 summary: Update a customer address for an existing order. description: Update a customer address for an existing order. requestBody: @@ -3548,7 +3565,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - v3.0: + v2.0: summary: Order customer address create v1.2 description: Order customer address create v1.2 value: @@ -3569,7 +3586,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v3.0: + v2.0: value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", @@ -3678,6 +3695,103 @@ paths: ] } } + delete: + tags: + - Order Creation v2.0 + summary: Delete an existing order address + description: Delete an existing order address + parameters: + - in: path + name: orderCustomerAddressId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: a0ef57fa-395c-4a03-96e9-234c26dccea9 + - in: header + name: X-HM-JWT-AUTH-HEADER + schema: + type: string + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + description: The JWT of the logged in customer (in case of a web shop). + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + v2.0: + value: + { + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 0, + "language": { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl" + }, + "billingAddressId": 1, + "shippingAddressId": 1, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatus": + [ + { + "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", + "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "createdOn": "2024-03-22T09:00:00", + "description": "Order is aangemaakt", + } + ], + "orderLines": null, + "payments": null, + "customer": + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "addresses": null + } + } + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "type": "https://htm.nl/api/v1/probs/validationerror", + "title": "Your request is not valid.", + "detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", + "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", + "errors": [ + { + "detail": "Product requires product with productId=2", + "pointer": "#/1/orderLine", + "orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d", + "productId": 3 + } + ] + } + /orders/{orderId}/fulfill: parameters: - in: path From bd3f3e68a65de82466b6e58ea43a38229b23e061 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Wed, 26 Feb 2025 16:17:17 +0100 Subject: [PATCH 7/9] Addede delete address to CRUD --- src/openapi/orders/orders-crud.yaml | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index c3b3115..538c913 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -1919,7 +1919,6 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: { "mandateInputId": "dbbc3913-414e-4528-9c95-6c11a11e04ac" } - /mandateinputs/{mandateInputId}: parameters: - in: path @@ -2245,6 +2244,27 @@ paths: { "orderCustomerAddressId": "d5005529-d4f2-4552-a5b8-477dab7836ec", } + delete: + summary: P3. Delete an address of a customer on an order. + description: Delete an address of a customer on an order. + tags: + - Customer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: { + + } + components: securitySchemes: bearerToken: From e2c768804a5c0be67c4249e49d2ce54ace1bd111 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Wed, 5 Mar 2025 10:48:09 +0100 Subject: [PATCH 8/9] fixed semantic error CRUD order --- src/openapi/orders/orders-crud.yaml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index 538c913..1dd008e 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -2249,11 +2249,6 @@ paths: description: Delete an address of a customer on an order. tags: - Customer - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" responses: "200": description: OK @@ -2261,10 +2256,7 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: { - - } - + example: {} components: securitySchemes: bearerToken: From 38674787182ec0286d480f7f7a249087244ef8fa Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Wed, 5 Mar 2025 11:42:50 +0100 Subject: [PATCH 9/9] fixed my search&replace errors --- src/openapi/orders/orders-crud.yaml | 4 +- src/openapi/orders/service_engine_orders.yaml | 43 +++++++++---------- 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index 1dd008e..1f4c370 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -1423,7 +1423,7 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", } responses: - "200": + "201": description: OK content: application/json: @@ -1912,7 +1912,7 @@ paths: "place": "Den Haag", } responses: - "200": + "201": description: OK content: application/json: diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index d0de7bd..1c36967 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -4,7 +4,7 @@ info: version: "1.0" description: Order APIs available in the Service Engine for order validation and fulfillment. servers: - - url: https://api.integratielaag.nl/v1 + - url: https://api.integratielaag.nl/v2 paths: /orders/validation: post: @@ -186,7 +186,7 @@ paths: "validFrom": "2024-03-22T09:00:00", "validUntil": null, "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "isRenewable": true, @@ -232,7 +232,7 @@ paths: "validFrom": "2024-03-22T09:00:00", "validUntil": null, "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "isRenewable": true, @@ -437,7 +437,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -599,7 +599,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -730,7 +730,7 @@ paths: description: The JWT of the logged in customer (in case of a web shop). get: tags: - - Order Retrieval v1.1 + - Order Retrieval v2.1 summary: Get all orders for a specific customer. description: Get all orders for a specific customer. responses: @@ -871,7 +871,7 @@ paths: example: 7208e73e-87a6-46d9-bb6d-867ffc460c9b description: xTat used in order fulfillment. Note that this is a joined parameter via PurchasedProduct. tags: - - Order Retrieval v1.1 + - Order Retrieval v2.1 summary: Find orders. description: Find orders. responses: @@ -1363,7 +1363,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -1567,7 +1567,7 @@ paths: "taxMetadata": { "taxMetadataId": "06270769-a263-4325-82d6-f49396f39d03", - "taxCode": "V11", + "taxCode": "V21", "taxPercentageAmount": 21, "description": "21% BTW", }, @@ -1773,7 +1773,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2083,7 +2083,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2133,7 +2133,7 @@ paths: "productCode": "HTM-MND-40", "productDescription": "HTM Maandkorting 40%", "taxAmount": 42, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 200, "amountInclTax": 242, "quantity": 1, @@ -2345,7 +2345,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2697,7 +2697,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -2740,7 +2740,7 @@ paths: "productCode": "HTM-MND-40", "productDescription": "HTM Maandkorting 40%", "taxAmount": 42, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 200, "amountInclTax": 242, "quantity": 1, @@ -2931,7 +2931,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3154,7 +3154,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3317,7 +3317,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3421,7 +3421,7 @@ paths: "country": "NL", } responses: - "200": + "201": description: OK content: application/json: @@ -3472,7 +3472,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3630,7 +3630,7 @@ paths: "productCode": "HTM-MND-20", "productDescription": "HTM Maandkorting 20%", "taxAmount": 21, - "taxCode": "V11", + "taxCode": "V21", "amountExclTax": 100, "amountInclTax": 121, "quantity": 1, @@ -3791,7 +3791,6 @@ paths: } ] } - /orders/{orderId}/fulfill: parameters: - in: path