address

src/openapi/customers/customers-crud-v2.yaml

@@ -794,7 +794,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/customerEntity"
+              $ref: "#/components/schemas/customersEntity"
             examples:
               customer:
                 value:
@@ -815,7 +815,7 @@ paths:
     post:
       tags:
         - Customer
-      summary: Create a new customerStatus
+      summary: Create a new customer status element
       description: >-
         
       parameters:
@@ -847,7 +847,6 @@ paths:
         - default: []
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited   
-  
   /customers/{customerProfileId}/customerPreferences:
     post:
       tags:
@@ -920,6 +919,121 @@ paths:
           - default: []
         x-auth-type: Application & Application User
         x-throttling-tier: Unlimited
+  /customers/{customerProfileId}/addresses:
+      post:
+        tags:
+          - Customer
+        summary: Add a customer address
+        description: >-
+          
+        parameters:
+          - name: customerProfileId
+            in: path
+            required: true  
+            schema:
+              type: integer
+              example: 1
+        requestBody:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postCustomerAddress"
+              examples:
+                customerAddress:
+                  value:
+                    customerAddress:
+                      addressTypeId: 1
+                      street: Sesamstraat
+                      houseNumber: 1
+                      houseNumberSuffix: A
+                      postalCode: 1234 AB
+                      city: Den Haag
+                      country: NL
+                      isPreferred: true
+          required: true
+        responses:
+          "201":
+            description: Successfully created a customer address
+            content:
+              application/json:
+                schema:
+                  $ref: "#/components/schemas/postCustomerProfileAddressResponse"
+        security:
+          - default: []
+        x-auth-type: Application & Application User
+        x-throttling-tier: Unlimited
+  /addresses/{addressId}:
+    patch:
+      tags:
+        - Customer
+      summary: Edit a customer address
+      description: >-
+          
+      parameters:
+        - name: addressId
+          in: path
+          required: true  
+          schema:
+            type: integer
+            example: 2
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/patchCustomerAddress"
+            examples:
+              updateAddressTypeId:
+                value:
+                  address:
+                    addressTypeId: 2
+        required: true
+      responses:
+        "200":
+          description: Successfully modified a customer Address
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/patchCustomerProfileAddressResponse"
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+    delete:
+      tags:
+        - Customer
+      summary: Delete a customer address
+      description: >-
+          
+      parameters:
+        - name: addressId
+          in: path
+          required: true  
+          schema:
+            type: integer
+            example: 2
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/patchCustomerAddress"
+            examples:
+              updateAddressTypeId:
+                value:
+                  address:
+                    addressTypeId: 2
+        required: true
+      responses:
+        "200":
+          description: Successfully modified a customer Address
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/patchCustomerProfileAddressResponse"
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  
   /ovpaytokens:
     get:
       tags:
@@ -1519,6 +1633,25 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/phonePostEntity'
+    postCustomerAddress:
+      type: object
+      properties:
+        street:
+          type: string
+        houseNumber:
+          type: integer
+        houseNumberSuffix:
+          type: string
+        postalCode:
+          type: string
+        city:
+          type: string
+        country:
+          type: string
+        isPreferred:
+          type: boolean
+        addressType:
+          type: integer
     customerPreferencesEntity:
       type: object
       properties:
@@ -1546,12 +1679,12 @@ components:
     postCustomerProfileAddressResponse:
       type: object
       properties:
-        customerNumber:
+        customerProfileId:
-          type: integer
-          example: 10000001
-        addressId:
           type: integer
           example: 1
+        addressId:
+          type: integer
+          example: 3
     postCustomerProfilePhoneResponse:
       type: object
       properties: