OVPAY-108 Added /orders endpoint for SE.

src/openapi/orders/service_engine_orders.yaml

@@ -715,6 +715,139 @@ paths:
           type: string
           example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
         description: The JWT of the logged in customer (in case of a web shop).
+    get:
+      parameters:
+        - in: query
+          name: orderId
+          schema:
+            type: string
+            format: uuid
+            example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
+          description: The order id.
+        - in: query
+          name: orderNumber
+          schema:
+            type: string
+            example: "ORD123456"
+          description: The order number.
+        - in: query
+          name: externalOrderId
+          schema:
+            type: string
+            example: 7bef22f6-70a3-4655-bc2a-c40c61581b32
+          description: The external order id.
+        - in: query
+          name: customerProfileId
+          schema:
+            type: integer
+            example: 42
+          description: The customer profile id.
+        - in: query
+          name: xTat
+          schema:
+            type: string
+            example: 7208e73e-87a6-46d9-bb6d-867ffc460c9b
+          description: xTat used in order fulfillment. Note that this is a joined parameter via PurchasedProduct.
+      tags:
+        - Order Retrieval v2.1
+      summary: Find orders.
+      description: Find orders.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                                {
+                  "orders":
+                    [
+                      {
+                        "orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
+                        "externalOrderId": "bac3958b-804a-43e3-b5f7-0b0fffaae5b7",
+                        "orderNumber": "123456",
+                        "customerProfileId": 42,
+                        "totalAmount": 121,
+                        "touchPoint":
+                          {
+                            "salesTouchpointId": 3,
+                            "name": "Website (Perplex)",
+                            "isActive": true,
+                            "retailerId": 1001,
+                          },
+                        "language":
+                          {
+                            "languageId": 1,
+                            "name": "Nederlands",
+                            "iso639Code": "nl-NL",
+                            "ietfCode": "nl",
+                          },
+                        "billingAddressId": 1,
+                        "shippingAddressId": 1,
+                        "createdOn": "2024-03-22T09:00:00",
+                        "lastUpdatedOn": "2024-03-22T09:00:00",
+                        "order_OrderStatus":
+                          {
+                            "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
+                            "orderStatus":
+                              { "orderStatusId": 4, "name": "paid" },
+                            "createdOn": "2024-03-22T09:00:00",
+                            "description": "Order succesvol betaald",
+                          },
+                        "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",
+                                  },
+                                ],
+                              "mandateInput":
+                                {
+                                  "directDebitMandateTypeId": 1,
+                                  "createdOn": "2024-03-22T09:00:00",
+                                  "bic": "RABONL2U",
+                                  "iban": "NL44RABO0123456789",
+                                  "ascription": "J. de Vries",
+                                  "place": "Den Haag",
+                                },
+                            },
+                          ],
+                        "_links":
+                          {
+                            "self":
+                              {
+                                "href": "https://api.example.com/items/1",
+                                "method": "GET",
+                                "templated": true,
+                              },
+                          },
+                      },
+                    ],
+                  "_links":
+                    {
+                      "self":
+                        {
+                          "href": "https://api.example.com/items",
+                          "method": "GET",
+                          "templated": true,
+                        },
+                    },
+                  "href": "string",
+                }
     post:
       tags:
         - Order Creation v2.1