From a637cfb4f28198c200b886be3efa925c13f2d501 Mon Sep 17 00:00:00 2001 From: Herald Date: Thu, 9 Jul 2026 17:50:14 +0200 Subject: [PATCH] Removed voucher query param on the CRUD's en updated SE-order POST/ PATCH orderline in regards to vouchers --- src/openapi/orders/orders-crud.yaml | 8 - src/openapi/orders/service_engine_orders.yaml | 155 +++++++++++++++++- 2 files changed, 147 insertions(+), 16 deletions(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index d8988eb..ccb5bf0 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -111,14 +111,6 @@ paths: explode: false required: false description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled. - - in: query - name: issuedVoucherId - schema: - type: string - format: uuid - example: "b0a9f3c9-9b92-4f8c-b78d-6129be7218a6" - required: false - description: Filter on applied issuedVoucherId for the order. responses: "200": description: OK diff --git a/src/openapi/orders/service_engine_orders.yaml b/src/openapi/orders/service_engine_orders.yaml index 83a9318..5718941 100644 --- a/src/openapi/orders/service_engine_orders.yaml +++ b/src/openapi/orders/service_engine_orders.yaml @@ -1864,7 +1864,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" + $ref: "#/components/schemas/PostOrderLine" examples: Add order line to concept order: summary: Add order line to concept order product with children @@ -1873,7 +1873,11 @@ paths: { "externalOrderLineId": null, "productId": 2, - "vouchers":[], + "vouchers":[ + { + "voucherCode": "HTM-787466" + } + ], "quantity": 1, "validFrom": "2024-03-22T09:00:00", "validUntil": null, @@ -1897,7 +1901,6 @@ paths: value: { "productId": 2, - "vouchers":[], "quantity": 1, "createdOn": "2024-03-22T09:00:00", } @@ -1962,7 +1965,64 @@ paths: "taxAmount": null, "amountExclTax": null, "amountInclTax": 121, - "vouchers":[], + "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": + [ + { + "productId": 1, + "productName": "HTM-30001", + "productDescription": "HTM Maandkorting 20%", + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/1", + "method": "GET", + }, + }, + }, + ], + "_links": + { + "get_details": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/263", + "method": "GET", + }, + }, + }, + "mandatoryCustomerDataItems": + [ + { + "mandatoryCustomerDataItemId": 8, + "customerDataItem": "padBirthDate" + }, + { + "mandatoryCustomerDataItemId": 4, + "customerDataItem": "emailAddress" + }, + ], + } + ], "quantity": 1, "orderLineTerms": [ @@ -2328,7 +2388,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" + $ref: "#/components/schemas/PatchOrderLine" examples: Update order line: summary: Update order line @@ -2336,7 +2396,6 @@ paths: value: { "productId": 21, - "vouchers":[], "quantity": 1, "validFrom": "2024-03-25T09:00:00", "validUntil": null, @@ -2808,7 +2867,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" + $ref: "#/components/schemas/PostVoucher" examples: Add voucher to orderLine: summary: Add voucher to orderLine to receive voucher benefits for a specific product @@ -3115,7 +3174,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" + $ref: "#/components/schemas/PostVoucher" examples: Add voucher to concept order: summary: Add voucher to orderLine to receive voucher benefits for a whole order @@ -6813,3 +6872,83 @@ components: ageToInclusive: type: integer example: 11 + PostOrderLine: + type: object + required: + - productId + - quantity + - createdOn + properties: + productId: + type: integer + example: 1 + quantity: + type: integer + example: 1 + createdOn: + type: datetime + example: "2024-03-22T09:00:00" + externalOrderLineId: + type: string + example: "MyOrder123" + validFrom: + type: datetime + example: "2024-03-30T09:00:00" + validUntil: + type: datetime + example: null + vouchers: + type: array + description: |- + List of vouchers applicable for this orderLine + items: + $ref: "#/components/schemas/PostVoucher" + PatchOrderLine: + type: object + required: + properties: + productId: + type: integer + example: 1 + quantity: + type: integer + example: 1 + validFrom: + type: datetime + example: "2024-03-30T09:00:00" + validUntil: + type: datetime + example: null + PostVoucher: + type: object + required: + - voucherCode + properties: + voucherCode: + type: string + example: "Voucher1234" + ResponseOrder: + type: object + required: + - orderId + - validContents + - orderNumber + - externalOrderId + - customerProfileId + - device + - vouchers + - totalAmount + - touchpoint + - language + - createdOn + - lastUpdatedOn + - order_OrderStatus + - orderLines + - payments + - orderCustomer + properties: + orderId: + type: uuid + example: "a7e122a4-0273-45d2-b590-7e9b2442c56c" + validContents: + type: \ No newline at end of file