chore(docs): Updated API Reference (v2) (#8686)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}/delete.sh

@@ -0,0 +1,2 @@
+curl -X DELETE '{backend_url}/admin/payment-collections/{id}' \
+-H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/post.sh

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

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

@@ -46,6 +46,11 @@ properties:
     description: The order's payment collections.
     items:
       $ref: ./AdminPaymentCollection.yaml
+  fulfillments:
+    type: array
+    description: The order's fulfillments.
+    items:
+      $ref: ./BaseOrderFulfillment.yaml
   id:
     type: string
     title: id
@@ -106,11 +111,6 @@ properties:
       - partially_refunded
       - refunded
       - requires_action
-  fulfillments:
-    type: array
-    description: The order's fulfillments.
-    items:
-      $ref: ./BaseOrderFulfillment.yaml
   fulfillment_status:
     type: string
     enum:

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

@@ -12228,18 +12228,12 @@ paths:
             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 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.
-            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: |-
+            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.
-              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.
@@ -13900,6 +13894,7 @@ paths:
               description: SUMMARY
               required:
                 - order_id
+                - amount
               properties:
                 order_id:
                   type: string
@@ -13941,6 +13936,224 @@ paths:
         '500':
           $ref: '#/components/responses/500_error'
       x-workflow: createOrderPaymentCollectionWorkflow
+  /admin/payment-collections/{id}:
+    delete:
+      operationId: DeletePaymentCollectionsId
+      summary: Delete a Payment Collection
+      description: Delete a payment collection.
+      x-authenticated: true
+      parameters:
+        - name: id
+          in: path
+          description: The payment collection's ID.
+          required: true
+          schema:
+            type: string
+        - 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: []
+      x-codeSamples:
+        - lang: Shell
+          label: cURL
+          source: |-
+            curl -X DELETE '{backend_url}/admin/payment-collections/{id}' \
+            -H 'x-medusa-access-token: {api_token}'
+      tags:
+        - Payment Collections
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                description: SUMMARY
+                required:
+                  - id
+                  - object
+                  - deleted
+                properties:
+                  id:
+                    type: string
+                    title: id
+                    description: The payment collection's ID.
+                  object:
+                    type: string
+                    title: object
+                    description: The payment collection's object.
+                  deleted:
+                    type: boolean
+                    title: deleted
+                    description: The payment collection's deleted.
+                  parent:
+                    type: object
+                    description: The payment collection's parent.
+        '400':
+          $ref: '#/components/responses/400_error'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/not_found_error'
+        '409':
+          $ref: '#/components/responses/invalid_state_error'
+        '422':
+          $ref: '#/components/responses/invalid_request_error'
+        '500':
+          $ref: '#/components/responses/500_error'
+  /admin/payment-collections/{id}/mark-as-paid:
+    post:
+      operationId: PostPaymentCollectionsIdMarkAsPaid
+      summary: Add Mark As Paids to Payment Collection
+      description: Add a list of mark as paids to a payment collection.
+      x-authenticated: true
+      parameters:
+        - name: id
+          in: path
+          description: The payment collection's ID.
+          required: true
+          schema:
+            type: string
+        - 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.
+      x-codeSamples:
+        - lang: Shell
+          label: cURL
+          source: |-
+            curl -X POST '{backend_url}/admin/payment-collections/{id}/mark-as-paid' \
+            -H 'x-medusa-access-token: {api_token}' \
+            -H 'Content-Type: application/json' \
+            --data-raw '{
+              "order_id": "{value}"
+            }'
+      tags:
+        - Payment Collections
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdminPaymentCollectionResponse'
+        '400':
+          $ref: '#/components/responses/400_error'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/not_found_error'
+        '409':
+          $ref: '#/components/responses/invalid_state_error'
+        '422':
+          $ref: '#/components/responses/invalid_request_error'
+        '500':
+          $ref: '#/components/responses/500_error'
   /admin/payments:
     get:
       operationId: GetPayments
@@ -46806,6 +47019,11 @@ components:
           description: The order's payment collections.
           items:
             $ref: '#/components/schemas/AdminPaymentCollection'
+        fulfillments:
+          type: array
+          description: The order's fulfillments.
+          items:
+            $ref: '#/components/schemas/BaseOrderFulfillment'
         id:
           type: string
           title: id
@@ -46866,11 +47084,6 @@ components:
             - partially_refunded
             - refunded
             - requires_action
-        fulfillments:
-          type: array
-          description: The order's fulfillments.
-          items:
-            $ref: '#/components/schemas/BaseOrderFulfillment'
         fulfillment_status:
           type: string
           enum:

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

@@ -325,6 +325,10 @@ paths:
     $ref: paths/admin_orders_{id}_preview.yaml
   /admin/payment-collections:
     $ref: paths/admin_payment-collections.yaml
+  /admin/payment-collections/{id}:
+    $ref: paths/admin_payment-collections_{id}.yaml
+  /admin/payment-collections/{id}/mark-as-paid:
+    $ref: paths/admin_payment-collections_{id}_mark-as-paid.yaml
   /admin/payments:
     $ref: paths/admin_payments.yaml
   /admin/payments/payment-providers:

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_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.

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

@@ -71,6 +71,7 @@ post:
           description: SUMMARY
           required:
             - order_id
+            - amount
           properties:
             order_id:
               type: string

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

@@ -0,0 +1,116 @@
+delete:
+  operationId: DeletePaymentCollectionsId
+  summary: Delete a Payment Collection
+  description: Delete a payment collection.
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The payment collection's ID.
+      required: true
+      schema:
+        type: string
+    - 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: []
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_payment-collections_{id}/delete.sh
+  tags:
+    - Payment Collections
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            description: SUMMARY
+            required:
+              - id
+              - object
+              - deleted
+            properties:
+              id:
+                type: string
+                title: id
+                description: The payment collection's ID.
+              object:
+                type: string
+                title: object
+                description: The payment collection's object.
+              deleted:
+                type: boolean
+                title: deleted
+                description: The payment collection's deleted.
+              parent:
+                type: object
+                description: The payment collection's parent.
+    '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

www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml

@@ -0,0 +1,109 @@
+post:
+  operationId: PostPaymentCollectionsIdMarkAsPaid
+  summary: Add Mark As Paids to Payment Collection
+  description: Add a list of mark as paids to a payment collection.
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The payment collection's ID.
+      required: true
+      schema:
+        type: string
+    - 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.
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/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

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

@@ -46,6 +46,11 @@ properties:
     description: The order's payment collections.
     items:
       $ref: ./AdminPaymentCollection.yaml
+  fulfillments:
+    type: array
+    description: The order's fulfillments.
+    items:
+      $ref: ./BaseOrderFulfillment.yaml
   id:
     type: string
     title: id
@@ -106,11 +111,6 @@ properties:
       - partially_refunded
       - refunded
       - requires_action
-  fulfillments:
-    type: array
-    description: The order's fulfillments.
-    items:
-      $ref: ./BaseOrderFulfillment.yaml
   fulfillment_status:
     type: string
     enum:

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

@@ -13429,6 +13429,11 @@ components:
           description: The order's payment collections.
           items:
             $ref: '#/components/schemas/AdminPaymentCollection'
+        fulfillments:
+          type: array
+          description: The order's fulfillments.
+          items:
+            $ref: '#/components/schemas/BaseOrderFulfillment'
         id:
           type: string
           title: id
@@ -13489,11 +13494,6 @@ components:
             - partially_refunded
             - refunded
             - requires_action
-        fulfillments:
-          type: array
-          description: The order's fulfillments.
-          items:
-            $ref: '#/components/schemas/BaseOrderFulfillment'
         fulfillment_status:
           type: string
           enum:

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

@@ -0,0 +1,118 @@
+/**
+ * @oas [delete] /admin/payment-collections/{id}
+ * operationId: DeletePaymentCollectionsId
+ * summary: Delete a Payment Collection
+ * description: Delete a payment collection.
+ * x-authenticated: true
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The payment collection's ID.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - 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: []
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X DELETE '{backend_url}/admin/payment-collections/{id}' \
+ *       -H 'x-medusa-access-token: {api_token}'
+ * tags:
+ *   - Payment Collections
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           type: object
+ *           description: SUMMARY
+ *           required:
+ *             - id
+ *             - object
+ *             - deleted
+ *           properties:
+ *             id:
+ *               type: string
+ *               title: id
+ *               description: The payment collection's ID.
+ *             object:
+ *               type: string
+ *               title: object
+ *               description: The payment collection's object.
+ *             deleted:
+ *               type: boolean
+ *               title: deleted
+ *               description: The payment collection's deleted.
+ *             parent:
+ *               type: object
+ *               description: The payment collection's parent.
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_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_payment-collections.ts

@@ -67,6 +67,7 @@
  *         description: SUMMARY
  *         required:
  *           - order_id
+ *           - amount
  *         properties:
  *           order_id:
  *             type: string

www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts

@@ -0,0 +1,114 @@
+/**
+ * @oas [post] /admin/payment-collections/{id}/mark-as-paid
+ * operationId: PostPaymentCollectionsIdMarkAsPaid
+ * summary: Add Mark As Paids to Payment Collection
+ * description: Add a list of mark as paids to a payment collection.
+ * x-authenticated: true
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The payment collection's ID.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - 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.
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/admin/payment-collections/{id}/mark-as-paid' \
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "order_id": "{value}"
+ *       }'
+ * tags:
+ *   - Payment Collections
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminPaymentCollectionResponse"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+

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

@@ -48,6 +48,11 @@
  *     description: The order's payment collections.
  *     items:
  *       $ref: "#/components/schemas/AdminPaymentCollection"
+ *   fulfillments:
+ *     type: array
+ *     description: The order's fulfillments.
+ *     items:
+ *       $ref: "#/components/schemas/BaseOrderFulfillment"
  *   id:
  *     type: string
  *     title: id
@@ -108,11 +113,6 @@
  *       - partially_refunded
  *       - refunded
  *       - requires_action
- *   fulfillments:
- *     type: array
- *     description: The order's fulfillments.
- *     items:
- *       $ref: "#/components/schemas/BaseOrderFulfillment"
  *   fulfillment_status:
  *     type: string
  *     enum: