chore(docs): Generated API Reference (v2) (#8643)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>

www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections/post.sh

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/payment-collections' \
+-H 'x-medusa-access-token: {api_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "order_id": "{value}"
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh

@@ -1,5 +0,0 @@
-curl -X POST '{backend_url}/admin/users' \
--H 'Content-Type: application/json' \
---data-raw '{
-  "email": "Janie42@hotmail.com"
-}'

www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionResponse.yaml

@@ -0,0 +1,8 @@
+type: object
+description: SUMMARY
+x-schemaName: AdminPaymentCollectionResponse
+required:
+  - payment_collection
+properties:
+  payment_collection:
+    $ref: ./AdminPaymentCollection.yaml

www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml

@@ -0,0 +1,60 @@
+type: object
+description: SUMMARY
+x-schemaName: CreateCartWorkflowInput
+properties:
+  region_id:
+    type: string
+    title: region_id
+    description: The cart's region id.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The cart's customer id.
+  sales_channel_id:
+    type: string
+    title: sales_channel_id
+    description: The cart's sales channel id.
+  email:
+    type: string
+    title: email
+    description: The cart's email.
+    format: email
+  currency_code:
+    type: string
+    title: currency_code
+    description: The cart's currency code.
+  shipping_address_id:
+    type: string
+    title: shipping_address_id
+    description: The cart's shipping address id.
+  billing_address_id:
+    type: string
+    title: billing_address_id
+    description: The cart's billing address id.
+  shipping_address:
+    oneOf:
+      - type: string
+        title: shipping_address
+        description: The cart's shipping address.
+      - $ref: ./CreateCartAddress.yaml
+  billing_address:
+    oneOf:
+      - type: string
+        title: billing_address
+        description: The cart's billing address.
+      - $ref: ./CreateCartAddress.yaml
+  metadata:
+    type: object
+    description: The cart's metadata.
+  items:
+    type: array
+    description: The cart's items.
+    items:
+      $ref: ./CreateCartCreateLineItem.yaml
+  promo_codes:
+    type: array
+    description: The cart's promo codes.
+    items:
+      type: string
+      title: promo_codes
+      description: The promo code's promo codes.

www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml

@@ -1,26 +0,0 @@
-type: object
-description: SUMMARY
-x-schemaName: CreateUser
-required:
-  - email
-properties:
-  email:
-    type: string
-    title: email
-    description: The user's email.
-    format: email
-  first_name:
-    type: string
-    title: first_name
-    description: The user's first name.
-  last_name:
-    type: string
-    title: last_name
-    description: The user's last name.
-  avatar_url:
-    type: string
-    title: avatar_url
-    description: The user's avatar url.
-  metadata:
-    type: object
-    description: The user's metadata.

www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml

@@ -0,0 +1,44 @@
+type: object
+description: SUMMARY
+x-schemaName: UpdateCartData
+properties:
+  region_id:
+    type: string
+    title: region_id
+    description: The cart's region id.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The cart's customer id.
+  sales_channel_id:
+    type: string
+    title: sales_channel_id
+    description: The cart's sales channel id.
+  email:
+    type: string
+    title: email
+    description: The cart's email.
+    format: email
+  currency_code:
+    type: string
+    title: currency_code
+    description: The cart's currency code.
+  shipping_address_id:
+    type: string
+    title: shipping_address_id
+    description: The cart's shipping address id.
+  billing_address_id:
+    type: string
+    title: billing_address_id
+    description: The cart's billing address id.
+  billing_address:
+    oneOf:
+      - $ref: ./CreateAddress.yaml
+      - $ref: ./UpdateAddress.yaml
+  shipping_address:
+    oneOf:
+      - $ref: ./CreateAddress.yaml
+      - $ref: ./UpdateAddress.yaml
+  metadata:
+    type: object
+    description: The cart's metadata.

www/apps/api-reference/specs/admin/openapi.yaml

@@ -74,6 +74,9 @@ tags:
   - name: Orders
     x-associatedSchema:
       $ref: ./components/schemas/AdminOrder.yaml
+  - name: Payment Collections
+    x-associatedSchema:
+      $ref: ./components/schemas/AdminPaymentCollection.yaml
   - name: Payments
     x-associatedSchema:
       $ref: ./components/schemas/AdminPayment.yaml
@@ -318,6 +321,8 @@ paths:
     $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml
   /admin/orders/{id}/preview:
     $ref: paths/admin_orders_{id}_preview.yaml
+  /admin/payment-collections:
+    $ref: paths/admin_payment-collections.yaml
   /admin/payments:
     $ref: paths/admin_payments.yaml
   /admin/payments/payment-providers:

www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml

@@ -189,7 +189,16 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - name
+                - campaign_identifier
+                - description
+                - budget
+                - starts_at
+                - ends_at
               properties:
                 name:
                   type: string
@@ -247,6 +256,16 @@ post:
                         type: string
                         title: id
                         description: The promotion's ID.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml

@@ -172,7 +172,13 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - description
+                - starts_at
+                - ends_at
               properties:
                 name:
                   type: string
@@ -219,6 +225,16 @@ post:
                         type: string
                         title: id
                         description: The promotion's ID.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_customers.yaml

@@ -186,7 +186,16 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - email
+                - company_name
+                - first_name
+                - last_name
+                - phone
+                - metadata
               properties:
                 email:
                   type: string
@@ -212,6 +221,16 @@ post:
                 metadata:
                   type: object
                   description: The customer's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml

@@ -172,7 +172,16 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - email
+                - company_name
+                - first_name
+                - last_name
+                - phone
+                - metadata
               properties:
                 email:
                   type: string
@@ -198,6 +207,16 @@ post:
                 metadata:
                   type: object
                   description: The customer's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml

@@ -201,7 +201,22 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - address_name
+                - company
+                - first_name
+                - last_name
+                - address_1
+                - address_2
+                - city
+                - country_code
+                - province
+                - postal_code
+                - phone
+                - metadata
               properties:
                 address_name:
                   type: string
@@ -258,6 +273,16 @@ post:
                 metadata:
                   type: object
                   description: The customer's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml

@@ -185,7 +185,22 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - address_name
+                - company
+                - first_name
+                - last_name
+                - address_1
+                - address_2
+                - city
+                - country_code
+                - province
+                - postal_code
+                - phone
+                - metadata
               properties:
                 address_name:
                   type: string
@@ -242,6 +257,16 @@ post:
                 metadata:
                   type: object
                   description: The customer's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml

@@ -186,7 +186,17 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - sales_channel_id
+                - email
+                - customer_id
+                - region_id
+                - currency_code
+                - shipping_methods
+                - metadata
               properties:
                 status:
                   type: boolean
@@ -459,6 +469,16 @@ post:
                 metadata:
                   type: object
                   description: The draft order's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml

@@ -24,18 +24,20 @@ get:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml

@@ -16,18 +16,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml

@@ -22,18 +22,20 @@ delete:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml

@@ -22,18 +22,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -94,3 +96,7 @@ post:
     '500':
       $ref: ../components/responses/500_error.yaml
   x-workflow: confirmOrderEditRequestWorkflow
+  requestBody:
+    content:
+      application/json:
+        schema: {}

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml

@@ -22,18 +22,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml

@@ -28,18 +28,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -137,18 +139,20 @@ delete:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml

@@ -22,18 +22,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml

@@ -28,18 +28,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -140,18 +142,20 @@ delete:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire default fields.
+        using `-` will remove it from the default fields. without prefix it will
+        replace the entire default fields.
       required: false
       schema:
         type: string
         title: fields
-        description: |-
+        description: >-
           Comma-separated fields that should be included in the returned data.
-           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          fields, using `-` will remove it from the default fields. without
+          prefix it will replace the entire default fields.
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml

@@ -73,12 +73,26 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - order_id
               properties:
                 order_id:
                   type: string
                   title: order_id
                   description: The order's order id.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml

@@ -73,7 +73,13 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - items
+                - location_id
+                - metadata
               properties:
                 items:
                   type: array
@@ -104,6 +110,16 @@ post:
                 metadata:
                   type: object
                   description: The order's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -79,12 +79,24 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
               properties:
                 no_notification:
                   type: boolean
                   title: no_notification
                   description: The order's no notification.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml

@@ -79,7 +79,12 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - items
+                - metadata
               properties:
                 items:
                   type: array
@@ -129,6 +134,16 @@ post:
                 metadata:
                   type: object
                   description: The order's metadata.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml

@@ -0,0 +1,107 @@
+post:
+  operationId: PostPaymentCollections
+  summary: Create Payment Collection
+  description: Create a payment collection.
+  x-authenticated: true
+  parameters:
+    - name: expand
+      in: query
+      description: Comma-separated relations that should be expanded in the returned data.
+      required: false
+      schema:
+        type: string
+        title: expand
+        description: >-
+          Comma-separated relations that should be expanded in the returned
+          data.
+    - name: fields
+      in: query
+      description: |-
+        Comma-separated fields that should be included in the returned data.
+         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+         * without prefix it will replace the entire default fields.
+      required: false
+      schema:
+        type: string
+        title: fields
+        description: |-
+          Comma-separated fields that should be included in the returned data.
+           * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+           * without prefix it will replace the entire default fields.
+    - name: offset
+      in: query
+      description: The number of items to skip when retrieving a list.
+      required: false
+      schema:
+        type: number
+        title: offset
+        description: The number of items to skip when retrieving a list.
+    - name: limit
+      in: query
+      description: Limit the number of items returned in the list.
+      required: false
+      schema:
+        type: number
+        title: limit
+        description: Limit the number of items returned in the list.
+    - name: order
+      in: query
+      description: >-
+        The field to sort the data by. By default, the sort order is ascending.
+        To change the order to descending, prefix the field name with `-`.
+      required: false
+      schema:
+        type: string
+        title: order
+        description: >-
+          The field to sort the data by. By default, the sort order is
+          ascending. To change the order to descending, prefix the field name
+          with `-`.
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          description: SUMMARY
+          required:
+            - order_id
+          properties:
+            order_id:
+              type: string
+              title: order_id
+              description: The payment collection's order id.
+            amount:
+              type: number
+              title: amount
+              description: The payment collection's amount.
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_payment-collections/post.sh
+  tags:
+    - Payment Collections
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminPaymentCollectionResponse.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
+  x-workflow: createOrderPaymentCollectionWorkflow

www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml

@@ -172,150 +172,18 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - $ref: ../components/schemas/AdminUpdateProduct.yaml
+            - type: object
               description: SUMMARY
               properties:
-            title:
+                additional_data:
-              type: string
-              title: title
-              description: The product's title.
-            subtitle:
-              type: string
-              title: subtitle
-              description: The product's subtitle.
-            description:
-              type: string
-              title: description
-              description: The product's description.
-            is_giftcard:
-              type: boolean
-              title: is_giftcard
-              description: The product's is giftcard.
-            discountable:
-              type: boolean
-              title: discountable
-              description: The product's discountable.
-            images:
-              type: array
-              description: The product's images.
-              items:
                   type: object
-                description: The image's images.
+                  description: >-
-                required:
+                    Pass additional custom data to the API route. This data is
-                  - url
+                    passed to the underlying workflow under the
-                properties:
+                    `additional_data` parameter.
-                  url:
+          description: SUMMARY
-                    type: string
-                    title: url
-                    description: The image's url.
-            thumbnail:
-              type: string
-              title: thumbnail
-              description: The product's thumbnail.
-            handle:
-              type: string
-              title: handle
-              description: The product's handle.
-            status:
-              type: string
-              enum:
-                - draft
-                - proposed
-                - published
-                - rejected
-            type_id:
-              type: string
-              title: type_id
-              description: The product's type id.
-            collection_id:
-              type: string
-              title: collection_id
-              description: The product's collection id.
-            categories:
-              type: array
-              description: The product's categories.
-              items:
-                type: object
-                description: The category's categories.
-                required:
-                  - id
-                properties:
-                  id:
-                    type: string
-                    title: id
-                    description: The category's ID.
-            tags:
-              type: array
-              description: The product's tags.
-              items:
-                type: object
-                description: The tag's tags.
-                required:
-                  - id
-                properties:
-                  id:
-                    type: string
-                    title: id
-                    description: The tag's ID.
-            options:
-              type: array
-              description: The product's options.
-              items:
-                $ref: ../components/schemas/AdminUpdateProductOption.yaml
-            variants:
-              type: array
-              description: The product's variants.
-              items:
-                oneOf:
-                  - $ref: ../components/schemas/AdminCreateProductVariant.yaml
-                  - $ref: ../components/schemas/AdminUpdateProductVariant.yaml
-            sales_channels:
-              type: array
-              description: The product's sales channels.
-              items:
-                type: object
-                description: The sales channel's sales channels.
-                required:
-                  - id
-                properties:
-                  id:
-                    type: string
-                    title: id
-                    description: The sales channel's ID.
-            weight:
-              type: number
-              title: weight
-              description: The product's weight.
-            length:
-              type: number
-              title: length
-              description: The product's length.
-            height:
-              type: number
-              title: height
-              description: The product's height.
-            width:
-              type: number
-              title: width
-              description: The product's width.
-            hs_code:
-              type: string
-              title: hs_code
-              description: The product's hs code.
-            mid_code:
-              type: string
-              title: mid_code
-              description: The product's mid code.
-            origin_country:
-              type: string
-              title: origin_country
-              description: The product's origin country.
-            material:
-              type: string
-              title: material
-              description: The product's material.
-            metadata:
-              type: object
-              description: The product's metadata.
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml

@@ -184,19 +184,18 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - $ref: ../components/schemas/AdminUpdateProductOption.yaml
+            - type: object
               description: SUMMARY
               properties:
-            title:
+                additional_data:
-              type: string
+                  type: object
-              title: title
+                  description: >-
-              description: The product's title.
+                    Pass additional custom data to the API route. This data is
-            values:
+                    passed to the underlying workflow under the
-              type: array
+                    `additional_data` parameter.
-              description: The product's values.
+          description: SUMMARY
-              items:
-                type: string
-                title: values
-                description: The value's values.
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml

@@ -201,83 +201,18 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - $ref: ../components/schemas/AdminCreateProductVariant.yaml
+            - type: object
               description: SUMMARY
               properties:
-            title:
+                additional_data:
-              type: string
-              title: title
-              description: The product's title.
-            sku:
-              type: string
-              title: sku
-              description: The product's sku.
-            ean:
-              type: string
-              title: ean
-              description: The product's ean.
-            upc:
-              type: string
-              title: upc
-              description: The product's upc.
-            barcode:
-              type: string
-              title: barcode
-              description: The product's barcode.
-            hs_code:
-              type: string
-              title: hs_code
-              description: The product's hs code.
-            mid_code:
-              type: string
-              title: mid_code
-              description: The product's mid code.
-            allow_backorder:
-              type: boolean
-              title: allow_backorder
-              description: The product's allow backorder.
-            manage_inventory:
-              type: boolean
-              title: manage_inventory
-              description: The product's manage inventory.
-            variant_rank:
-              type: number
-              title: variant_rank
-              description: The product's variant rank.
-            weight:
-              type: number
-              title: weight
-              description: The product's weight.
-            length:
-              type: number
-              title: length
-              description: The product's length.
-            height:
-              type: number
-              title: height
-              description: The product's height.
-            width:
-              type: number
-              title: width
-              description: The product's width.
-            origin_country:
-              type: string
-              title: origin_country
-              description: The product's origin country.
-            material:
-              type: string
-              title: material
-              description: The product's material.
-            metadata:
                   type: object
-              description: The product's metadata.
+                  description: >-
-            prices:
+                    Pass additional custom data to the API route. This data is
-              type: array
+                    passed to the underlying workflow under the
-              description: The product's prices.
+                    `additional_data` parameter.
-              items:
+          description: SUMMARY
-                $ref: ../components/schemas/AdminCreateProductVariantPrice.yaml
-            options:
-              type: object
-              description: The product's options.
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml

@@ -184,83 +184,18 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - $ref: ../components/schemas/AdminUpdateProductVariant.yaml
+            - type: object
               description: SUMMARY
               properties:
-            title:
+                additional_data:
-              type: string
-              title: title
-              description: The product's title.
-            sku:
-              type: string
-              title: sku
-              description: The product's sku.
-            ean:
-              type: string
-              title: ean
-              description: The product's ean.
-            upc:
-              type: string
-              title: upc
-              description: The product's upc.
-            barcode:
-              type: string
-              title: barcode
-              description: The product's barcode.
-            hs_code:
-              type: string
-              title: hs_code
-              description: The product's hs code.
-            mid_code:
-              type: string
-              title: mid_code
-              description: The product's mid code.
-            allow_backorder:
-              type: boolean
-              title: allow_backorder
-              description: The product's allow backorder.
-            manage_inventory:
-              type: boolean
-              title: manage_inventory
-              description: The product's manage inventory.
-            variant_rank:
-              type: number
-              title: variant_rank
-              description: The product's variant rank.
-            weight:
-              type: number
-              title: weight
-              description: The product's weight.
-            length:
-              type: number
-              title: length
-              description: The product's length.
-            height:
-              type: number
-              title: height
-              description: The product's height.
-            width:
-              type: number
-              title: width
-              description: The product's width.
-            origin_country:
-              type: string
-              title: origin_country
-              description: The product's origin country.
-            material:
-              type: string
-              title: material
-              description: The product's material.
-            metadata:
                   type: object
-              description: The product's metadata.
+                  description: >-
-            prices:
+                    Pass additional custom data to the API route. This data is
-              type: array
+                    passed to the underlying workflow under the
-              description: The product's prices.
+                    `additional_data` parameter.
-              items:
+          description: SUMMARY
-                $ref: ../components/schemas/AdminCreateProductVariantPrice.yaml
-            options:
-              type: object
-              description: The product's options.
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_promotions.yaml

@@ -364,7 +364,14 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - code
+                - type
+                - campaign_id
+                - application_method
               properties:
                 code:
                   type: string
@@ -626,6 +633,16 @@ post:
                               type: string
                               title: values
                               description: The value's values.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml

@@ -172,7 +172,11 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - type: object
               description: SUMMARY
+              required:
+                - campaign_id
               properties:
                 code:
                   type: string
@@ -431,6 +435,16 @@ post:
                               type: string
                               title: values
                               description: The value's values.
+            - type: object
+              description: SUMMARY
+              properties:
+                additional_data:
+                  type: object
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/admin/paths/admin_users.yaml

@@ -87,96 +87,3 @@ get:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
-post:
-  operationId: PostUsers
-  summary: Create User
-  description: Create a user.
-  x-authenticated: false
-  parameters:
-    - name: expand
-      in: query
-      description: Comma-separated relations that should be expanded in the returned data.
-      required: false
-      schema:
-        type: string
-        title: expand
-        description: >-
-          Comma-separated relations that should be expanded in the returned
-          data.
-    - name: fields
-      in: query
-      description: >-
-        Comma-separated fields that should be included in the returned data. if
-        a field is prefixed with `+` it will be added to the default fields,
-        using `-` will remove it from the default fields. without prefix it will
-        replace the entire default fields.
-      required: false
-      schema:
-        type: string
-        title: fields
-        description: >-
-          Comma-separated fields that should be included in the returned data.
-          if a field is prefixed with `+` it will be added to the default
-          fields, using `-` will remove it from the default fields. without
-          prefix it will replace the entire default fields.
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-    - name: order
-      in: query
-      description: >-
-        The field to sort the data by. By default, the sort order is ascending.
-        To change the order to descending, prefix the field name with `-`.
-      required: false
-      schema:
-        type: string
-        title: order
-        description: >-
-          The field to sort the data by. By default, the sort order is
-          ascending. To change the order to descending, prefix the field name
-          with `-`.
-  requestBody:
-    content:
-      application/json:
-        schema:
-          $ref: ../components/schemas/CreateUser.yaml
-  x-codeSamples:
-    - lang: Shell
-      label: cURL
-      source:
-        $ref: ../code_samples/Shell/admin_users/post.sh
-  tags:
-    - Users
-  responses:
-    '200':
-      description: OK
-      content:
-        application/json:
-          schema:
-            $ref: ../components/schemas/AdminUserResponse.yaml
-    '400':
-      $ref: ../components/responses/400_error.yaml
-    '401':
-      $ref: ../components/responses/unauthorized.yaml
-    '404':
-      $ref: ../components/responses/not_found_error.yaml
-    '409':
-      $ref: ../components/responses/invalid_state_error.yaml
-    '422':
-      $ref: ../components/responses/invalid_request_error.yaml
-    '500':
-      $ref: ../components/responses/500_error.yaml
-  x-workflow: createUserAccountWorkflow

www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollectionResponse.yaml

@@ -0,0 +1,8 @@
+type: object
+description: SUMMARY
+x-schemaName: AdminPaymentCollectionResponse
+required:
+  - payment_collection
+properties:
+  payment_collection:
+    $ref: ./AdminPaymentCollection.yaml

www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml

@@ -0,0 +1,60 @@
+type: object
+description: SUMMARY
+x-schemaName: CreateCartWorkflowInput
+properties:
+  region_id:
+    type: string
+    title: region_id
+    description: The cart's region id.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The cart's customer id.
+  sales_channel_id:
+    type: string
+    title: sales_channel_id
+    description: The cart's sales channel id.
+  email:
+    type: string
+    title: email
+    description: The cart's email.
+    format: email
+  currency_code:
+    type: string
+    title: currency_code
+    description: The cart's currency code.
+  shipping_address_id:
+    type: string
+    title: shipping_address_id
+    description: The cart's shipping address id.
+  billing_address_id:
+    type: string
+    title: billing_address_id
+    description: The cart's billing address id.
+  shipping_address:
+    oneOf:
+      - type: string
+        title: shipping_address
+        description: The cart's shipping address.
+      - $ref: ./CreateCartAddress.yaml
+  billing_address:
+    oneOf:
+      - type: string
+        title: billing_address
+        description: The cart's billing address.
+      - $ref: ./CreateCartAddress.yaml
+  metadata:
+    type: object
+    description: The cart's metadata.
+  items:
+    type: array
+    description: The cart's items.
+    items:
+      $ref: ./CreateCartCreateLineItem.yaml
+  promo_codes:
+    type: array
+    description: The cart's promo codes.
+    items:
+      type: string
+      title: promo_codes
+      description: The promo code's promo codes.

www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml

@@ -1,26 +0,0 @@
-type: object
-description: SUMMARY
-x-schemaName: CreateUser
-required:
-  - email
-properties:
-  email:
-    type: string
-    title: email
-    description: The user's email.
-    format: email
-  first_name:
-    type: string
-    title: first_name
-    description: The user's first name.
-  last_name:
-    type: string
-    title: last_name
-    description: The user's last name.
-  avatar_url:
-    type: string
-    title: avatar_url
-    description: The user's avatar url.
-  metadata:
-    type: object
-    description: The user's metadata.

www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml

@@ -0,0 +1,44 @@
+type: object
+description: SUMMARY
+x-schemaName: UpdateCartData
+properties:
+  region_id:
+    type: string
+    title: region_id
+    description: The cart's region id.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The cart's customer id.
+  sales_channel_id:
+    type: string
+    title: sales_channel_id
+    description: The cart's sales channel id.
+  email:
+    type: string
+    title: email
+    description: The cart's email.
+    format: email
+  currency_code:
+    type: string
+    title: currency_code
+    description: The cart's currency code.
+  shipping_address_id:
+    type: string
+    title: shipping_address_id
+    description: The cart's shipping address id.
+  billing_address_id:
+    type: string
+    title: billing_address_id
+    description: The cart's billing address id.
+  billing_address:
+    oneOf:
+      - $ref: ./CreateAddress.yaml
+      - $ref: ./UpdateAddress.yaml
+  shipping_address:
+    oneOf:
+      - $ref: ./CreateAddress.yaml
+      - $ref: ./UpdateAddress.yaml
+  metadata:
+    type: object
+    description: The cart's metadata.

www/apps/api-reference/specs/store/openapi.full.yaml

@@ -114,64 +114,15 @@ paths:
         content:
           application/json:
             schema:
+              allOf:
+                - $ref: '#/components/schemas/CreateCartWorkflowInput'
+                - type: object
                   description: SUMMARY
                   properties:
-                region_id:
+                    additional_data:
-                  type: string
-                  title: region_id
-                  description: The cart's region id.
-                customer_id:
-                  type: string
-                  title: customer_id
-                  description: The cart's customer id.
-                sales_channel_id:
-                  type: string
-                  title: sales_channel_id
-                  description: The cart's sales channel id.
-                email:
-                  type: string
-                  title: email
-                  description: The cart's email.
-                  format: email
-                currency_code:
-                  type: string
-                  title: currency_code
-                  description: The cart's currency code.
-                shipping_address_id:
-                  type: string
-                  title: shipping_address_id
-                  description: The cart's shipping address id.
-                billing_address_id:
-                  type: string
-                  title: billing_address_id
-                  description: The cart's billing address id.
-                shipping_address:
-                  oneOf:
-                    - type: string
-                      title: shipping_address
-                      description: The cart's shipping address.
-                    - $ref: '#/components/schemas/CreateCartAddress'
-                billing_address:
-                  oneOf:
-                    - type: string
-                      title: billing_address
-                      description: The cart's billing address.
-                    - $ref: '#/components/schemas/CreateCartAddress'
-                metadata:
                       type: object
-                  description: The cart's metadata.
+                      description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
-                items:
+              description: SUMMARY
-                  type: array
-                  description: The cart's items.
-                  items:
-                    $ref: '#/components/schemas/CreateCartCreateLineItem'
-                promo_codes:
-                  type: array
-                  description: The cart's promo codes.
-                  items:
-                    type: string
-                    title: promo_codes
-                    description: The promo code's promo codes.
       x-codeSamples:
         - lang: Shell
           label: cURL
@@ -332,48 +283,15 @@ paths:
         content:
           application/json:
             schema:
+              allOf:
+                - $ref: '#/components/schemas/UpdateCartData'
+                - type: object
                   description: SUMMARY
                   properties:
-                region_id:
+                    additional_data:
-                  type: string
-                  title: region_id
-                  description: The cart's region id.
-                customer_id:
-                  type: string
-                  title: customer_id
-                  description: The cart's customer id.
-                sales_channel_id:
-                  type: string
-                  title: sales_channel_id
-                  description: The cart's sales channel id.
-                email:
-                  type: string
-                  title: email
-                  description: The cart's email.
-                  format: email
-                currency_code:
-                  type: string
-                  title: currency_code
-                  description: The cart's currency code.
-                shipping_address_id:
-                  type: string
-                  title: shipping_address_id
-                  description: The cart's shipping address id.
-                billing_address_id:
-                  type: string
-                  title: billing_address_id
-                  description: The cart's billing address id.
-                billing_address:
-                  oneOf:
-                    - $ref: '#/components/schemas/CreateAddress'
-                    - $ref: '#/components/schemas/UpdateAddress'
-                shipping_address:
-                  oneOf:
-                    - $ref: '#/components/schemas/CreateAddress'
-                    - $ref: '#/components/schemas/UpdateAddress'
-                metadata:
                       type: object
-                  description: The cart's metadata.
+                      description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
+              description: SUMMARY
       x-codeSamples:
         - lang: Shell
           label: cURL
@@ -14625,6 +14543,15 @@ components:
           description: The payment collection's payments.
           items:
             $ref: '#/components/schemas/BasePayment'
+    AdminPaymentCollectionResponse:
+      type: object
+      description: SUMMARY
+      x-schemaName: AdminPaymentCollectionResponse
+      required:
+        - payment_collection
+      properties:
+        payment_collection:
+          $ref: '#/components/schemas/AdminPaymentCollection'
     AdminPaymentProvider:
       type: object
       description: The payment provider's payment providers.
@@ -21447,6 +21374,67 @@ components:
         metadata:
           type: object
           description: The item's metadata.
+    CreateCartWorkflowInput:
+      type: object
+      description: SUMMARY
+      x-schemaName: CreateCartWorkflowInput
+      properties:
+        region_id:
+          type: string
+          title: region_id
+          description: The cart's region id.
+        customer_id:
+          type: string
+          title: customer_id
+          description: The cart's customer id.
+        sales_channel_id:
+          type: string
+          title: sales_channel_id
+          description: The cart's sales channel id.
+        email:
+          type: string
+          title: email
+          description: The cart's email.
+          format: email
+        currency_code:
+          type: string
+          title: currency_code
+          description: The cart's currency code.
+        shipping_address_id:
+          type: string
+          title: shipping_address_id
+          description: The cart's shipping address id.
+        billing_address_id:
+          type: string
+          title: billing_address_id
+          description: The cart's billing address id.
+        shipping_address:
+          oneOf:
+            - type: string
+              title: shipping_address
+              description: The cart's shipping address.
+            - $ref: '#/components/schemas/CreateCartAddress'
+        billing_address:
+          oneOf:
+            - type: string
+              title: billing_address
+              description: The cart's billing address.
+            - $ref: '#/components/schemas/CreateCartAddress'
+        metadata:
+          type: object
+          description: The cart's metadata.
+        items:
+          type: array
+          description: The cart's items.
+          items:
+            $ref: '#/components/schemas/CreateCartCreateLineItem'
+        promo_codes:
+          type: array
+          description: The cart's promo codes.
+          items:
+            type: string
+            title: promo_codes
+            description: The promo code's promo codes.
     CreateOrderReturnReason:
       type: object
       description: SUMMARY
@@ -21474,33 +21462,6 @@ components:
         metadata:
           type: object
           description: The return reason's metadata.
-    CreateUser:
-      type: object
-      description: SUMMARY
-      x-schemaName: CreateUser
-      required:
-        - email
-      properties:
-        email:
-          type: string
-          title: email
-          description: The user's email.
-          format: email
-        first_name:
-          type: string
-          title: first_name
-          description: The user's first name.
-        last_name:
-          type: string
-          title: last_name
-          description: The user's last name.
-        avatar_url:
-          type: string
-          title: avatar_url
-          description: The user's avatar url.
-        metadata:
-          type: object
-          description: The user's metadata.
     Error:
       title: Response Error
       type: object
@@ -25441,6 +25402,51 @@ components:
         metadata:
           type: object
           description: The shipping address's metadata.
+    UpdateCartData:
+      type: object
+      description: SUMMARY
+      x-schemaName: UpdateCartData
+      properties:
+        region_id:
+          type: string
+          title: region_id
+          description: The cart's region id.
+        customer_id:
+          type: string
+          title: customer_id
+          description: The cart's customer id.
+        sales_channel_id:
+          type: string
+          title: sales_channel_id
+          description: The cart's sales channel id.
+        email:
+          type: string
+          title: email
+          description: The cart's email.
+          format: email
+        currency_code:
+          type: string
+          title: currency_code
+          description: The cart's currency code.
+        shipping_address_id:
+          type: string
+          title: shipping_address_id
+          description: The cart's shipping address id.
+        billing_address_id:
+          type: string
+          title: billing_address_id
+          description: The cart's billing address id.
+        billing_address:
+          oneOf:
+            - $ref: '#/components/schemas/CreateAddress'
+            - $ref: '#/components/schemas/UpdateAddress'
+        shipping_address:
+          oneOf:
+            - $ref: '#/components/schemas/CreateAddress'
+            - $ref: '#/components/schemas/UpdateAddress'
+        metadata:
+          type: object
+          description: The cart's metadata.
     UpdateOrderReturnReason:
       type: object
       description: SUMMARY

www/apps/api-reference/specs/store/paths/store_carts.yaml

@@ -63,64 +63,18 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - $ref: ../components/schemas/CreateCartWorkflowInput.yaml
+            - type: object
               description: SUMMARY
               properties:
-            region_id:
+                additional_data:
-              type: string
-              title: region_id
-              description: The cart's region id.
-            customer_id:
-              type: string
-              title: customer_id
-              description: The cart's customer id.
-            sales_channel_id:
-              type: string
-              title: sales_channel_id
-              description: The cart's sales channel id.
-            email:
-              type: string
-              title: email
-              description: The cart's email.
-              format: email
-            currency_code:
-              type: string
-              title: currency_code
-              description: The cart's currency code.
-            shipping_address_id:
-              type: string
-              title: shipping_address_id
-              description: The cart's shipping address id.
-            billing_address_id:
-              type: string
-              title: billing_address_id
-              description: The cart's billing address id.
-            shipping_address:
-              oneOf:
-                - type: string
-                  title: shipping_address
-                  description: The cart's shipping address.
-                - $ref: ../components/schemas/CreateCartAddress.yaml
-            billing_address:
-              oneOf:
-                - type: string
-                  title: billing_address
-                  description: The cart's billing address.
-                - $ref: ../components/schemas/CreateCartAddress.yaml
-            metadata:
                   type: object
-              description: The cart's metadata.
+                  description: >-
-            items:
+                    Pass additional custom data to the API route. This data is
-              type: array
+                    passed to the underlying workflow under the
-              description: The cart's items.
+                    `additional_data` parameter.
-              items:
+          description: SUMMARY
-                $ref: ../components/schemas/CreateCartCreateLineItem.yaml
-            promo_codes:
-              type: array
-              description: The cart's promo codes.
-              items:
-                type: string
-                title: promo_codes
-                description: The promo code's promo codes.
   x-codeSamples:
     - lang: Shell
       label: cURL

www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml

@@ -164,48 +164,18 @@ post:
     content:
       application/json:
         schema:
+          allOf:
+            - $ref: ../components/schemas/UpdateCartData.yaml
+            - type: object
               description: SUMMARY
               properties:
-            region_id:
+                additional_data:
-              type: string
-              title: region_id
-              description: The cart's region id.
-            customer_id:
-              type: string
-              title: customer_id
-              description: The cart's customer id.
-            sales_channel_id:
-              type: string
-              title: sales_channel_id
-              description: The cart's sales channel id.
-            email:
-              type: string
-              title: email
-              description: The cart's email.
-              format: email
-            currency_code:
-              type: string
-              title: currency_code
-              description: The cart's currency code.
-            shipping_address_id:
-              type: string
-              title: shipping_address_id
-              description: The cart's shipping address id.
-            billing_address_id:
-              type: string
-              title: billing_address_id
-              description: The cart's billing address id.
-            billing_address:
-              oneOf:
-                - $ref: ../components/schemas/CreateAddress.yaml
-                - $ref: ../components/schemas/UpdateAddress.yaml
-            shipping_address:
-              oneOf:
-                - $ref: ../components/schemas/CreateAddress.yaml
-                - $ref: ../components/schemas/UpdateAddress.yaml
-            metadata:
                   type: object
-              description: The cart's metadata.
+                  description: >-
+                    Pass additional custom data to the API route. This data is
+                    passed to the underlying workflow under the
+                    `additional_data` parameter.
+          description: SUMMARY
   x-codeSamples:
     - lang: Shell
       label: cURL

www/utils/generated/oas-output/base/admin.oas.base.yaml

@@ -69,6 +69,9 @@ tags:
   - name: Orders
     x-associatedSchema:
       $ref: "#/components/schemas/AdminOrder"
+  - name: Payment Collections
+    x-associatedSchema:
+      $ref: "#/components/schemas/AdminPaymentCollection"
   - name: Payments
     x-associatedSchema:
       $ref: "#/components/schemas/AdminPayment"

www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts

@@ -21,18 +21,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts

@@ -28,18 +28,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts

@@ -29,18 +29,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts

@@ -22,18 +22,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts

@@ -120,490 +120,10 @@
  *       type: array
  *       description: The product's $and.
  *       items:
- *         oneOf:
- *           - type: object
- *             description: The $and's details.
- *             x-schemaName: BaseProductOptionParams
- *             properties:
- *               q:
- *                 type: string
- *                 title: q
- *                 description: The $and's q.
- *               id:
- *                 oneOf:
- *                   - type: string
- *                     title: id
- *                     description: The $and's ID.
- *                   - type: array
- *                     description: The $and's ID.
- *                     items:
- *                       type: string
- *                       title: id
- *                       description: The id's ID.
- *               title:
- *                 oneOf:
- *                   - type: string
- *                     title: title
- *                     description: The $and's title.
- *                   - type: array
- *                     description: The $and's title.
- *                     items:
- *                       type: string
- *                       title: title
- *                       description: The title's details.
- *               product_id:
- *                 oneOf:
- *                   - type: string
- *                     title: product_id
- *                     description: The $and's product id.
- *                   - type: array
- *                     description: The $and's product id.
- *                     items:
- *                       type: string
- *                       title: product_id
- *                       description: The product id's details.
- *               limit:
- *                 type: number
- *                 title: limit
- *                 description: The $and's limit.
- *               offset:
- *                 type: number
- *                 title: offset
- *                 description: The $and's offset.
- *               order:
- *                 type: string
- *                 title: order
- *                 description: The $and's order.
- *               fields:
- *                 type: string
- *                 title: fields
- *                 description: The $and's fields.
- *               $and:
- *                 type: array
- *                 description: The $and's details.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $and's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $and's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $and's ID.
- *                             - type: array
- *                               description: The $and's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $and's title.
- *                             - type: array
- *                               description: The $and's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $and's product id.
- *                             - type: array
- *                               description: The $and's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $and's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $and's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $and's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $and's fields.
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $and's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *               $or:
- *                 type: array
- *                 description: The $and's $or.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $or's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $or's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $or's ID.
- *                             - type: array
- *                               description: The $or's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $or's title.
- *                             - type: array
- *                               description: The $or's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $or's product id.
- *                             - type: array
- *                               description: The $or's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $or's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $or's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $or's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $or's fields.
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $or's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *           - type: object
- *             description: The $and's details.
- *             properties:
- *               $and:
- *                 type: array
- *                 description: The $and's details.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $and's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $and's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $and's ID.
- *                             - type: array
- *                               description: The $and's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $and's title.
- *                             - type: array
- *                               description: The $and's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $and's product id.
- *                             - type: array
- *                               description: The $and's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $and's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $and's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $and's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $and's fields.
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $and's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *               $or:
- *                 type: array
- *                 description: The $and's $or.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $or's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $or's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $or's ID.
- *                             - type: array
- *                               description: The $or's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $or's title.
- *                             - type: array
- *                               description: The $or's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $or's product id.
- *                             - type: array
- *                               description: The $or's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $or's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $or's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $or's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $or's fields.
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $or's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
  *         type: array
  *         items:
  *           type: object
+ *         title: $and
  *   - name: $or
  *     in: query
  *     description: The product's $or.
@@ -612,490 +132,10 @@
  *       type: array
  *       description: The product's $or.
  *       items:
- *         oneOf:
- *           - type: object
- *             description: The $or's details.
- *             x-schemaName: BaseProductOptionParams
- *             properties:
- *               q:
- *                 type: string
- *                 title: q
- *                 description: The $or's q.
- *               id:
- *                 oneOf:
- *                   - type: string
- *                     title: id
- *                     description: The $or's ID.
- *                   - type: array
- *                     description: The $or's ID.
- *                     items:
- *                       type: string
- *                       title: id
- *                       description: The id's ID.
- *               title:
- *                 oneOf:
- *                   - type: string
- *                     title: title
- *                     description: The $or's title.
- *                   - type: array
- *                     description: The $or's title.
- *                     items:
- *                       type: string
- *                       title: title
- *                       description: The title's details.
- *               product_id:
- *                 oneOf:
- *                   - type: string
- *                     title: product_id
- *                     description: The $or's product id.
- *                   - type: array
- *                     description: The $or's product id.
- *                     items:
- *                       type: string
- *                       title: product_id
- *                       description: The product id's details.
- *               limit:
- *                 type: number
- *                 title: limit
- *                 description: The $or's limit.
- *               offset:
- *                 type: number
- *                 title: offset
- *                 description: The $or's offset.
- *               order:
- *                 type: string
- *                 title: order
- *                 description: The $or's order.
- *               fields:
- *                 type: string
- *                 title: fields
- *                 description: The $or's fields.
- *               $and:
- *                 type: array
- *                 description: The $or's $and.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $and's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $and's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $and's ID.
- *                             - type: array
- *                               description: The $and's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $and's title.
- *                             - type: array
- *                               description: The $and's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $and's product id.
- *                             - type: array
- *                               description: The $and's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $and's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $and's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $and's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $and's fields.
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $and's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *               $or:
- *                 type: array
- *                 description: The $or's details.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $or's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $or's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $or's ID.
- *                             - type: array
- *                               description: The $or's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $or's title.
- *                             - type: array
- *                               description: The $or's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $or's product id.
- *                             - type: array
- *                               description: The $or's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $or's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $or's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $or's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $or's fields.
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $or's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *           - type: object
- *             description: The $or's details.
- *             properties:
- *               $and:
- *                 type: array
- *                 description: The $or's $and.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $and's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $and's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $and's ID.
- *                             - type: array
- *                               description: The $and's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $and's title.
- *                             - type: array
- *                               description: The $and's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $and's product id.
- *                             - type: array
- *                               description: The $and's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $and's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $and's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $and's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $and's fields.
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $and's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $and's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $and's $or.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *               $or:
- *                 type: array
- *                 description: The $or's details.
- *                 items:
- *                   oneOf:
- *                     - type: object
- *                       description: The $or's details.
- *                       x-schemaName: BaseProductOptionParams
- *                       properties:
- *                         q:
- *                           type: string
- *                           title: q
- *                           description: The $or's q.
- *                         id:
- *                           oneOf:
- *                             - type: string
- *                               title: id
- *                               description: The $or's ID.
- *                             - type: array
- *                               description: The $or's ID.
- *                               items:
- *                                 type: string
- *                                 title: id
- *                                 description: The id's ID.
- *                         title:
- *                           oneOf:
- *                             - type: string
- *                               title: title
- *                               description: The $or's title.
- *                             - type: array
- *                               description: The $or's title.
- *                               items:
- *                                 type: string
- *                                 title: title
- *                                 description: The title's details.
- *                         product_id:
- *                           oneOf:
- *                             - type: string
- *                               title: product_id
- *                               description: The $or's product id.
- *                             - type: array
- *                               description: The $or's product id.
- *                               items:
- *                                 type: string
- *                                 title: product_id
- *                                 description: The product id's details.
- *                         limit:
- *                           type: number
- *                           title: limit
- *                           description: The $or's limit.
- *                         offset:
- *                           type: number
- *                           title: offset
- *                           description: The $or's offset.
- *                         order:
- *                           type: string
- *                           title: order
- *                           description: The $or's order.
- *                         fields:
- *                           type: string
- *                           title: fields
- *                           description: The $or's fields.
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
- *                     - type: object
- *                       description: The $or's details.
- *                       properties:
- *                         $and:
- *                           type: array
- *                           description: The $or's $and.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $and's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $and's details.
- *                         $or:
- *                           type: array
- *                           description: The $or's details.
- *                           items:
- *                             oneOf:
- *                               - type: object
- *                                 description: The $or's details.
- *                                 x-schemaName: BaseProductOptionParams
- *                               - type: object
- *                                 description: The $or's details.
  *         type: array
  *         items:
  *           type: object
+ *         title: $or
  * security:
  *   - api_token: []
  *   - cookie_auth: []

www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts

@@ -63,7 +63,16 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - name
+ *               - campaign_identifier
+ *               - description
+ *               - budget
+ *               - starts_at
+ *               - ends_at
  *             properties:
  *               name:
  *                 type: string
@@ -121,6 +130,15 @@
  *                       type: string
  *                       title: id
  *                       description: The promotion's ID.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts

@@ -69,7 +69,13 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - description
+ *               - starts_at
+ *               - ends_at
  *             properties:
  *               name:
  *                 type: string
@@ -116,6 +122,15 @@
  *                       type: string
  *                       title: id
  *                       description: The promotion's ID.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_customers.ts

@@ -63,7 +63,16 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - email
+ *               - company_name
+ *               - first_name
+ *               - last_name
+ *               - phone
+ *               - metadata
  *             properties:
  *               email:
  *                 type: string
@@ -89,6 +98,15 @@
  *               metadata:
  *                 type: object
  *                 description: The customer's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts

@@ -69,7 +69,16 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - email
+ *               - company_name
+ *               - first_name
+ *               - last_name
+ *               - phone
+ *               - metadata
  *             properties:
  *               email:
  *                 type: string
@@ -95,6 +104,15 @@
  *               metadata:
  *                 type: object
  *                 description: The customer's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts

@@ -69,7 +69,22 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - address_name
+ *               - company
+ *               - first_name
+ *               - last_name
+ *               - address_1
+ *               - address_2
+ *               - city
+ *               - country_code
+ *               - province
+ *               - postal_code
+ *               - phone
+ *               - metadata
  *             properties:
  *               address_name:
  *                 type: string
@@ -126,6 +141,15 @@
  *               metadata:
  *                 type: object
  *                 description: The customer's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts

@@ -75,7 +75,22 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - address_name
+ *               - company
+ *               - first_name
+ *               - last_name
+ *               - address_1
+ *               - address_2
+ *               - city
+ *               - country_code
+ *               - province
+ *               - postal_code
+ *               - phone
+ *               - metadata
  *             properties:
  *               address_name:
  *                 type: string
@@ -132,6 +147,15 @@
  *               metadata:
  *                 type: object
  *                 description: The customer's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts

@@ -63,7 +63,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - sales_channel_id
+ *               - email
+ *               - customer_id
+ *               - region_id
+ *               - currency_code
+ *               - shipping_methods
+ *               - metadata
  *             properties:
  *               status:
  *                 type: boolean
@@ -336,6 +346,15 @@
  *               metadata:
  *                 type: object
  *                 description: The draft order's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts

@@ -15,18 +15,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts

@@ -21,18 +21,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.
@@ -93,6 +93,10 @@
  *   "500":
  *     $ref: "#/components/responses/500_error"
  * x-workflow: confirmOrderEditRequestWorkflow
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema: {}
  * 
 */
 

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts

@@ -21,18 +21,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts

@@ -27,18 +27,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts

@@ -21,18 +21,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts

@@ -27,18 +27,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: >-
+ *       description: Comma-separated fields that should be included in the returned
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts

@@ -69,12 +69,25 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - order_id
  *             properties:
  *               order_id:
  *                 type: string
  *                 title: order_id
  *                 description: The order's order id.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts

@@ -69,7 +69,13 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - items
+ *               - location_id
+ *               - metadata
  *             properties:
  *               items:
  *                 type: array
@@ -100,6 +106,15 @@
  *               metadata:
  *                 type: object
  *                 description: The order's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts

@@ -75,12 +75,23 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
  *             properties:
  *               no_notification:
  *                 type: boolean
  *                 title: no_notification
  *                 description: The order's no notification.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts

@@ -75,7 +75,12 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - items
+ *               - metadata
  *             properties:
  *               items:
  *                 type: array
@@ -125,6 +130,15 @@
  *               metadata:
  *                 type: object
  *                 description: The order's metadata.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts

@@ -1,9 +1,9 @@
 /**
- * @oas [post] /admin/users
+ * @oas [post] /admin/payment-collections
- * operationId: PostUsers
+ * operationId: PostPaymentCollections
- * summary: Create User
+ * summary: Create Payment Collection
- * description: Create a user.
+ * description: Create a payment collection.
- * x-authenticated: false
+ * x-authenticated: true
  * parameters:
  *   - name: expand
  *     in: query
@@ -15,18 +15,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: Comma-separated fields that should be included in the returned
+ *     description: >-
- *       data. if a field is prefixed with `+` it will be added to the default
+ *       Comma-separated fields that should be included in the returned data.
- *       fields, using `-` will remove it from the default fields. without prefix
+ *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
- *       it will replace the entire default fields.
+ *        * without prefix it will replace the entire default fields.
  *     required: false
  *     schema:
  *       type: string
  *       title: fields
- *       description: Comma-separated fields that should be included in the returned
+ *       description: >-
- *         data. if a field is prefixed with `+` it will be added to the default
+ *         Comma-separated fields that should be included in the returned data.
- *         fields, using `-` will remove it from the default fields. without prefix
+ *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
- *         it will replace the entire default fields.
+ *          * without prefix it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.
@@ -55,29 +55,46 @@
  *       description: The field to sort the data by. By default, the sort order is
  *         ascending. To change the order to descending, prefix the field name with
  *         `-`.
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
  * requestBody:
  *   content:
  *     application/json:
  *       schema:
- *         $ref: "#/components/schemas/CreateUser"
+ *         type: object
+ *         description: SUMMARY
+ *         required:
+ *           - order_id
+ *         properties:
+ *           order_id:
+ *             type: string
+ *             title: order_id
+ *             description: The payment collection's order id.
+ *           amount:
+ *             type: number
+ *             title: amount
+ *             description: The payment collection's amount.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
- *       curl -X POST '{backend_url}/admin/users' \
+ *       curl -X POST '{backend_url}/admin/payment-collections' \
+ *       -H 'x-medusa-access-token: {api_token}' \
  *       -H 'Content-Type: application/json' \
  *       --data-raw '{
- *         "email": "Janie42@hotmail.com"
+ *         "order_id": "{value}"
  *       }'
  * tags:
- *   - Users
+ *   - Payment Collections
  * responses:
  *   "200":
  *     description: OK
  *     content:
  *       application/json:
  *         schema:
- *           $ref: "#/components/schemas/AdminUserResponse"
+ *           $ref: "#/components/schemas/AdminPaymentCollectionResponse"
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":
@@ -90,7 +107,7 @@
  *     $ref: "#/components/responses/invalid_request_error"
  *   "500":
  *     $ref: "#/components/responses/500_error"
- * x-workflow: createUserAccountWorkflow
+ * x-workflow: createOrderPaymentCollectionWorkflow
  * 
 */
 

www/utils/generated/oas-output/operations/admin/post_admin_products.ts

@@ -63,148 +63,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/AdminCreateProduct"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           title:
+ *               additional_data:
- *             type: string
- *             title: title
- *             description: The product's title.
- *           subtitle:
- *             type: string
- *             title: subtitle
- *             description: The product's subtitle.
- *           description:
- *             type: string
- *             title: description
- *             description: The product's description.
- *           is_giftcard:
- *             type: boolean
- *             title: is_giftcard
- *             description: The product's is giftcard.
- *           discountable:
- *             type: boolean
- *             title: discountable
- *             description: The product's discountable.
- *           images:
- *             type: array
- *             description: The product's images.
- *             items:
  *                 type: object
- *               description: The image's images.
+ *                 description: Pass additional custom data to the API route. This data is passed
- *               required:
+ *                   to the underlying workflow under the `additional_data`
- *                 - url
+ *                   parameter.
- *               properties:
+ *         description: SUMMARY
- *                 url:
- *                   type: string
- *                   title: url
- *                   description: The image's url.
- *           thumbnail:
- *             type: string
- *             title: thumbnail
- *             description: The product's thumbnail.
- *           handle:
- *             type: string
- *             title: handle
- *             description: The product's handle.
- *           status:
- *             type: string
- *             enum:
- *               - draft
- *               - proposed
- *               - published
- *               - rejected
- *           type_id:
- *             type: string
- *             title: type_id
- *             description: The product's type id.
- *           collection_id:
- *             type: string
- *             title: collection_id
- *             description: The product's collection id.
- *           categories:
- *             type: array
- *             description: The product's categories.
- *             items:
- *               type: object
- *               description: The category's categories.
- *               required:
- *                 - id
- *               properties:
- *                 id:
- *                   type: string
- *                   title: id
- *                   description: The category's ID.
- *           tags:
- *             type: array
- *             description: The product's tags.
- *             items:
- *               type: object
- *               description: The tag's tags.
- *               required:
- *                 - id
- *               properties:
- *                 id:
- *                   type: string
- *                   title: id
- *                   description: The tag's ID.
- *           options:
- *             type: array
- *             description: The product's options.
- *             items:
- *               $ref: "#/components/schemas/AdminCreateProductOption"
- *           variants:
- *             type: array
- *             description: The product's variants.
- *             items:
- *               $ref: "#/components/schemas/AdminCreateProductVariant"
- *           sales_channels:
- *             type: array
- *             description: The product's sales channels.
- *             items:
- *               type: object
- *               description: The sales channel's sales channels.
- *               required:
- *                 - id
- *               properties:
- *                 id:
- *                   type: string
- *                   title: id
- *                   description: The sales channel's ID.
- *           weight:
- *             type: number
- *             title: weight
- *             description: The product's weight.
- *           length:
- *             type: number
- *             title: length
- *             description: The product's length.
- *           height:
- *             type: number
- *             title: height
- *             description: The product's height.
- *           width:
- *             type: number
- *             title: width
- *             description: The product's width.
- *           hs_code:
- *             type: string
- *             title: hs_code
- *             description: The product's hs code.
- *           mid_code:
- *             type: string
- *             title: mid_code
- *             description: The product's mid code.
- *           origin_country:
- *             type: string
- *             title: origin_country
- *             description: The product's origin country.
- *           material:
- *             type: string
- *             title: material
- *             description: The product's material.
- *           metadata:
- *             type: object
- *             description: The product's metadata.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts

@@ -69,150 +69,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/AdminUpdateProduct"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           title:
+ *               additional_data:
- *             type: string
- *             title: title
- *             description: The product's title.
- *           subtitle:
- *             type: string
- *             title: subtitle
- *             description: The product's subtitle.
- *           description:
- *             type: string
- *             title: description
- *             description: The product's description.
- *           is_giftcard:
- *             type: boolean
- *             title: is_giftcard
- *             description: The product's is giftcard.
- *           discountable:
- *             type: boolean
- *             title: discountable
- *             description: The product's discountable.
- *           images:
- *             type: array
- *             description: The product's images.
- *             items:
  *                 type: object
- *               description: The image's images.
+ *                 description: Pass additional custom data to the API route. This data is passed
- *               required:
+ *                   to the underlying workflow under the `additional_data`
- *                 - url
+ *                   parameter.
- *               properties:
+ *         description: SUMMARY
- *                 url:
- *                   type: string
- *                   title: url
- *                   description: The image's url.
- *           thumbnail:
- *             type: string
- *             title: thumbnail
- *             description: The product's thumbnail.
- *           handle:
- *             type: string
- *             title: handle
- *             description: The product's handle.
- *           status:
- *             type: string
- *             enum:
- *               - draft
- *               - proposed
- *               - published
- *               - rejected
- *           type_id:
- *             type: string
- *             title: type_id
- *             description: The product's type id.
- *           collection_id:
- *             type: string
- *             title: collection_id
- *             description: The product's collection id.
- *           categories:
- *             type: array
- *             description: The product's categories.
- *             items:
- *               type: object
- *               description: The category's categories.
- *               required:
- *                 - id
- *               properties:
- *                 id:
- *                   type: string
- *                   title: id
- *                   description: The category's ID.
- *           tags:
- *             type: array
- *             description: The product's tags.
- *             items:
- *               type: object
- *               description: The tag's tags.
- *               required:
- *                 - id
- *               properties:
- *                 id:
- *                   type: string
- *                   title: id
- *                   description: The tag's ID.
- *           options:
- *             type: array
- *             description: The product's options.
- *             items:
- *               $ref: "#/components/schemas/AdminUpdateProductOption"
- *           variants:
- *             type: array
- *             description: The product's variants.
- *             items:
- *               oneOf:
- *                 - $ref: "#/components/schemas/AdminCreateProductVariant"
- *                 - $ref: "#/components/schemas/AdminUpdateProductVariant"
- *           sales_channels:
- *             type: array
- *             description: The product's sales channels.
- *             items:
- *               type: object
- *               description: The sales channel's sales channels.
- *               required:
- *                 - id
- *               properties:
- *                 id:
- *                   type: string
- *                   title: id
- *                   description: The sales channel's ID.
- *           weight:
- *             type: number
- *             title: weight
- *             description: The product's weight.
- *           length:
- *             type: number
- *             title: length
- *             description: The product's length.
- *           height:
- *             type: number
- *             title: height
- *             description: The product's height.
- *           width:
- *             type: number
- *             title: width
- *             description: The product's width.
- *           hs_code:
- *             type: string
- *             title: hs_code
- *             description: The product's hs code.
- *           mid_code:
- *             type: string
- *             title: mid_code
- *             description: The product's mid code.
- *           origin_country:
- *             type: string
- *             title: origin_country
- *             description: The product's origin country.
- *           material:
- *             type: string
- *             title: material
- *             description: The product's material.
- *           metadata:
- *             type: object
- *             description: The product's metadata.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts

@@ -69,19 +69,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/AdminCreateProductOption"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           title:
+ *               additional_data:
- *             type: string
+ *                 type: object
- *             title: title
+ *                 description: Pass additional custom data to the API route. This data is passed
- *             description: The product's title.
+ *                   to the underlying workflow under the `additional_data`
- *           values:
+ *                   parameter.
- *             type: array
+ *         description: SUMMARY
- *             description: The product's values.
- *             items:
- *               type: string
- *               title: values
- *               description: The value's values.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts

@@ -75,19 +75,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/AdminUpdateProductOption"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           title:
+ *               additional_data:
- *             type: string
+ *                 type: object
- *             title: title
+ *                 description: Pass additional custom data to the API route. This data is passed
- *             description: The product's title.
+ *                   to the underlying workflow under the `additional_data`
- *           values:
+ *                   parameter.
- *             type: array
+ *         description: SUMMARY
- *             description: The product's values.
- *             items:
- *               type: string
- *               title: values
- *               description: The value's values.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts

@@ -69,83 +69,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/AdminCreateProductVariant"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           title:
+ *               additional_data:
- *             type: string
- *             title: title
- *             description: The product's title.
- *           sku:
- *             type: string
- *             title: sku
- *             description: The product's sku.
- *           ean:
- *             type: string
- *             title: ean
- *             description: The product's ean.
- *           upc:
- *             type: string
- *             title: upc
- *             description: The product's upc.
- *           barcode:
- *             type: string
- *             title: barcode
- *             description: The product's barcode.
- *           hs_code:
- *             type: string
- *             title: hs_code
- *             description: The product's hs code.
- *           mid_code:
- *             type: string
- *             title: mid_code
- *             description: The product's mid code.
- *           allow_backorder:
- *             type: boolean
- *             title: allow_backorder
- *             description: The product's allow backorder.
- *           manage_inventory:
- *             type: boolean
- *             title: manage_inventory
- *             description: The product's manage inventory.
- *           variant_rank:
- *             type: number
- *             title: variant_rank
- *             description: The product's variant rank.
- *           weight:
- *             type: number
- *             title: weight
- *             description: The product's weight.
- *           length:
- *             type: number
- *             title: length
- *             description: The product's length.
- *           height:
- *             type: number
- *             title: height
- *             description: The product's height.
- *           width:
- *             type: number
- *             title: width
- *             description: The product's width.
- *           origin_country:
- *             type: string
- *             title: origin_country
- *             description: The product's origin country.
- *           material:
- *             type: string
- *             title: material
- *             description: The product's material.
- *           metadata:
  *                 type: object
- *             description: The product's metadata.
+ *                 description: Pass additional custom data to the API route. This data is passed
- *           prices:
+ *                   to the underlying workflow under the `additional_data`
- *             type: array
+ *                   parameter.
- *             description: The product's prices.
+ *         description: SUMMARY
- *             items:
- *               $ref: "#/components/schemas/AdminCreateProductVariantPrice"
- *           options:
- *             type: object
- *             description: The product's options.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts

@@ -75,83 +75,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/AdminUpdateProductVariant"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           title:
+ *               additional_data:
- *             type: string
- *             title: title
- *             description: The product's title.
- *           sku:
- *             type: string
- *             title: sku
- *             description: The product's sku.
- *           ean:
- *             type: string
- *             title: ean
- *             description: The product's ean.
- *           upc:
- *             type: string
- *             title: upc
- *             description: The product's upc.
- *           barcode:
- *             type: string
- *             title: barcode
- *             description: The product's barcode.
- *           hs_code:
- *             type: string
- *             title: hs_code
- *             description: The product's hs code.
- *           mid_code:
- *             type: string
- *             title: mid_code
- *             description: The product's mid code.
- *           allow_backorder:
- *             type: boolean
- *             title: allow_backorder
- *             description: The product's allow backorder.
- *           manage_inventory:
- *             type: boolean
- *             title: manage_inventory
- *             description: The product's manage inventory.
- *           variant_rank:
- *             type: number
- *             title: variant_rank
- *             description: The product's variant rank.
- *           weight:
- *             type: number
- *             title: weight
- *             description: The product's weight.
- *           length:
- *             type: number
- *             title: length
- *             description: The product's length.
- *           height:
- *             type: number
- *             title: height
- *             description: The product's height.
- *           width:
- *             type: number
- *             title: width
- *             description: The product's width.
- *           origin_country:
- *             type: string
- *             title: origin_country
- *             description: The product's origin country.
- *           material:
- *             type: string
- *             title: material
- *             description: The product's material.
- *           metadata:
  *                 type: object
- *             description: The product's metadata.
+ *                 description: Pass additional custom data to the API route. This data is passed
- *           prices:
+ *                   to the underlying workflow under the `additional_data`
- *             type: array
+ *                   parameter.
- *             description: The product's prices.
+ *         description: SUMMARY
- *             items:
- *               $ref: "#/components/schemas/AdminCreateProductVariantPrice"
- *           options:
- *             type: object
- *             description: The product's options.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts

@@ -63,7 +63,14 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - code
+ *               - type
+ *               - campaign_id
+ *               - application_method
  *             properties:
  *               code:
  *                 type: string
@@ -325,6 +332,15 @@
  *                             type: string
  *                             title: values
  *                             description: The value's values.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts

@@ -69,7 +69,11 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - type: object
  *             description: SUMMARY
+ *             required:
+ *               - campaign_id
  *             properties:
  *               code:
  *                 type: string
@@ -328,6 +332,15 @@
  *                             type: string
  *                             title: values
  *                             description: The value's values.
+ *           - type: object
+ *             description: SUMMARY
+ *             properties:
+ *               additional_data:
+ *                 type: object
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/store/post_store_carts.ts

@@ -59,64 +59,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/CreateCartWorkflowInput"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           region_id:
+ *               additional_data:
- *             type: string
- *             title: region_id
- *             description: The cart's region id.
- *           customer_id:
- *             type: string
- *             title: customer_id
- *             description: The cart's customer id.
- *           sales_channel_id:
- *             type: string
- *             title: sales_channel_id
- *             description: The cart's sales channel id.
- *           email:
- *             type: string
- *             title: email
- *             description: The cart's email.
- *             format: email
- *           currency_code:
- *             type: string
- *             title: currency_code
- *             description: The cart's currency code.
- *           shipping_address_id:
- *             type: string
- *             title: shipping_address_id
- *             description: The cart's shipping address id.
- *           billing_address_id:
- *             type: string
- *             title: billing_address_id
- *             description: The cart's billing address id.
- *           shipping_address:
- *             oneOf:
- *               - type: string
- *                 title: shipping_address
- *                 description: The cart's shipping address.
- *               - $ref: "#/components/schemas/CreateCartAddress"
- *           billing_address:
- *             oneOf:
- *               - type: string
- *                 title: billing_address
- *                 description: The cart's billing address.
- *               - $ref: "#/components/schemas/CreateCartAddress"
- *           metadata:
  *                 type: object
- *             description: The cart's metadata.
+ *                 description: Pass additional custom data to the API route. This data is passed
- *           items:
+ *                   to the underlying workflow under the `additional_data`
- *             type: array
+ *                   parameter.
- *             description: The cart's items.
+ *         description: SUMMARY
- *             items:
- *               $ref: "#/components/schemas/CreateCartCreateLineItem"
- *           promo_codes:
- *             type: array
- *             description: The cart's promo codes.
- *             items:
- *               type: string
- *               title: promo_codes
- *               description: The promo code's promo codes.
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts

@@ -65,48 +65,17 @@
  *   content:
  *     application/json:
  *       schema:
+ *         allOf:
+ *           - $ref: "#/components/schemas/UpdateCartData"
+ *           - type: object
  *             description: SUMMARY
  *             properties:
- *           region_id:
+ *               additional_data:
- *             type: string
- *             title: region_id
- *             description: The cart's region id.
- *           customer_id:
- *             type: string
- *             title: customer_id
- *             description: The cart's customer id.
- *           sales_channel_id:
- *             type: string
- *             title: sales_channel_id
- *             description: The cart's sales channel id.
- *           email:
- *             type: string
- *             title: email
- *             description: The cart's email.
- *             format: email
- *           currency_code:
- *             type: string
- *             title: currency_code
- *             description: The cart's currency code.
- *           shipping_address_id:
- *             type: string
- *             title: shipping_address_id
- *             description: The cart's shipping address id.
- *           billing_address_id:
- *             type: string
- *             title: billing_address_id
- *             description: The cart's billing address id.
- *           billing_address:
- *             oneOf:
- *               - $ref: "#/components/schemas/CreateAddress"
- *               - $ref: "#/components/schemas/UpdateAddress"
- *           shipping_address:
- *             oneOf:
- *               - $ref: "#/components/schemas/CreateAddress"
- *               - $ref: "#/components/schemas/UpdateAddress"
- *           metadata:
  *                 type: object
- *             description: The cart's metadata.
+ *                 description: Pass additional custom data to the API route. This data is passed
+ *                   to the underlying workflow under the `additional_data`
+ *                   parameter.
+ *         description: SUMMARY
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

www/utils/generated/oas-output/schemas/AdminPaymentCollectionResponse.ts

@@ -0,0 +1,13 @@
+/**
+ * @schema AdminPaymentCollectionResponse
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminPaymentCollectionResponse
+ * required:
+ *   - payment_collection
+ * properties:
+ *   payment_collection:
+ *     $ref: "#/components/schemas/AdminPaymentCollection"
+ * 
+*/
+

www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts

@@ -0,0 +1,65 @@
+/**
+ * @schema CreateCartWorkflowInput
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: CreateCartWorkflowInput
+ * properties:
+ *   region_id:
+ *     type: string
+ *     title: region_id
+ *     description: The cart's region id.
+ *   customer_id:
+ *     type: string
+ *     title: customer_id
+ *     description: The cart's customer id.
+ *   sales_channel_id:
+ *     type: string
+ *     title: sales_channel_id
+ *     description: The cart's sales channel id.
+ *   email:
+ *     type: string
+ *     title: email
+ *     description: The cart's email.
+ *     format: email
+ *   currency_code:
+ *     type: string
+ *     title: currency_code
+ *     description: The cart's currency code.
+ *   shipping_address_id:
+ *     type: string
+ *     title: shipping_address_id
+ *     description: The cart's shipping address id.
+ *   billing_address_id:
+ *     type: string
+ *     title: billing_address_id
+ *     description: The cart's billing address id.
+ *   shipping_address:
+ *     oneOf:
+ *       - type: string
+ *         title: shipping_address
+ *         description: The cart's shipping address.
+ *       - $ref: "#/components/schemas/CreateCartAddress"
+ *   billing_address:
+ *     oneOf:
+ *       - type: string
+ *         title: billing_address
+ *         description: The cart's billing address.
+ *       - $ref: "#/components/schemas/CreateCartAddress"
+ *   metadata:
+ *     type: object
+ *     description: The cart's metadata.
+ *   items:
+ *     type: array
+ *     description: The cart's items.
+ *     items:
+ *       $ref: "#/components/schemas/CreateCartCreateLineItem"
+ *   promo_codes:
+ *     type: array
+ *     description: The cart's promo codes.
+ *     items:
+ *       type: string
+ *       title: promo_codes
+ *       description: The promo code's promo codes.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/CreateUser.ts

@@ -1,31 +0,0 @@
-/**
- * @schema CreateUser
- * type: object
- * description: SUMMARY
- * x-schemaName: CreateUser
- * required:
- *   - email
- * properties:
- *   email:
- *     type: string
- *     title: email
- *     description: The user's email.
- *     format: email
- *   first_name:
- *     type: string
- *     title: first_name
- *     description: The user's first name.
- *   last_name:
- *     type: string
- *     title: last_name
- *     description: The user's last name.
- *   avatar_url:
- *     type: string
- *     title: avatar_url
- *     description: The user's avatar url.
- *   metadata:
- *     type: object
- *     description: The user's metadata.
- * 
-*/
-

www/utils/generated/oas-output/schemas/UpdateCartData.ts

@@ -0,0 +1,49 @@
+/**
+ * @schema UpdateCartData
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: UpdateCartData
+ * properties:
+ *   region_id:
+ *     type: string
+ *     title: region_id
+ *     description: The cart's region id.
+ *   customer_id:
+ *     type: string
+ *     title: customer_id
+ *     description: The cart's customer id.
+ *   sales_channel_id:
+ *     type: string
+ *     title: sales_channel_id
+ *     description: The cart's sales channel id.
+ *   email:
+ *     type: string
+ *     title: email
+ *     description: The cart's email.
+ *     format: email
+ *   currency_code:
+ *     type: string
+ *     title: currency_code
+ *     description: The cart's currency code.
+ *   shipping_address_id:
+ *     type: string
+ *     title: shipping_address_id
+ *     description: The cart's shipping address id.
+ *   billing_address_id:
+ *     type: string
+ *     title: billing_address_id
+ *     description: The cart's billing address id.
+ *   billing_address:
+ *     oneOf:
+ *       - $ref: "#/components/schemas/CreateAddress"
+ *       - $ref: "#/components/schemas/UpdateAddress"
+ *   shipping_address:
+ *     oneOf:
+ *       - $ref: "#/components/schemas/CreateAddress"
+ *       - $ref: "#/components/schemas/UpdateAddress"
+ *   metadata:
+ *     type: object
+ *     description: The cart's metadata.
+ * 
+*/
+