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

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

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -61,6 +67,8 @@ get:
           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 `-`.
+        externalDocs:
+          url: '#pagination'
     - name: q
       in: query
       description: A search term to search the API keys' searchable properties.

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -173,7 +177,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object

www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -152,6 +158,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -236,7 +240,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -1052,6 +1058,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml

@@ -49,6 +49,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -138,6 +140,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml

@@ -50,6 +50,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml

@@ -50,6 +50,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -139,6 +141,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml

@@ -50,6 +50,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -139,6 +141,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -37,6 +37,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -67,10 +69,6 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
-  requestBody:
-    content:
-      application/json:
-        schema: {}
   x-workflow: confirmClaimRequestWorkflow
 delete:
   operationId: DeleteClaimsIdRequest

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -1008,6 +1014,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-

www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -984,7 +990,7 @@ get:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The paginated list of customer groups.
                 required:
                   - limit
                   - offset
@@ -993,23 +999,25 @@ get:
                   limit:
                     type: number
                     title: limit
-                    description: The customer group's limit.
+                    description: The maximum number of items retrieved.
                   offset:
                     type: number
                     title: offset
-                    description: The customer group's offset.
+                    description: >-
+                      The number of items skipped before retrieving the returned
+                      items.
                   count:
                     type: number
                     title: count
-                    description: The customer group's count.
+                    description: The total number of items
               - type: object
-                description: SUMMARY
+                description: The paginated list of customer groups.
                 required:
                   - customer_groups
                 properties:
                   customer_groups:
                     type: array
-                    description: The customer group's customer groups.
+                    description: The list of customer groups.
                     items:
                       $ref: ../components/schemas/AdminCustomerGroup.yaml
     '400':
@@ -1056,6 +1064,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -173,7 +177,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object

www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml

@@ -37,6 +37,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -4245,6 +4251,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -216,7 +220,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object
@@ -246,4 +250,4 @@ delete:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
-  x-workflow: deleteCustomersWorkflow
+  x-workflow: removeCustomerAccountWorkflow

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -46,6 +48,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -54,6 +58,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -273,6 +279,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -44,6 +44,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -120,6 +122,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -286,6 +290,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -306,7 +312,7 @@ delete:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The deletion's details.
                 required:
                   - id
                   - object
@@ -325,11 +331,11 @@ delete:
                     title: deleted
                     description: Whether the Customer was deleted.
               - type: object
-                description: SUMMARY
+                description: The deletion's details.
                 properties:
                   parent:
                     $ref: ../components/schemas/AdminCustomer.yaml
-            description: SUMMARY
+            description: The deletion's details.
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -1792,7 +1798,7 @@ get:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The paginated list of draft orders.
                 required:
                   - limit
                   - offset
@@ -1801,17 +1807,19 @@ get:
                   limit:
                     type: number
                     title: limit
-                    description: The draft order's limit.
+                    description: The maximum number of items returned.
                   offset:
                     type: number
                     title: offset
-                    description: The draft order's offset.
+                    description: >-
+                      The number of items skipped before retrieving the returned
+                      items.
                   count:
                     type: number
                     title: count
-                    description: The draft order's count.
+                    description: The total number of items.
               - type: object
-                description: SUMMARY
+                description: The paginated list of draft orders.
                 required:
                   - draft_orders
                 properties:
@@ -1863,6 +1871,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -965,7 +971,7 @@ get:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The paginated list of exchanges.
                 required:
                   - limit
                   - offset
@@ -974,22 +980,27 @@ get:
                   limit:
                     type: number
                     title: limit
-                    description: The exchange's limit.
+                    description: The maximum number of items returned.
                   offset:
                     type: number
                     title: offset
-                    description: The exchange's offset.
+                    description: >-
+                      The number of items skipped before retrieving the returned
+                      items.
                   count:
                     type: number
                     title: count
-                    description: The exchange's count.
+                    description: The total number of items.
               - type: object
-                description: SUMMARY
+                description: The paginated list of exchanges.
                 required:
                   - exchanges
                 properties:
                   exchanges:
-                    $ref: ../components/schemas/AdminExchange.yaml
+                    type: array
+                    description: The exchange's exchanges.
+                    items:
+                      $ref: ../components/schemas/AdminExchange.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':
@@ -1036,6 +1047,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -88,32 +88,6 @@ delete:
       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.
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -50,6 +50,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -50,6 +50,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -139,6 +141,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -50,6 +50,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -139,6 +141,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -36,6 +36,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -67,10 +69,6 @@ post:
     '500':
       $ref: ../components/responses/500_error.yaml
   x-workflow: confirmExchangeRequestWorkflow
-  requestBody:
-    content:
-      application/json:
-        schema: {}
 delete:
   operationId: DeleteExchangesIdRequest
   summary: Cancel Exchange Request

www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml

@@ -33,6 +33,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -41,6 +43,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -49,6 +53,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-

www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml

@@ -37,6 +37,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml

@@ -43,6 +43,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -119,6 +121,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -30,6 +30,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -41,6 +41,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -453,7 +459,7 @@ get:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The paginated list of inventory items.
                 required:
                   - limit
                   - offset
@@ -462,17 +468,19 @@ get:
                   limit:
                     type: number
                     title: limit
-                    description: The inventory item's limit.
+                    description: The maximum number of items returned.
                   offset:
                     type: number
                     title: offset
-                    description: The inventory item's offset.
+                    description: >-
+                      The number of items skipped before retrieving the returned
+                      items.
                   count:
                     type: number
                     title: count
-                    description: The inventory item's count.
+                    description: The total number of items.
               - type: object
-                description: SUMMARY
+                description: The paginated list of inventory items.
                 required:
                   - inventory_items
                 properties:
@@ -525,6 +533,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -234,7 +238,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object

www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml

@@ -39,6 +39,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -47,6 +49,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -55,6 +59,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -124,7 +130,7 @@ get:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The paginated list of inventory levels.
                 required:
                   - limit
                   - offset
@@ -133,17 +139,19 @@ get:
                   limit:
                     type: number
                     title: limit
-                    description: The inventory item's limit.
+                    description: The maximum number of items returned.
                   offset:
                     type: number
                     title: offset
-                    description: The inventory item's offset.
+                    description: >-
+                      The number of items skipped before retrieving the returned
+                      items.
                   count:
                     type: number
                     title: count
-                    description: The inventory item's count.
+                    description: The total number of items.
               - type: object
-                description: SUMMARY
+                description: The paginated list of inventory levels.
                 required:
                   - inventory_levels
                 properties:
@@ -203,6 +211,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml

@@ -45,6 +45,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -142,6 +144,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -162,7 +166,7 @@ delete:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The deletion's details.
                 required:
                   - id
                   - object
@@ -181,11 +185,11 @@ delete:
                     title: deleted
                     description: Whether the Inventory Item was deleted.
               - type: object
-                description: SUMMARY
+                description: The deletion's details.
                 properties:
                   parent:
                     $ref: ../components/schemas/AdminInventoryItem.yaml
-            description: SUMMARY
+            description: The deletion's details.
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -625,6 +631,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   requestBody:
     content:
       application/json:

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   x-codeSamples:
     - lang: Shell
       label: cURL
@@ -90,7 +92,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object

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

@@ -36,6 +36,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   x-codeSamples:
     - lang: Shell
       label: cURL
@@ -62,8 +64,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
-  requestBody:
-    content:
-      application/json:
-        schema: {}
   x-workflow: refreshInviteTokensWorkflow

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -28,7 +28,7 @@ delete:
         application/json:
           schema:
             type: object
-            description: SUMMARY
+            description: The deletion's details.
             required:
               - id
               - object

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -107,6 +109,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -137,7 +141,3 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
-  requestBody:
-    content:
-      application/json:
-        schema: {}

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

@@ -36,15 +36,12 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
     - jwt_token: []
-  requestBody:
-    content:
-      application/json:
-        schema:
-          $ref: ../components/schemas/AdminArchiveOrder.yaml
   x-codeSamples:
     - lang: Shell
       label: cURL

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

@@ -44,6 +44,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -74,8 +76,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
-  requestBody:
-    content:
-      application/json:
-        schema: {}
   x-workflow: cancelOrderWorkflow

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

@@ -36,6 +36,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -44,6 +44,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -0,0 +1,79 @@
+post:
+  operationId: PostOrdersIdFulfillmentsFulfillment_idMarkAsDelivered
+  summary: Mark a Fulfillment as Delivered.
+  x-sidebar-summary: Mark Delivered
+  description: Mark an order's fulfillment as delivered.
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The order's ID.
+      required: true
+      schema:
+        type: string
+    - name: fulfillment_id
+      in: path
+      description: The fulfillment'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.
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.sh
+  tags:
+    - Orders
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminOrderResponse.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: markOrderFulfillmentAsDeliveredWorkflow

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

@@ -43,6 +43,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -30,6 +30,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-

www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml

@@ -33,6 +33,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -41,6 +43,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -49,6 +53,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -475,6 +481,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml

@@ -30,8 +30,8 @@ post:
                 description: A price's details.
                 required:
                   - currency_code
-                  - amount
                   - variant_id
+                  - amount
                 properties:
                   currency_code:
                     type: string

www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml

@@ -36,6 +36,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml

@@ -33,6 +33,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -41,6 +43,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -49,6 +53,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -202,6 +208,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml

@@ -33,6 +33,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -41,6 +43,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -49,6 +53,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -689,6 +695,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: include_ancestors_tree
       in: query
       description: >-
@@ -130,6 +132,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml

@@ -37,6 +37,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -598,6 +604,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-types.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -598,6 +604,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -606,7 +614,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreateProduct.yaml
+          $ref: ../components/schemas/AdminCreateProductType.yaml
   x-codeSamples:
     - lang: Shell
       label: cURL

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -563,7 +569,7 @@ get:
           schema:
             allOf:
               - type: object
-                description: SUMMARY
+                description: The paginated list of product variants.
                 required:
                   - limit
                   - offset
@@ -572,17 +578,19 @@ get:
                   limit:
                     type: number
                     title: limit
-                    description: The product variant's limit.
+                    description: The maximum number of items returned.
                   offset:
                     type: number
                     title: offset
-                    description: The product variant's offset.
+                    description: >-
+                      The number of items skipped before retrieving the returned
+                      items.
                   count:
                     type: number
                     title: count
-                    description: The product variant's count.
+                    description: The total number of items.
               - type: object
-                description: SUMMARY
+                description: The paginated list of product variants.
                 required:
                   - variants
                 properties:

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -48,6 +50,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -673,6 +677,522 @@ get:
               type: string
               title: collection_id
               description: A product collection's ID.
+    - name: variants
+      in: query
+      description: Filter the retrieved products' variants.
+      required: false
+      schema:
+        type: object
+        description: Filter the retrieved products' variants.
+        x-schemaName: AdminProductVariantParams
+        properties:
+          q:
+            type: string
+            title: q
+            description: Search term to apply on the variant's searchable properties.
+          id:
+            oneOf:
+              - type: string
+                title: id
+                description: Filter by a variant's ID.
+              - type: array
+                description: Filter by variant IDs.
+                items:
+                  type: string
+                  title: id
+                  description: A variant's ID.
+          manage_inventory:
+            type: boolean
+            title: manage_inventory
+            description: >-
+              Filter by whether the Medusa application manages the variant's
+              inventory.
+          allow_backorder:
+            type: boolean
+            title: allow_backorder
+            description: >-
+              Filter by whether the variant can be ordered even if it's out of
+              stock.
+          created_at:
+            type: object
+            description: Filter by the variant's creation date.
+            properties:
+              $and:
+                type: array
+                description: >-
+                  Join query parameters with an AND condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $and
+              $or:
+                type: array
+                description: >-
+                  Join query parameters with an OR condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $or
+              $eq:
+                oneOf:
+                  - type: string
+                    title: $eq
+                    description: Filter by an exact match.
+                  - type: array
+                    description: Filter by an exact match.
+                    items:
+                      type: string
+                      title: $eq
+                      description: Filter by an exact match.
+              $ne:
+                type: string
+                title: $ne
+                description: Filter by values not equal to this parameter.
+              $in:
+                type: array
+                description: Filter by values in this array.
+                items:
+                  type: string
+                  title: $in
+                  description: Filter by values in this array.
+              $nin:
+                type: array
+                description: Filter by values not in this array.
+                items:
+                  type: string
+                  title: $nin
+                  description: Filter by values not in this array.
+              $not:
+                oneOf:
+                  - type: string
+                    title: $not
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                  - type: object
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                  - type: array
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                    items:
+                      type: string
+                      title: $not
+                      description: >-
+                        Filter by values not matching the conditions in this
+                        parameter.
+              $gt:
+                type: string
+                title: $gt
+                description: >-
+                  Filter by values greater than this parameter. Useful for
+                  numbers and dates only.
+              $gte:
+                type: string
+                title: $gte
+                description: >-
+                  Filter by values greater than or equal to this parameter.
+                  Useful for numbers and dates only.
+              $lt:
+                type: string
+                title: $lt
+                description: >-
+                  Filter by values less than this parameter. Useful for numbers
+                  and dates only.
+              $lte:
+                type: string
+                title: $lte
+                description: >-
+                  Filter by values less than or equal to this parameter. Useful
+                  for numbers and dates only.
+              $like:
+                type: string
+                title: $like
+                description: Apply a `like` filter. Useful for strings only.
+              $re:
+                type: string
+                title: $re
+                description: Apply a regex filter. Useful for strings only.
+              $ilike:
+                type: string
+                title: $ilike
+                description: >-
+                  Apply a case-insensitive `like` filter. Useful for strings
+                  only.
+              $fulltext:
+                type: string
+                title: $fulltext
+                description: Filter to apply on full-text properties.
+              $overlap:
+                type: array
+                description: >-
+                  Filter arrays that have overlapping values with this
+                  parameter.
+                items:
+                  type: string
+                  title: $overlap
+                  description: >-
+                    Filter arrays that have overlapping values with this
+                    parameter.
+              $contains:
+                type: array
+                description: >-
+                  Filter arrays that contain some of the values of this
+                  parameter.
+                items:
+                  type: string
+                  title: $contains
+                  description: >-
+                    Filter arrays that contain some of the values of this
+                    parameter.
+              $contained:
+                type: array
+                description: Filter arrays that contain all values of this parameter.
+                items:
+                  type: string
+                  title: $contained
+                  description: Filter arrays that contain all values of this parameter.
+              $exists:
+                type: boolean
+                title: $exists
+                description: >-
+                  Filter by whether a value for this parameter exists (not
+                  `null`).
+          updated_at:
+            type: object
+            description: The variant's updated at.
+            properties:
+              $and:
+                type: array
+                description: >-
+                  Join query parameters with an AND condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $and
+              $or:
+                type: array
+                description: >-
+                  Join query parameters with an OR condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $or
+              $eq:
+                oneOf:
+                  - type: string
+                    title: $eq
+                    description: Filter by an exact match.
+                  - type: array
+                    description: Filter by an exact match.
+                    items:
+                      type: string
+                      title: $eq
+                      description: Filter by an exact match.
+              $ne:
+                type: string
+                title: $ne
+                description: Filter by values not equal to this parameter.
+              $in:
+                type: array
+                description: Filter by values in this array.
+                items:
+                  type: string
+                  title: $in
+                  description: Filter by values in this array.
+              $nin:
+                type: array
+                description: Filter by values not in this array.
+                items:
+                  type: string
+                  title: $nin
+                  description: Filter by values not in this array.
+              $not:
+                oneOf:
+                  - type: string
+                    title: $not
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                  - type: object
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                  - type: array
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                    items:
+                      type: string
+                      title: $not
+                      description: >-
+                        Filter by values not matching the conditions in this
+                        parameter.
+              $gt:
+                type: string
+                title: $gt
+                description: >-
+                  Filter by values greater than this parameter. Useful for
+                  numbers and dates only.
+              $gte:
+                type: string
+                title: $gte
+                description: >-
+                  Filter by values greater than or equal to this parameter.
+                  Useful for numbers and dates only.
+              $lt:
+                type: string
+                title: $lt
+                description: >-
+                  Filter by values less than this parameter. Useful for numbers
+                  and dates only.
+              $lte:
+                type: string
+                title: $lte
+                description: >-
+                  Filter by values less than or equal to this parameter. Useful
+                  for numbers and dates only.
+              $like:
+                type: string
+                title: $like
+                description: Apply a `like` filter. Useful for strings only.
+              $re:
+                type: string
+                title: $re
+                description: Apply a regex filter. Useful for strings only.
+              $ilike:
+                type: string
+                title: $ilike
+                description: >-
+                  Apply a case-insensitive `like` filter. Useful for strings
+                  only.
+              $fulltext:
+                type: string
+                title: $fulltext
+                description: Filter to apply on full-text properties.
+              $overlap:
+                type: array
+                description: >-
+                  Filter arrays that have overlapping values with this
+                  parameter.
+                items:
+                  type: string
+                  title: $overlap
+                  description: >-
+                    Filter arrays that have overlapping values with this
+                    parameter.
+              $contains:
+                type: array
+                description: >-
+                  Filter arrays that contain some of the values of this
+                  parameter.
+                items:
+                  type: string
+                  title: $contains
+                  description: >-
+                    Filter arrays that contain some of the values of this
+                    parameter.
+              $contained:
+                type: array
+                description: Filter arrays that contain all values of this parameter.
+                items:
+                  type: string
+                  title: $contained
+                  description: Filter arrays that contain all values of this parameter.
+              $exists:
+                type: boolean
+                title: $exists
+                description: >-
+                  Filter by whether a value for this parameter exists (not
+                  `null`).
+          deleted_at:
+            type: object
+            description: The variant's deleted at.
+            properties:
+              $and:
+                type: array
+                description: >-
+                  Join query parameters with an AND condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $and
+              $or:
+                type: array
+                description: >-
+                  Join query parameters with an OR condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $or
+              $eq:
+                oneOf:
+                  - type: string
+                    title: $eq
+                    description: Filter by an exact match.
+                  - type: array
+                    description: Filter by an exact match.
+                    items:
+                      type: string
+                      title: $eq
+                      description: Filter by an exact match.
+              $ne:
+                type: string
+                title: $ne
+                description: Filter by values not equal to this parameter.
+              $in:
+                type: array
+                description: Filter by values in this array.
+                items:
+                  type: string
+                  title: $in
+                  description: Filter by values in this array.
+              $nin:
+                type: array
+                description: Filter by values not in this array.
+                items:
+                  type: string
+                  title: $nin
+                  description: Filter by values not in this array.
+              $not:
+                oneOf:
+                  - type: string
+                    title: $not
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                  - type: object
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                  - type: array
+                    description: >-
+                      Filter by values not matching the conditions in this
+                      parameter.
+                    items:
+                      type: string
+                      title: $not
+                      description: >-
+                        Filter by values not matching the conditions in this
+                        parameter.
+              $gt:
+                type: string
+                title: $gt
+                description: >-
+                  Filter by values greater than this parameter. Useful for
+                  numbers and dates only.
+              $gte:
+                type: string
+                title: $gte
+                description: >-
+                  Filter by values greater than or equal to this parameter.
+                  Useful for numbers and dates only.
+              $lt:
+                type: string
+                title: $lt
+                description: >-
+                  Filter by values less than this parameter. Useful for numbers
+                  and dates only.
+              $lte:
+                type: string
+                title: $lte
+                description: >-
+                  Filter by values less than or equal to this parameter. Useful
+                  for numbers and dates only.
+              $like:
+                type: string
+                title: $like
+                description: Apply a `like` filter. Useful for strings only.
+              $re:
+                type: string
+                title: $re
+                description: Apply a regex filter. Useful for strings only.
+              $ilike:
+                type: string
+                title: $ilike
+                description: >-
+                  Apply a case-insensitive `like` filter. Useful for strings
+                  only.
+              $fulltext:
+                type: string
+                title: $fulltext
+                description: Filter to apply on full-text properties.
+              $overlap:
+                type: array
+                description: >-
+                  Filter arrays that have overlapping values with this
+                  parameter.
+                items:
+                  type: string
+                  title: $overlap
+                  description: >-
+                    Filter arrays that have overlapping values with this
+                    parameter.
+              $contains:
+                type: array
+                description: >-
+                  Filter arrays that contain some of the values of this
+                  parameter.
+                items:
+                  type: string
+                  title: $contains
+                  description: >-
+                    Filter arrays that contain some of the values of this
+                    parameter.
+              $contained:
+                type: array
+                description: Filter arrays that contain all values of this parameter.
+                items:
+                  type: string
+                  title: $contained
+                  description: Filter arrays that contain all values of this parameter.
+              $exists:
+                type: boolean
+                title: $exists
+                description: >-
+                  Filter by whether a value for this parameter exists (not
+                  `null`).
+          limit:
+            type: number
+            title: limit
+            description: Limit the number of items returned in the list.
+          offset:
+            type: number
+            title: offset
+            description: The number of items to skip when retrieving a list.
+          order:
+            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 `-`.
+          fields:
+            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.
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
   security:
     - api_token: []
     - cookie_auth: []
@@ -766,6 +1286,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -30,6 +30,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -40,6 +40,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -38,6 +38,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -106,6 +108,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -47,6 +49,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -55,6 +59,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -230,6 +236,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -43,6 +43,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -118,6 +120,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -213,6 +217,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -39,6 +39,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -47,6 +49,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -55,6 +59,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -649,6 +655,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -37,6 +37,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -36,9 +36,9 @@ post:
                   The associations to create between a product variant and an
                   inventory item.
                 required:
-                  - required_quantity
-                  - inventory_item_id
                   - variant_id
+                  - inventory_item_id
+                  - required_quantity
                 properties:
                   required_quantity:
                     type: number
@@ -63,9 +63,9 @@ post:
                 type: object
                 description: Update a product variant's association with an inventory item.
                 required:
-                  - required_quantity
-                  - inventory_item_id
                   - variant_id
+                  - inventory_item_id
+                  - required_quantity
                 properties:
                   required_quantity:
                     type: number
@@ -90,8 +90,8 @@ post:
                 type: object
                 description: Delete a product variant's association with an inventory item.
                 required:
-                  - inventory_item_id
                   - variant_id
+                  - inventory_item_id
                 properties:
                   inventory_item_id:
                     type: string

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

@@ -43,6 +43,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -118,6 +120,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -211,6 +215,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -45,6 +45,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -51,6 +51,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []
@@ -139,6 +141,8 @@ delete:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,8 @@ get:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
     - name: offset
       in: query
       description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-
@@ -652,6 +658,8 @@ post:
           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.
+        externalDocs:
+          url: '#select-fields-and-relations'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml

@@ -1,10 +1,10 @@
 get:
   operationId: GetPromotionsRuleAttributeOptionsRule_type
   summary: List Rule Attribute Options of a Rule Type
-  x-sidebar-summary: List Rule Attribute Options
+  x-sidebar-summary: List Potential Rule Attributes
   description: >
-    Retrieve a list of attributes for the promotion and application method types
-    specified in the query parameters.
+    Retrieve a list of potential rule attributes for the promotion and
+    application method types specified in the query parameters.
 
     Only the attributes of the rule type specified in the path parameter are
     retrieved:
@@ -14,8 +14,11 @@ get:
 
 
     - If `rule_type` is `target-rules`, the target rules' attributes of the
-    application method's type are retrieved. - If `rule_type` is `buy-rules`,
-    the buy rules' attributes of the application method's type are retrieved.
+    application method's type are retrieved.
+
+
+    - If `rule_type` is `buy-rules`, the buy rules' attributes of the
+    application method's type are retrieved.
   x-authenticated: true
   parameters:
     - name: rule_type

www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml

@@ -35,6 +35,8 @@ get:
         type: number
         title: offset
         description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
     - name: limit
       in: query
       description: Limit the number of items returned in the list.
@@ -43,6 +45,8 @@ get:
         type: number
         title: limit
         description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
     - name: order
       in: query
       description: >-