diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 214836a..4565ca9 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -124,7 +124,7 @@ paths: "startDate": "2024-03-22T09:00:00z", "quantity": 4, }, - ] + ] responses: "200": description: OK @@ -685,32 +685,33 @@ paths: ], }, } - "400": + "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.", + { + "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 - } - ] + "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: @@ -882,7 +883,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - { + { "orders": [ { @@ -973,7 +974,7 @@ paths: post: tags: - Order Creation v2.0 - summary: Create a new order v2.0. + summary: Create a new order v2.0. description: Create a new order v2.0. requestBody: content: @@ -990,7 +991,6 @@ paths: "languageId": 1, "billingAddressId": 1, "shippingAddressId": 1, - "orderStatusId": 1, "orderLines": [ { @@ -1000,78 +1000,8 @@ paths: "validFrom": "2024-03-22T09:00:00", "validUntil": null, "orderLineStatusId": 1, - "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", - } - ] - } } v1.2: summary: Order creation v1.2 @@ -1319,137 +1249,78 @@ paths: $ref: "#/components/schemas/unavailable" examples: v2.0: - value: + value: { - "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", - "externalOrderId": null, - "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "totalAmount": 121, - "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": - [ - { - "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", - } - }, - ], - "additionalRemarks" : [] - }, - ], - "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": + "order": { - "birthname": "Jan", - "surname": "Vries", - "prefix": "de", - "emailAddress": "jandevries@outlook.com", - "dateOfBirth": "1970-01-01", - "addresses": + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "totalAmount": 121, + "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": [ { - "addressTypeId": 1, - "street": "Kon. Julianaplein", - "houseNumber": 10, - "houseNumberSuffix": "a", - "postalCode": "2595 AA", - "city": "Den Haag", - "country": "NL", - } - ] - } + "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" }, + }, + ], + }, + "orderValidation": + { + "validationResult": true, + "additionalRemarks": + [{ "code": "string", "parameter": "string" }], + "validationErrors": + [{ "detail": "string", "pointer": "string" }], + }, } v1.2: value: @@ -1457,32 +1328,33 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderNumber": "ORD-123456", } - "400": + "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.", + { + "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 - } - ] + "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: @@ -1704,23 +1576,25 @@ paths: v2.0: summary: Order update v2.0 description: Order update v2.0 - value: { - "languageId": 1, - "billingAddressId": 2, - "shippingAddressId": 1, - "lastUpdatedOn": "2024-03-22T09:00:00", - } + value: + { + "languageId": 1, + "billingAddressId": 2, + "shippingAddressId": 1, + "lastUpdatedOn": "2024-03-22T09:00:00", + } v1.2: summary: Order update v1.2 description: Order update v1.2 - value: { - "customerProfileId": 1337, - "totalAmount": 121, - "languageId": 1, - "billingAddressId": 1, - "shippingAddressId": 1, - "lastUpdatedOn": "2024-03-22T09:00:00", - } + value: + { + "customerProfileId": 1337, + "totalAmount": 121, + "languageId": 1, + "billingAddressId": 1, + "shippingAddressId": 1, + "lastUpdatedOn": "2024-03-22T09:00:00", + } responses: "200": description: OK @@ -1730,19 +1604,20 @@ paths: $ref: "#/components/schemas/unavailable" examples: v2.0: - value: + value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -1758,10 +1633,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -1806,14 +1682,14 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - "additionalRemarks" : + ], + "additionalRemarks": [ - { + { "code": "MANDATE_REQUIRED", - "parameter": "directDebitMandateId" - } - ] + "parameter": "directDebitMandateId", + }, + ], }, ], "payments": @@ -1863,9 +1739,9 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: value: @@ -1873,32 +1749,33 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "orderNumber": "ORD-123456", } - "400": + "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.", + { + "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 - } - ] + "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: @@ -1908,25 +1785,26 @@ paths: responses: "200": description: OK - "400": + "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.", + { + "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 - } - ] + "errors": + [ + { + "detail": "Order status is paid", + "pointer": "#/order_OrderStatus/1/orderStatus/orderStatusId", + "orderStatusId": 4, + }, + ], } /orders/{orderId}/orderlines: parameters: @@ -1958,11 +1836,11 @@ paths: examples: v2.0: summary: Create orderLine v2.0 - description: Create orderLine v2.0 + description: Create orderLine v2.0 value: { "externalOrderLineId": null, - "productId": 2, + "productId": 2, "quantity": 1, "validFrom": "2024-03-22T09:00:00", "validUntil": null, @@ -1974,16 +1852,16 @@ paths: "tokenTypeId": 1, "ovPayTokenId": 4, "serviceReferenceId": null, - "amount": null , - "ovpasNumber": null , - "verificationCode": null , - "personalAccountData": null + "amount": null, + "ovpasNumber": null, + "verificationCode": null, + "personalAccountData": null, }, - ] + ], } v1.2: summary: Create orderLine v1.2 - description: Create orderLine v1.2 + description: Create orderLine v1.2 value: { "externalOrderLineId": null, @@ -2040,19 +1918,20 @@ paths: $ref: "#/components/schemas/unavailable" examples: v2.0: - value: + value: { "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -2068,10 +1947,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -2116,15 +1996,15 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - "additionalRemarks" : + ], + "additionalRemarks": [ - { + { "code": "MANDATE_REQUIRED", - "parameter": "directDebitMandateId" - } - ] - }, + "parameter": "directDebitMandateId", + }, + ], + }, { "orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71", "externalOrderLineId": null, @@ -2153,14 +2033,14 @@ paths: "tokenTypeId": 1, "ovPayTokenId": 4, "serviceReferenceId": null, - "amount": null , - "ovpasNumber": null , - "verificationCode": null , - "personalAccountData": null - } - ], - "additionalRemarks" : [] - } + "amount": null, + "ovpasNumber": null, + "verificationCode": null, + "personalAccountData": null, + }, + ], + "additionalRemarks": [], + }, ], "payments": [ @@ -2209,38 +2089,40 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: - value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } - "400": + 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.", + { + "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 - } - ] + "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: @@ -2272,16 +2154,16 @@ paths: examples: v2.0: summary: Orderline update v2.0 - description: Orderline update v2.0 + description: Orderline update v2.0 value: - { + { "quantity": 1, "validFrom": "2024-03-25T09:00:00", - "validUntil": null + "validUntil": null, } v1.2: - summary: Orderline updatev1.2 - description: Orderline update v1.2 + summary: Orderline updatev1.2 + description: Orderline update v1.2 value: { "taxAmount": 21, @@ -2300,7 +2182,7 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - examples: + examples: v2.0: value: { @@ -2309,12 +2191,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -2330,10 +2213,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -2376,16 +2260,16 @@ paths: "fileType": "image/jpg", "challengeTypeId": 1, "oneTimePassword": "H5Iiz3JTaQeIV8p", - } - } - ], - "additionalRemarks" : + }, + }, + ], + "additionalRemarks": [ - { + { "code": "MANDATE_REQUIRED", - "parameter": "directDebitMandateId" - } - ] + "parameter": "directDebitMandateId", + }, + ], }, ], "payments": @@ -2435,33 +2319,34 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: value: { "orderLineId": "e78b78d9-4fb0-4a9c-8dc0-6d100c9f1b3f" } - "400": + "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.", + { + "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 - } - ] + "errors": + [ + { + "detail": "Startdate of this product should be at most 60 days in the future.", + "pointer": "#/0/startDate", + "ovPayTokenId": 123, + "productId": 2, + }, + ], } delete: tags: @@ -2484,12 +2369,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 0, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -2505,10 +2391,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": null, "payments": null, @@ -2529,30 +2416,31 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } - "400": + "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.", + { + "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 - } - ] + "errors": + [ + { + "detail": "Product requires product with productId=2", + "pointer": "#/1/orderLine", + "orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d", + "productId": 3, + }, + ], } /orders/{orderId}/payments: parameters: @@ -2582,9 +2470,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - v2.0: + v2.0: summary: Order creation v2.0 - description: Order creation v2.0 + description: Order creation v2.0 value: { "createdOn": "2024-03-22T09:00:00", @@ -2613,9 +2501,9 @@ paths: "place": "Den Haag", }, } - v1.2: + v1.2: summary: Order creation v1.2 - description: Order creation v1.2 + description: Order creation v1.2 value: { "createdOn": "2024-03-22T09:00:00", @@ -2661,12 +2549,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -2682,10 +2571,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -2731,7 +2621,7 @@ paths: }, }, ], - }, + }, { "orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71", "externalOrderLineId": null, @@ -2760,14 +2650,14 @@ paths: "tokenTypeId": 1, "ovPayTokenId": 4, "serviceReferenceId": null, - "amount": null , - "ovpasNumber": null , - "verificationCode": null , - "personalAccountData": null - } - ] - } - ], + "amount": null, + "ovpasNumber": null, + "verificationCode": null, + "personalAccountData": null, + }, + ], + }, + ], "payments": [ { @@ -2815,13 +2705,12 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: - value: - { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } + value: { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } /payments/{paymentId}: parameters: - in: path @@ -2852,7 +2741,7 @@ paths: examples: v2.0: summary: Order payment update v2.0 - description: Order payment update v2.0 + description: Order payment update v2.0 value: { "htmPaymentReference": "HTM-1234", @@ -2875,11 +2764,11 @@ paths: "iban": "NL44RABO0123456789", "ascription": "J. de Vries", "place": "Den Haag", - } + }, } v1.2: summary: Order payment update v1.2 - description: Order payment update v1.2 + description: Order payment update v1.2 value: { "htmPaymentReference": "HTM-1234", @@ -2901,12 +2790,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchpointId": 3, @@ -2916,10 +2806,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -2965,8 +2856,8 @@ paths: }, }, ], - } - ], + }, + ], "payments": [ { @@ -3021,13 +2912,12 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: - value: - { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } + value: { "paymentId": "94270188-4cf6-447e-bd49-e8186bcec073" } /orders/{orderId}/ordercustomers: parameters: - in: path @@ -3058,7 +2948,7 @@ paths: examples: v2.0: summary: Order payment update v2.0 - description: Order payment update v2.0 + description: Order payment update v2.0 value: { "birthname": "Jan", @@ -3081,7 +2971,7 @@ paths: } v1.2: summary: Order payment update v1.2 - description: Order payment update v1.2 + description: Order payment update v1.2 value: { "birthname": "Jan", @@ -3118,12 +3008,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -3139,10 +3030,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -3188,8 +3080,8 @@ paths: }, }, ], - } - ], + }, + ], "payments": null, "customer": { @@ -3208,13 +3100,15 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: value: - { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } + { + "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073", + } /ordercustomers/{orderCustomerId}: patch: parameters: @@ -3245,8 +3139,8 @@ paths: examples: v2.0: summary: Order customer update v2.0 - description: Order customer update v2.0 - value: + description: Order customer update v2.0 + value: { "birthname": "Jan", "surname": "Vries", @@ -3256,8 +3150,8 @@ paths: } v1.2: summary: Order customer update v1.2 - description: Order customer update v1.2 - value: + description: Order customer update v1.2 + value: { "birthname": "Jan", "surname": "Vries", @@ -3281,12 +3175,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -3302,10 +3197,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -3350,9 +3246,9 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - "additionalRemarks" : [] - } + ], + "additionalRemarks": [], + }, ], "payments": null, "customer": @@ -3372,13 +3268,15 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } + }, + ], + }, } v1.2: - value: - { "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073" } + value: + { + "orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073", + } /ordercustomers/{orderCustomerId}/orderCustomerAddress: post: parameters: @@ -3409,8 +3307,8 @@ paths: examples: v2.0: summary: Order customer address create v1.2 - description: Order customer address create v1.2 - value: + description: Order customer address create v1.2 + value: { "addressTypeId": 1, "street": "Kon. Julianaplein", @@ -3436,12 +3334,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 2, "shippingAddressId": 1, "touchPoint": @@ -3457,10 +3356,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -3505,15 +3405,15 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - "additionalRemarks" : + ], + "additionalRemarks": [ - { + { "code": "MANDATE_REQUIRED", - "parameter": "directDebitMandateId" - } - ] - } + "parameter": "directDebitMandateId", + }, + ], + }, ], "payments": null, "customer": @@ -3533,10 +3433,10 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } - } + }, + ], + }, + } /orderCustomerAddress/{orderCustomerAddressId}: patch: parameters: @@ -3567,8 +3467,8 @@ paths: examples: v2.0: summary: Order customer address create v1.2 - description: Order customer address create v1.2 - value: + description: Order customer address create v1.2 + value: { "addressTypeId": 1, "street": "Kon. Julianaplein", @@ -3594,12 +3494,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 121, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -3615,10 +3516,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": [ @@ -3663,15 +3565,15 @@ paths: "oneTimePassword": "H5Iiz3JTaQeIV8p", }, }, - ], - "additionalRemarks" : + ], + "additionalRemarks": [ - { + { "code": "MANDATE_REQUIRED", - "parameter": "directDebitMandateId" - } - ] - } + "parameter": "directDebitMandateId", + }, + ], + }, ], "payments": null, "customer": @@ -3691,10 +3593,10 @@ paths: "postalCode": "2595 AA", "city": "Den Haag", "country": "NL", - } - ] - } - } + }, + ], + }, + } delete: tags: - Order Creation v2.0 @@ -3732,12 +3634,13 @@ paths: "orderNumber": "ORD-123456", "customerProfileId": 1337, "totalAmount": 0, - "language": { + "language": + { "languageId": 1, "name": "Nederlands", "iso639Code": "nl-NL", - "ietfCode": "nl" - }, + "ietfCode": "nl", + }, "billingAddressId": 1, "shippingAddressId": 1, "touchPoint": @@ -3753,10 +3656,11 @@ paths: [ { "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": { "orderStatusId": 1, "name": "concept" }, + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, "createdOn": "2024-03-22T09:00:00", "description": "Order is aangemaakt", - } + }, ], "orderLines": null, "payments": null, @@ -3767,29 +3671,30 @@ paths: "prefix": "de", "emailAddress": "jandevries@outlook.com", "dateOfBirth": "1970-01-01", - "addresses": null - } + "addresses": null, + }, } - "400": + "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.", + { + "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 - } - ] + "errors": + [ + { + "detail": "Product requires product with productId=2", + "pointer": "#/1/orderLine", + "orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d", + "productId": 3, + }, + ], } /orders/{orderId}/fulfill: parameters: