diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 715653a..4919cac 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -147,8 +147,6 @@ paths: "iso639Code": "nl-NL", "ietfCode": "nl", }, - "billingAddressId": 1, - "shippingAddressId": 1, "createdOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00", "order_OrderStatuses": @@ -159,7 +157,43 @@ paths: "createdOn": "2024-03-22T09:00:00", "description": "Order succesvol betaald", }, - "orderLines": [], + "orderLines": + [ + { + "orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", + "externalOrderLineId": null, + "productId": 1, + "productName": "HTM Maandkorting 20%", + "fikoArticleNumber": "6609", + "productDescription": "HTM Maandkorting 20%", + "taxCode": "V21", + "taxPercentage": 21.0000, + "taxAmount": null, + "amountExclTax": null, + "amountInclTax": 121, + "quantity": 1, + "orderLineTerms": + [ + { + "orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", + "termsUrl": "generalTermsAndConditions.pdf", + }, + { + "orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87", + "termsUrl": "productTermsAndConditions.pdf", + }, + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { + "orderLineStatusId": 1, + "name": "pending", + }, + "customerTokens": null, + }, + ], "payments": [ { @@ -264,8 +298,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -313,7 +347,7 @@ paths: }, "ovPayToken": { - "customerProfileId": 1, + "customerProfileId": 1337, "ovPayTokenId": 1, "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", "tokenType": @@ -529,8 +563,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -776,8 +810,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -953,8 +987,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -1131,8 +1165,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -1346,8 +1380,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -1603,7 +1637,7 @@ paths: { "productId": 2, "quantity": 1, - "createdOn": "2024-03-22T09:00:00" + "createdOn": "2024-03-22T09:00:00", } responses: "200": @@ -1617,7 +1651,7 @@ paths: summary: AddRemark chosen product is not a leaf node product description: AddRemark for case where chosen product is not a leaf node product value: - { + { "validContents": false, "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, @@ -1661,8 +1695,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -1685,7 +1719,8 @@ paths: [ { "customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e", - "tokenType": { "tokenTypeId": 1, "name": "EMV" }, + "tokenType": + { "tokenTypeId": 1, "name": "EMV" }, "ovPayTokenId": 12, "serviceReferenceId": null, "amount": null, @@ -1770,23 +1805,24 @@ paths: ], "orderAccountingStatuses": [], "validationResult": "preliminary", - "additionalRemarks": [ + "additionalRemarks": + [ { "code": "PRODUCT_CHOICE_REQUIRED", "parameter": "orderline.productId", - } - ], + }, + ], "validationErrors": [], }, ], "payments": [], - "orderCustomers": null + "orderCustomers": null, } Create order line with minimum requirements: summary: Create order line with minimum requirements - description: AddRemark for case where chosen product requires personal account data birthdate + description: AddRemark for case where chosen product requires personal account data birthdate value: - { + { "validContents": false, "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, @@ -1830,8 +1866,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -1940,20 +1976,21 @@ paths: ], "orderAccountingStatuses": [], "validationResult": "preliminary", - "additionalRemarks": [ + "additionalRemarks": + [ { "code": "PERSONALACCOUNTDATA_BIRTHDATE_REQUIRED", "parameter": "personalaccountdata.birthdate", - }, + }, { "code": "TOKEN_REQUIRED", "parameter": "customerToken", - }, + }, { "code": "VALIDFROM_REQUIRED", "parameter": "orderline.validFrom", - } - ], + }, + ], "validationErrors": [], }, ], @@ -2080,8 +2117,8 @@ paths: "productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65", "taxCode": "V09", "taxPercentage": 9.0000, - "taxAmount": 488, - "amountExclTax": 5412, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 5900, "quantity": 1, "orderLineTerms": @@ -2221,27 +2258,27 @@ paths: ], } /orderlines/{orderLineId}/customertokens: - parameters: - - in: path - name: orderLineId - required: true - style: simple - explode: false - schema: - type: string - format: uuid - example: a0ef57fa-395c-4a03-96e9-234c26dccea9 - - in: header - name: X-HTM-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). - post: - tags: + parameters: + - in: path + name: orderLineId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: a0ef57fa-395c-4a03-96e9-234c26dccea9 + - in: header + name: X-HTM-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). + post: + tags: - Order Creation Flow summary: Add a customer token to an orderLine. - description: Add a customer token to an orderLine. + description: Add a customer token to an orderLine. requestBody: content: application/json: @@ -2324,8 +2361,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -2448,24 +2485,24 @@ paths: "orderCustomers": null, } /customertokens/{customerTokenId}: - parameters: - - in: path - name: customerTokenId - required: true - style: simple - explode: false - schema: - type: string - format: uuid - example: a0ef57fa-395c-4a03-96e9-234c26dccea9 - - in: header - name: X-HTM-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). - patch: - tags: + parameters: + - in: path + name: customerTokenId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: a0ef57fa-395c-4a03-96e9-234c26dccea9 + - in: header + name: X-HTM-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). + patch: + tags: - Order Creation Flow summary: Update a customer token. description: Update a customer token. @@ -2539,8 +2576,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -2568,78 +2605,81 @@ paths: "serviceReferenceId": "NLOV1234567ABCDEFG", "amount": 34, "personalAccountData": null, + "ovPayToken": + { + "customerProfileId": 1, + "ovPayTokenId": 1, + "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", + "tokenType": + { + "tokenTypeId": 2, + "name": "OV-pas physical", + }, + "alias": "MyToken", + "tokenStatus": + { + "tokenStatusId": 2, + "name": "Active", + }, + "expirationDate": "2028-02-01", + "replacedByTokenId": null, + }, + "autoReloadRegistration": + { + "autoReloadAmount": 500, + "retailerReferenceId": "abc", + "arrit": "425f7fc2-1103-4822-9c79-7c4aaa2fb6aa", + "autoReloadRegistrationStatus": "ACTIVE", + "autoReloadRegistrationStartDateTime": "2024-06-02T15:03:46Z", + }, + "ePurse": + { + "e-PurseBalance": + { "currency": "EUR", "amount": 350 }, + "status": "ACTIVE", + "originDate": "2019-07-16T11:00:00+02:00", + }, + "gboPersonalAccountData": + { + "name": + { + "inaccuracyFlag": false, + "inaccuracyFlagReason": null, + "inaccuracyFlagSetCounter": 0, + "isValidated": false, + "changeCounter": 0, + "maxUpdatesVerificationCount": 0, + "lastChangeDate": "2024-08-24T14:15:22Z", + }, + "birthdate": + { + "inaccuracyFlag": false, + "inaccuracyFlagReason": null, + "inaccuracyFlagSetCounter": 0, + "isValidated": false, + "changeCounter": 0, + "maxUpdatesVerificationCount": 0, + "lastChangeDate": "2024-08-24T14:15:22Z", + }, + "photo": + { + "inaccuracyFlag": false, + "inaccuracyFlagReason": null, + "inaccuracyFlagSetCounter": 0, + "isValidated": false, + "changeCounter": 0, + "maxUpdatesVerificationCount": 0, + "lastChangeDate": "2024-08-24T14:15:22Z", + }, + }, + "gboAgeProfile": + { + "gboAgeProfileId": 1, + "name": "Kind (4 t/m 11 jaar)", + "ageFromInclusive": 4, + "ageToInclusive": 11, + }, }, - "ovPayToken": - { - "customerProfileId": 1, - "ovPayTokenId": 1, - "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", - "tokenType": - { - "tokenTypeId": 2, - "name": "OV-pas physical", - }, - "alias": "MyToken", - "tokenStatus": - { "tokenStatusId": 2, "name": "Active" }, - "expirationDate": "2028-02-01", - "replacedByTokenId": null, - }, - "autoReloadRegistration": - { - "autoReloadAmount": 500, - "retailerReferenceId": "abc", - "arrit": "425f7fc2-1103-4822-9c79-7c4aaa2fb6aa", - "autoReloadRegistrationStatus": "ACTIVE", - "autoReloadRegistrationStartDateTime": "2024-06-02T15:03:46Z", - }, - "ePurse": - { - "e-PurseBalance": - { "currency": "EUR", "amount": 350 }, - "status": "ACTIVE", - "originDate": "2019-07-16T11:00:00+02:00", - }, - "gboPersonalAccountData": - { - "name": - { - "inaccuracyFlag": false, - "inaccuracyFlagReason": null, - "inaccuracyFlagSetCounter": 0, - "isValidated": false, - "changeCounter": 0, - "maxUpdatesVerificationCount": 0, - "lastChangeDate": "2024-08-24T14:15:22Z", - }, - "birthdate": - { - "inaccuracyFlag": false, - "inaccuracyFlagReason": null, - "inaccuracyFlagSetCounter": 0, - "isValidated": false, - "changeCounter": 0, - "maxUpdatesVerificationCount": 0, - "lastChangeDate": "2024-08-24T14:15:22Z", - }, - "photo": - { - "inaccuracyFlag": false, - "inaccuracyFlagReason": null, - "inaccuracyFlagSetCounter": 0, - "isValidated": false, - "changeCounter": 0, - "maxUpdatesVerificationCount": 0, - "lastChangeDate": "2024-08-24T14:15:22Z", - }, - }, - "gboAgeProfile": - { - "gboAgeProfileId": 1, - "name": "Kind (4 t/m 11 jaar)", - "ageFromInclusive": 4, - "ageToInclusive": 11, - }, ], "orderAccountingStatuses": [], "validationResult": "valid", @@ -2651,10 +2691,10 @@ paths: "orderCustomers": null, } delete: - tags: + tags: - Order Creation Flow summary: Delete a customer token from an orderline. - description: Delete a customer token from an orderline. + description: Delete a customer token from an orderline. responses: "200": description: OK @@ -2709,8 +2749,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -2746,24 +2786,24 @@ paths: "orderCustomers": null, } /customertokens/{customerTokenId}/personalaccountdata: - parameters: - - in: path - name: customerTokenId - required: true - style: simple - explode: false - schema: - type: string - format: uuid - example: a0ef57fa-395c-4a03-96e9-234c26dccea9 - - in: header - name: X-HTM-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). - post: - tags: + parameters: + - in: path + name: customerTokenId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: a0ef57fa-395c-4a03-96e9-234c26dccea9 + - in: header + name: X-HTM-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). + post: + tags: - Order Creation Flow summary: Add personal account data to a customer token. description: Add personal account data to a customer token. @@ -2838,8 +2878,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -2964,24 +3004,24 @@ paths: "orderCustomers": null, } /personalaccountdata/{personalAccountDataId}: - parameters: - - in: path - name: personalAccountDataId - required: true - style: simple - explode: false - schema: - type: string - format: uuid - example: d9021fdd-6e83-45c0-9aef-71680f0b4e74 - - in: header - name: X-HTM-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). - patch: - tags: + parameters: + - in: path + name: personalAccountDataId + required: true + style: simple + explode: false + schema: + type: string + format: uuid + example: d9021fdd-6e83-45c0-9aef-71680f0b4e74 + - in: header + name: X-HTM-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). + patch: + tags: - Order Creation Flow summary: Update personal account data. description: Update personal account data. @@ -3049,8 +3089,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -3178,10 +3218,10 @@ paths: }, ], "payments": [], - "orderCustomer": null - } - delete: - tags: + "orderCustomer": null, + } + delete: + tags: - Order Creation Flow summary: Delete personal account data. description: Delete personal account data. @@ -3239,8 +3279,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -3460,8 +3500,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -3525,8 +3565,8 @@ paths: "productDescription": "HTM Maandkorting 40%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 42, - "amountExclTax": 200, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 242, "quantity": 1, "orderLineTerms": @@ -3755,8 +3795,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -3947,8 +3987,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -4219,8 +4259,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -4463,8 +4503,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -4709,8 +4749,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -4961,8 +5001,8 @@ paths: "productDescription": "HTM Maandkorting 20%", "taxCode": "V21", "taxPercentage": 21.0000, - "taxAmount": 21, - "amountExclTax": 100, + "taxAmount": null, + "amountExclTax": null, "amountInclTax": 121, "quantity": 1, "orderLineTerms": @@ -5308,7 +5348,7 @@ paths: description: verification code belonging to the OVpas number schema: type: string - example: 1A3C7D + example: 1A3C7D responses: "200": description: OK @@ -5414,4 +5454,4 @@ components: example: 4 ageToInclusive: type: integer - example: 11 \ No newline at end of file + example: 11