From b6a490c979bcb86b6565aa98a2241d19131f4f88 Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Wed, 9 Sep 2026 10:54:38 +0200 Subject: [PATCH] added AGO status to order response --- src/AGO_Examples_20260904.curl | 0 src/openapi/orders/service_engine_orders.yaml | 1002 +++++++++-------- .../products/SE-vouchers-supplier.yaml | 7 + 3 files changed, 569 insertions(+), 440 deletions(-) create mode 100644 src/AGO_Examples_20260904.curl diff --git a/src/AGO_Examples_20260904.curl b/src/AGO_Examples_20260904.curl new file mode 100644 index 0000000..e69de29 diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 338f74e..ff82a5f 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -133,7 +133,7 @@ paths: "orderNumber": "123456", "customerProfileId": 42, "device": null, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -173,7 +173,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -262,12 +262,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device": { - "externalDeviceId": "123e4567-e89b-12d3-a456-426614174000", - "alias": null, - }, - "vouchers":[], + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "123e4567-e89b-12d3-a456-426614174000", + "alias": null, + }, + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -309,7 +310,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -430,6 +431,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -494,11 +500,7 @@ paths: { "externalOrderLineId": null, "productId": 1, - "vouchers":[ - { - "voucherCode": "Voucher1234" - } - ], + "vouchers": [{ "voucherCode": "Voucher1234" }], "quantity": 1, "validFrom": "2024-03-22T09:00:00", "validUntil": null, @@ -540,10 +542,12 @@ paths: "externalOrderId": null, "orderNumber": "ORD-123456", "customerProfileId": 1337, - "device":{ - "externalDeviceId": "9d03ca60-d2ab-4429-830d-49e12d0a29d4", - "alias": null }, - "vouchers":[], + "device": + { + "externalDeviceId": "9d03ca60-d2ab-4429-830d-49e12d0a29d4", + "alias": null, + }, + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -585,7 +589,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -703,6 +707,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -795,11 +804,12 @@ paths: "externalOrderId": null, "orderNumber": "ORD-123456", "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -841,7 +851,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -947,6 +957,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -980,9 +995,9 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, + "customerProfileId": 1337, "device": null, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -1024,7 +1039,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -1142,6 +1157,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -1175,12 +1195,13 @@ paths: "orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d", "externalOrderId": "bac3958b-804a-43e3-b5f7-0b0fffaae5b7", "orderNumber": "123456", - "customerProfileId": 42, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": null + "customerProfileId": 42, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": null, }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -1229,7 +1250,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -1383,11 +1404,12 @@ paths: Update order languageId: summary: Update order languageId description: Update order languageId - value: { "languageId": 1} + value: { "languageId": 1 } Add externalDeviceId: summary: Add order externalDeviceId description: Add order externalDeviceId - value: { "externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0"} + value: + { "externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0" } responses: "200": description: OK @@ -1403,9 +1425,9 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, + "customerProfileId": 1337, "device": null, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -1447,7 +1469,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -1565,6 +1587,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -1596,12 +1623,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device": { - "externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0", - "alias": null + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "f7f0c608-aa9c-4812-bbb6-b1e700d21da0", + "alias": null, }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -1643,7 +1671,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -1761,6 +1789,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -1877,11 +1910,7 @@ paths: { "externalOrderLineId": null, "productId": 2, - "vouchers":[ - { - "voucherCode": "HTM-787466" - } - ], + "vouchers": [{ "voucherCode": "HTM-787466" }], "quantity": 1, "validFrom": "2024-03-22T09:00:00", "validUntil": null, @@ -1925,9 +1954,9 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, + "customerProfileId": 1337, "device": null, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -1969,29 +1998,30 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[ - { - "issuedVoucherId": "8e405272-470f-4ed6-8303-791ab40e72b5", - "voucherCode": "HTM-787466", - "fromInclusive": "2025-10-04T00:00:00.000", - "untilInclusive": "2026-11-04T00:00:00.000", - "voucherStatus": - { "voucherStatusId": 1, "name": "New" }, - "product": - { - "productId": 263, - "productName": "HTM-80001", - "productDescription": "10 euro korting op HTM maandkorting 20%", - "productCategory": + "vouchers": + [ + { + "issuedVoucherId": "8e405272-470f-4ed6-8303-791ab40e72b5", + "voucherCode": "HTM-787466", + "fromInclusive": "2025-10-04T00:00:00.000", + "untilInclusive": "2026-11-04T00:00:00.000", + "voucherStatus": + { "voucherStatusId": 1, "name": "New" }, + "product": + { + "productId": 263, + "productName": "HTM-80001", + "productDescription": "10 euro korting op HTM maandkorting 20%", + "productCategory": { "productCategoryId": 9, "isTravelProduct": false, "name": "Voucher", }, - "amountInclTax": -1000, - "requiredProducts": + "amountInclTax": -1000, + "requiredProducts": [ - { + { "productId": 1, "productName": "HTM-30001", "productDescription": "HTM Maandkorting 20%", @@ -2014,19 +2044,19 @@ paths: }, }, }, - "mandatoryCustomerDataItems": + "mandatoryCustomerDataItems": [ { "mandatoryCustomerDataItemId": 8, - "customerDataItem": "padBirthDate" + "customerDataItem": "padBirthDate", }, { "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" + "customerDataItem": "emailAddress", }, ], - } - ], + }, + ], "quantity": 1, "orderLineTerms": [ @@ -2132,6 +2162,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -2159,12 +2194,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -2206,7 +2242,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -2312,6 +2348,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -2419,12 +2460,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -2466,7 +2508,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 5900, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -2550,12 +2592,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 0, "touchPoint": { @@ -2674,12 +2717,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -2721,7 +2765,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -2827,6 +2871,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -2876,10 +2925,7 @@ paths: Add voucher to orderLine: summary: Add voucher to orderLine to receive voucher benefits for a specific product description: Add voucher to orderLine to receive voucher benefits for a specific product - value: - { - "voucherCode": "VOUCHER786" - } + value: { "voucherCode": "VOUCHER786" } responses: "200": description: OK @@ -2897,10 +2943,9 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, + "customerProfileId": 1337, "device": null, - "vouchers":[ - ], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -2942,30 +2987,31 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[ - { - "orderVoucherId": "d271c79d-2d3f-477b-8e29-73c9b409a758", - "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", - "voucherCode": "VOUCHER786", - "fromInclusive": "2024-10-04T00:00:00.000", - "untilInclusive": "2024-11-04T00:00:00.000", - "voucherStatus": - { "voucherStatusId": 1, "name": "New" }, - "product": - { - "productId": 263, - "productName": "HTM-80001", - "productDescription": "10 euro korting op HTM maandkorting 20%", - "productCategory": + "vouchers": + [ + { + "orderVoucherId": "d271c79d-2d3f-477b-8e29-73c9b409a758", + "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", + "voucherCode": "VOUCHER786", + "fromInclusive": "2024-10-04T00:00:00.000", + "untilInclusive": "2024-11-04T00:00:00.000", + "voucherStatus": + { "voucherStatusId": 1, "name": "New" }, + "product": + { + "productId": 263, + "productName": "HTM-80001", + "productDescription": "10 euro korting op HTM maandkorting 20%", + "productCategory": { "productCategoryId": 9, "isTravelProduct": false, "name": "Voucher", }, - "amountInclTax": -1000, - "requiredProducts": + "amountInclTax": -1000, + "requiredProducts": [ - { + { "productId": 1, "productName": "HTM-30001", "productDescription": "HTM Maandkorting 20%", @@ -2988,19 +3034,19 @@ paths: }, }, }, - "mandatoryCustomerDataItems": + "mandatoryCustomerDataItems": [ { "mandatoryCustomerDataItemId": 8, - "customerDataItem": "padBirthDate" + "customerDataItem": "padBirthDate", }, { "mandatoryCustomerDataItemId": 4, - "customerDataItem": "emailAddress" + "customerDataItem": "emailAddress", }, ], - } - ], + }, + ], "quantity": 1, "orderLineTerms": [ @@ -3106,6 +3152,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -3151,7 +3202,7 @@ paths: "productId": 3, }, ], - } + } /orders/{orderId}/vouchers: parameters: - in: path @@ -3183,10 +3234,7 @@ paths: Add voucher to concept order: summary: Add voucher to orderLine to receive voucher benefits for a whole order description: Add voucher to orderLine to receive voucher benefits for a whole order - value: - { - "voucherCode": "VOUCHER123" - } + value: { "voucherCode": "VOUCHER123" } responses: "200": description: OK @@ -3204,37 +3252,34 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, + "customerProfileId": 1337, "device": null, - "vouchers":[ - { - "orderVoucherId": "d271c79d-2d3f-477b-8e29-73c9b409a758", - "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", - "voucherCode": "VOUCHER123", - "fromInclusive": "2024-10-04T00:00:00.000", - "untilInclusive": "2024-11-04T00:00:00.000", - "voucherStatus": - { "voucherStatusId": 1, "name": "New" }, - "product": - { - "productId": 269, - "productName": "HTM-80001", - "productDescription": "10 euro korting op je gehel order", - "productCategory": + "vouchers": + [ + { + "orderVoucherId": "d271c79d-2d3f-477b-8e29-73c9b409a758", + "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", + "voucherCode": "VOUCHER123", + "fromInclusive": "2024-10-04T00:00:00.000", + "untilInclusive": "2024-11-04T00:00:00.000", + "voucherStatus": + { "voucherStatusId": 1, "name": "New" }, + "product": + { + "productId": 269, + "productName": "HTM-80001", + "productDescription": "10 euro korting op je gehel order", + "productCategory": { "productCategoryId": 9, "isTravelProduct": false, "name": "Voucher", }, - "amountInclTax": -1000, - "requiredProducts": - [ - ], + "amountInclTax": -1000, + "requiredProducts": [], }, - "mandatoryCustomerDataItems": - [ - ], - } + "mandatoryCustomerDataItems": [], + }, ], "totalAmount": 21, "touchPoint": @@ -3277,7 +3322,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -3383,6 +3428,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -3410,12 +3460,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -3457,7 +3508,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -3563,6 +3614,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -3616,7 +3672,7 @@ paths: "productId": 3, }, ], - } + } /customertokens/{customerTokenId}: parameters: - in: path @@ -3670,12 +3726,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -3717,7 +3774,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -3820,12 +3877,18 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], "orderAccountingStatuses": [], "validationResult": "valid", "additionalRemarks": [], + "validationErrors": [], }, ], @@ -3852,12 +3915,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -3899,7 +3963,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -3987,12 +4051,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -4034,7 +4099,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -4148,12 +4213,18 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], "orderAccountingStatuses": [], "validationResult": "valid", "additionalRemarks": [], + "validationErrors": [], }, ], @@ -4207,12 +4278,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": null + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": null, }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -4254,7 +4326,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -4368,12 +4440,18 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], "orderAccountingStatuses": [], "validationResult": "invalid", "additionalRemarks": [], + "validationErrors": [ { @@ -4406,12 +4484,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -4453,7 +4532,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -4559,12 +4638,18 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], "orderAccountingStatuses": [], "validationResult": "valid", "additionalRemarks": [], + "validationErrors": [], }, ], @@ -4629,12 +4714,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -4683,7 +4769,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -4745,7 +4831,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 242, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -4916,12 +5002,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -4977,7 +5064,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -5124,12 +5211,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": "be8160b3-a7f7-4a63-ad63-09503b2fc4a3", "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -5171,7 +5259,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -5398,12 +5486,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -5445,7 +5534,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -5563,12 +5652,18 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], "orderAccountingStatuses": [], "validationResult": "valid", "additionalRemarks": [], + "validationErrors": [], }, ], @@ -5651,12 +5746,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -5698,7 +5794,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -5816,12 +5912,18 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], "orderAccountingStatuses": [], "validationResult": "valid", "additionalRemarks": [], + "validationErrors": [], }, ], @@ -5906,12 +6008,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -5953,7 +6056,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -6071,6 +6174,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -6167,12 +6275,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 121, "touchPoint": { @@ -6214,7 +6323,7 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "vouchers": [], "quantity": 1, "orderLineTerms": [ @@ -6332,6 +6441,11 @@ paths: "ageFromInclusive": 4, "ageToInclusive": 11, }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, }, }, ], @@ -6408,12 +6522,13 @@ paths: "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", "externalOrderId": null, "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ - "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" + "customerProfileId": 1337, + "device": + { + "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", + "alias": "Mijn Android", }, - "vouchers":[], + "vouchers": [], "totalAmount": 0, "touchPoint": { @@ -6477,7 +6592,7 @@ paths: ], } /ordervouchers/{orderVoucherId}: - parameters: + parameters: - in: path name: orderVoucherId required: true @@ -6493,191 +6608,198 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: The JWT of the logged in customer (in case of a web shop). - delete: - tags: - - OrderVoucher - summary: Delete voucher from order or orderLine - description: Deletevoucher from order or orderLine - responses: - "200": - description: Ok - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" - examples: - Order with deleted voucher: - value: - { - "validContents": true, - "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", - "externalOrderId": null, - "orderNumber": "ORD-123456", - "customerProfileId": 1337, - "device":{ + delete: + tags: + - OrderVoucher + summary: Delete voucher from order or orderLine + description: Deletevoucher from order or orderLine + responses: + "200": + description: Ok + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + Order with deleted voucher: + value: + { + "validContents": true, + "orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df", + "externalOrderId": null, + "orderNumber": "ORD-123456", + "customerProfileId": 1337, + "device": + { "externalDeviceId": "8fe1e754-0070-478c-bdba-4ebd89c994f0", - "alias": "Mijn Android" - }, - "vouchers":[], - "totalAmount": 121, - "touchPoint": + "alias": "Mijn Android", + }, + "vouchers": [], + "totalAmount": 121, + "touchPoint": + { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailerId": 1001, + }, + "language": + { + "languageId": 1, + "name": "Nederlands", + "iso639Code": "nl-NL", + "ietfCode": "nl", + }, + "createdOn": "2024-03-22T09:00:00", + "lastUpdatedOn": "2024-03-22T09:00:00", + "order_OrderStatuses": + [ { - "salesTouchpointId": 3, - "name": "Website (Perplex)", - "isActive": true, - "retailerId": 1001, + "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", + "orderStatus": + { "orderStatusId": 1, "name": "concept" }, + "createdOn": "2024-03-22T09:00:00", + "description": "Order is aangemaakt", }, - "language": + ], + "orderLines": + [ { - "languageId": 1, - "name": "Nederlands", - "iso639Code": "nl-NL", - "ietfCode": "nl", + "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, + "vouchers": [], + "quantity": 1, + "orderLineTerms": + [ + { + "orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", + "termsUrl": "generalTermsAndConditions.pdf", + }, + { + "orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87", + "termsUrl": "productTermsAndConditions.pdf", + }, + ], + "createdOn": "2024-03-22T09:00:00", + "validFrom": "2024-03-22T09:00:00", + "validUntil": null, + "orderLineStatus": + { "orderLineStatusId": 1, "name": "pending" }, + "customerTokens": + [ + { + "customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e", + "tokenType": + { "tokenTypeId": 1, "name": "EMV" }, + "ovPayTokenId": 12, + "serviceReferenceId": null, + "amount": null, + "ovpasNumber": null, + "verificationCode": null, + "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", + }, + "personalAccountData": + { + "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, + }, + "tatSecurity": + { + "isSecured": false, + "isAuthorized": false, + }, + }, + }, + ], + "orderAccountingStatuses": [], + "validationResult": "valid", + "additionalRemarks": [], + + "validationErrors": [], }, - "createdOn": "2024-03-22T09:00:00", - "lastUpdatedOn": "2024-03-22T09:00:00", - "order_OrderStatuses": - [ - { - "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", - "orderStatus": - { "orderStatusId": 1, "name": "concept" }, - "createdOn": "2024-03-22T09:00:00", - "description": "Order is aangemaakt", - }, - ], - "orderLines": - [ - { - "orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", - "externalOrderLineId": null, - "productId": 1, - "productName": "HTM Maandkorting 20%", - "fikoArticleNumber": "6609", - "productDescription": "HTM Maandkorting 20%", - "taxCode": "V21", - "taxPercentage": 21.0000, - "taxAmount": null, - "amountExclTax": null, - "amountInclTax": 121, - "vouchers":[], - "quantity": 1, - "orderLineTerms": - [ - { - "orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468", - "termsUrl": "generalTermsAndConditions.pdf", - }, - { - "orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87", - "termsUrl": "productTermsAndConditions.pdf", - }, - ], - "createdOn": "2024-03-22T09:00:00", - "validFrom": "2024-03-22T09:00:00", - "validUntil": null, - "orderLineStatus": - { "orderLineStatusId": 1, "name": "pending" }, - "customerTokens": - [ - { - "customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e", - "tokenType": - { "tokenTypeId": 1, "name": "EMV" }, - "ovPayTokenId": 12, - "serviceReferenceId": null, - "amount": null, - "ovpasNumber": null, - "verificationCode": null, - "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", - }, - "personalAccountData": - { - "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", - "additionalRemarks": [], - "validationErrors": [], - }, - ], - "payments": [], - "orderCustomer": null, - } + ], + "payments": [], + "orderCustomer": null, + } /orders/{orderId}/fulfill: parameters: - in: path @@ -6882,23 +7004,23 @@ components: externalOrderId: type: string description: |- - The id used in an external sales system + The id used in an external sales system example: "MyOrder123" languageId: type: integer description: |- - The id of the language for this order, all communications about the order will be in the given language + The id of the language for this order, all communications about the order will be in the given language example: 1 externalDeviceId: type: string description: |- - The mobile device in use when placing the order + The mobile device in use when placing the order example: "ae3d9f69-945b-4290-a286-8c2dd5d7db8e" orderLines: type: array description: |- - The orderLines with the chosen product and if known/required a voucher and customerToken - items: + The orderLines with the chosen product and if known/required a voucher and customerToken + items: $ref: "#/components/schemas/PostOrderLine" PostOrderLine: type: object @@ -6908,18 +7030,18 @@ components: - createdOn properties: productId: - type: integer + type: integer description: |- - The id of the chosen product + The id of the chosen product example: 1 quantity: - type: integer + type: integer description: |- Amount of the products to be delivered, in case of saldo quantity is used to define the amount of saldo to be charged in eurocents. If multiple GBO products are added, the same amount of customerTokens will be required. example: 1 createdOn: type: string - format: date-time + format: date-time description: |- Current datetime, moment client added orderLine to the order example: "2024-03-22T09:00:00" @@ -6930,21 +7052,21 @@ components: example: "MyOrderLine123" validFrom: type: string - format: date-time + format: date-time description: |- The moment the chosen product should be activated example: "2024-03-30T09:00:00" validUntil: type: string - format: date-time + format: date-time description: |- Only required when a product does not have a fixed duration, otherwise it is calculated by the back end system example: null vouchers: type: array description: |- - List of vouchers applicable for this orderLine - items: + List of vouchers applicable for this orderLine + items: $ref: "#/components/schemas/PostVoucher" PatchOrderLine: type: object @@ -6957,17 +7079,17 @@ components: example: 1 validFrom: type: string - format: date-time + format: date-time example: "2024-03-30T09:00:00" validUntil: type: string - format: date-time + format: date-time example: null PostVoucher: type: object - required: - - voucherCode - properties: + required: + - voucherCode + properties: voucherCode: type: string example: "Voucher1234" diff --git a/src/openapi/products/SE-vouchers-supplier.yaml b/src/openapi/products/SE-vouchers-supplier.yaml index 805d851..8fed250 100644 --- a/src/openapi/products/SE-vouchers-supplier.yaml +++ b/src/openapi/products/SE-vouchers-supplier.yaml @@ -233,6 +233,13 @@ paths: schema: type: integer example: 321 + - name: touchpointId + in: query + required: false + description: Return only issued vouchers that were issued by a specific touchpoint. + schema: + type: integer + example: 3 - name: statusChangedAfter in: query required: false