From 12d6dcb183d9fb7c6383ce74b939319428ccc9f8 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 26 Sep 2024 13:25:14 +0200 Subject: [PATCH] DHIL-3364 - Added operations on OrderCustomer. --- src/openapi/orders/orders-crud.yaml | 386 ++++++++++++++++++++++++++++ 1 file changed, 386 insertions(+) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index b3a7e3f..290a6f1 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -789,6 +789,55 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: { "paymentId": "dfae0f6f-95f0-4eac-ab1a-36ffe1f31aac" } + /orders/{orderId}/ordercustomers: + parameters: + - in: path + name: orderId + schema: + type: string + format: uuid + example: d1dd439b-6072-4b97-89c9-724268865b93 + required: true + description: The id of the order to process. + post: + summary: Add a customer to an order. + description: Add a customer to an order. + tags: + - Customer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "orderCustomerAddresses": + [ + { + "orderAddressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ], + } + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "orderCustomerId": "9c9ae71f-7de9-49f9-b676-b0fe103f6286" } /orderlines: get: summary: Find order lines. @@ -1249,6 +1298,37 @@ paths: }, }, ] + /customertokens/{customerTokenId}: + patch: + summary: Update a customer token. + description: Update a customer token. + tags: + - Order Line + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "xTAT": "3b5f2354-d8a1-4317-bb6e-2c32458bc061", + "xBOT": "0fbdb14c-9306-462e-aca7-765a4980a2f7", + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "customerTokenId": "0aedb483-2477-4720-aee6-7abcd016843b" } /personalaccountdata: get: summary: Find personal account data. @@ -1707,6 +1787,312 @@ paths: responses: "200": description: Ok + /ordercustomers: + get: + summary: Find customers on an order. + description: Find customers on an order. + tags: + - Customer + parameters: + - in: query + name: orderCustomerId + schema: + type: string + format: uuid + example: 0743969c-4e4c-4123-bd45-0366f7add029 + required: false + description: The id of the customer on the order. + - in: query + name: orderId + schema: + type: string + format: uuid + example: 9935456d-45e5-419a-91c0-5deb85119f2b + required: false + description: The id of order. + - in: query + name: birthname + schema: + type: string + example: Jan + required: false + description: The birth name of the customer. + - in: query + name: surname + schema: + type: string + example: Vries + required: false + description: The surname of the customer. + - in: query + name: prefix + schema: + type: string + example: de + required: false + description: The prefix of the customer. + - in: query + name: emailAddress + schema: + type: string + example: jandevries@outlook.com + required: false + description: The email address of the customer. + - in: query + name: dateOfBirth + schema: + type: string + format: date + example: 1970-01-01 + required: false + description: The date of birth of the customer. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "orderCustomerId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50", + "orderId": "f59e4769-53a0-4156-8991-6f9119ba629f", + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + "orderCustomerAddresses": + [ + { + "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", + "orderAddressType": + { "orderAddressTypeId": 1, "name": "Billing" }, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ], + }, + ] + /ordercustomers/{orderCustomerId}: + parameters: + - in: path + name: orderCustomerId + schema: + type: string + format: uuid + example: 4edbfe64-7858-44f0-b262-2bbb7e1af4a4 + required: true + description: The id of the customer. + patch: + summary: Update a customer on an order. + description: Update a customer on an order. + tags: + - Customer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "birthname": "Jan", + "surname": "Vries", + "prefix": "de", + "emailAddress": "jandevries@outlook.com", + "dateOfBirth": "1970-01-01", + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "orderCustomerId": "bcf2896d-1ff4-4c5a-ad57-db12fd3c94e7" } + /ordercustomers/{orderCustomerId}/ordercustomeraddresses: + parameters: + - in: path + name: orderCustomerId + schema: + type: string + format: uuid + example: d1dd439b-6072-4b97-89c9-724268865b93 + required: true + description: The id of the customer on the order. + post: + summary: Add one or more addresses to a customer of the order. + description: Add one or more addresses to a customer of the order. + tags: + - Customer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "orderAddressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ] + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "orderCustomerAddressId": "9c9ae71f-7de9-49f9-b676-b0fe103f6286" } + /ordercustomeraddresses: + get: + summary: Find addresses of a customer on an order. + description: Find addresses of a customer on an order. + tags: + - Customer + parameters: + - in: query + name: orderCustomerAddressId + schema: + type: string + format: uuid + example: 0743969c-4e4c-4123-bd45-0366f7add029 + required: false + description: The id of the addresses of a customer on the order. + - in: query + name: orderCustomerId + schema: + type: string + format: uuid + example: 9935456d-45e5-419a-91c0-5deb85119f2b + required: false + description: The id of the customer on the order. + - in: query + name: orderAddressTypeId + schema: + type: array + items: + type: integer + explode: false + required: false + description: Filter on possible types of addresses. 1 = billing, 2 = shipping. + - in: query + name: street + schema: + type: string + example: Kon. Julianaplein + required: false + description: The street of the address. + - in: query + name: houseNumber + schema: + type: integer + example: 10 + required: false + description: The house number of the address. + - in: query + name: houseNumberSuffix + schema: + type: string + example: A + required: false + description: The suffix of the house number. + - in: query + name: postalCode + schema: + type: string + example: 2595 AA + required: false + description: The postal code of the address. + - in: query + name: city + schema: + type: string + example: Den Haag + required: false + description: The city of the address. + - in: query + name: country + schema: + type: string + example: NL + required: false + description: The country of the address. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893", + "orderCustomerId": "540d8b7a-d626-443f-8f99-c24398604d7a", + "orderId": "73cca95a-81d1-468f-a8bf-99b36367001a", + "orderAddressType": + { "orderAddressTypeId": 1, "name": "Billing" }, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + }, + ] + /ordercustomeraddresses/{orderCustomerAddressId}: + parameters: + - in: path + name: orderCustomerAddressId + schema: + type: string + format: uuid + example: 4edbfe64-7858-44f0-b262-2bbb7e1af4a4 + required: true + description: The id of the customer address. + patch: + summary: Update an address of a customer on an order. + description: Update an address of a customer on an order. + tags: + - Customer + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "orderAddressTypeId": 1, + "street": "Kon. Julianaplein", + "houseNumber": 10, + "houseNumberSuffix": "a", + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "NL", + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "orderCustomerAddressId": "d5005529-d4f2-4552-a5b8-477dab7836ec" } components: securitySchemes: bearerToken: