chore(docs): Generated API Reference (#3308)

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

docs/api/admin/components/schemas/Order.yaml

@@ -303,6 +303,13 @@ properties:
     description: The total of gift cards with taxes
     type: integer
     example: 0
+  returnable_items:
+    description: >-
+      The items that are returnable as part of the order, order swaps or order
+      claims
+    type: array
+    items:
+      $ref: ./LineItem.yaml
   created_at:
     description: The date with timezone at which the resource was created.
     type: string

docs/api/admin/openapi.yaml

@@ -197,10 +197,6 @@ paths:
     $ref: paths/currencies.yaml
   /currencies/{code}:
     $ref: paths/currencies_{code}.yaml
-  /customers:
-    $ref: paths/customers.yaml
-  /customers/{id}:
-    $ref: paths/customers_{id}.yaml
   /customer-groups/{id}/customers/batch:
     $ref: paths/customer-groups_{id}_customers_batch.yaml
   /customer-groups:
@@ -209,6 +205,10 @@ paths:
     $ref: paths/customer-groups_{id}.yaml
   /customer-groups/{id}/customers:
     $ref: paths/customer-groups_{id}_customers.yaml
+  /customers:
+    $ref: paths/customers.yaml
+  /customers/{id}:
+    $ref: paths/customers_{id}.yaml
   /discounts/{id}/regions/{region_id}:
     $ref: paths/discounts_{id}_regions_{region_id}.yaml
   /discounts/{discount_id}/conditions/{condition_id}/batch:
@@ -243,14 +243,6 @@ paths:
     $ref: paths/gift-cards.yaml
   /gift-cards/{id}:
     $ref: paths/gift-cards_{id}.yaml
-  /invites/accept:
-    $ref: paths/invites_accept.yaml
-  /invites:
-    $ref: paths/invites.yaml
-  /invites/{invite_id}:
-    $ref: paths/invites_{invite_id}.yaml
-  /invites/{invite_id}/resend:
-    $ref: paths/invites_{invite_id}_resend.yaml
   /inventory-items/{id}/location-levels:
     $ref: paths/inventory-items_{id}_location-levels.yaml
   /inventory-items/{id}:
@@ -259,14 +251,22 @@ paths:
     $ref: paths/inventory-items_{id}_location-levels_{location_id}.yaml
   /inventory-items:
     $ref: paths/inventory-items.yaml
-  /notifications:
-    $ref: paths/notifications.yaml
-  /notifications/{id}/resend:
-    $ref: paths/notifications_{id}_resend.yaml
+  /invites/accept:
+    $ref: paths/invites_accept.yaml
+  /invites:
+    $ref: paths/invites.yaml
+  /invites/{invite_id}:
+    $ref: paths/invites_{invite_id}.yaml
+  /invites/{invite_id}/resend:
+    $ref: paths/invites_{invite_id}_resend.yaml
   /notes:
     $ref: paths/notes.yaml
   /notes/{id}:
     $ref: paths/notes_{id}.yaml
+  /notifications:
+    $ref: paths/notifications.yaml
+  /notifications/{id}/resend:
+    $ref: paths/notifications_{id}_resend.yaml
   /order-edits/{id}/items:
     $ref: paths/order-edits_{id}_items.yaml
   /order-edits/{id}/cancel:
@@ -283,10 +283,6 @@ paths:
     $ref: paths/order-edits_{id}.yaml
   /order-edits/{id}/request:
     $ref: paths/order-edits_{id}_request.yaml
-  /payment-collections/{id}:
-    $ref: paths/payment-collections_{id}.yaml
-  /payment-collections/{id}/authorize:
-    $ref: paths/payment-collections_{id}_authorize.yaml
   /orders/{id}/shipping-methods:
     $ref: paths/orders_{id}_shipping-methods.yaml
   /orders/{id}/archive:
@@ -341,6 +337,10 @@ paths:
     $ref: paths/orders_{id}_return.yaml
   /order/{id}/claims/{claim_id}:
     $ref: paths/order_{id}_claims_{claim_id}.yaml
+  /payment-collections/{id}:
+    $ref: paths/payment-collections_{id}.yaml
+  /payment-collections/{id}/authorize:
+    $ref: paths/payment-collections_{id}_authorize.yaml
   /payments/{id}/capture:
     $ref: paths/payments_{id}_capture.yaml
   /payments/{id}:
@@ -359,6 +359,12 @@ paths:
     $ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml
   /price-lists/{id}/products:
     $ref: paths/price-lists_{id}_products.yaml
+  /product-categories/{id}/products/batch:
+    $ref: paths/product-categories_{id}_products_batch.yaml
+  /product-categories:
+    $ref: paths/product-categories.yaml
+  /product-categories/{id}:
+    $ref: paths/product-categories_{id}.yaml
   /product-tags:
     $ref: paths/product-tags.yaml
   /product-types:
@@ -381,12 +387,6 @@ paths:
     $ref: paths/products_types.yaml
   /products/{id}/metadata:
     $ref: paths/products_{id}_metadata.yaml
-  /product-categories/{id}/products/batch:
-    $ref: paths/product-categories_{id}_products_batch.yaml
-  /product-categories:
-    $ref: paths/product-categories.yaml
-  /product-categories/{id}:
-    $ref: paths/product-categories_{id}.yaml
   /publishable-api-keys/{id}/sales-channels/batch:
     $ref: paths/publishable-api-keys_{id}_sales-channels_batch.yaml
   /publishable-api-keys:
@@ -425,6 +425,12 @@ paths:
     $ref: paths/return-reasons.yaml
   /return-reasons/{id}:
     $ref: paths/return-reasons_{id}.yaml
+  /returns/{id}/cancel:
+    $ref: paths/returns_{id}_cancel.yaml
+  /returns:
+    $ref: paths/returns.yaml
+  /returns/{id}/receive:
+    $ref: paths/returns_{id}_receive.yaml
   /sales-channels/{id}/products/batch:
     $ref: paths/sales-channels_{id}_products_batch.yaml
   /sales-channels/{id}/stock-locations:
@@ -433,12 +439,6 @@ paths:
     $ref: paths/sales-channels.yaml
   /sales-channels/{id}:
     $ref: paths/sales-channels_{id}.yaml
-  /returns/{id}/cancel:
-    $ref: paths/returns_{id}_cancel.yaml
-  /returns:
-    $ref: paths/returns.yaml
-  /returns/{id}/receive:
-    $ref: paths/returns_{id}_receive.yaml
   /shipping-options:
     $ref: paths/shipping-options.yaml
   /shipping-options/{id}:
@@ -451,6 +451,14 @@ paths:
     $ref: paths/stock-locations.yaml
   /stock-locations/{id}:
     $ref: paths/stock-locations_{id}.yaml
+  /store/currencies/{code}:
+    $ref: paths/store_currencies_{code}.yaml
+  /store:
+    $ref: paths/store.yaml
+  /store/payment-providers:
+    $ref: paths/store_payment-providers.yaml
+  /store/tax-providers:
+    $ref: paths/store_tax-providers.yaml
   /swaps/{id}:
     $ref: paths/swaps_{id}.yaml
   /swaps:
@@ -465,14 +473,6 @@ paths:
     $ref: paths/tax-rates.yaml
   /tax-rates/{id}:
     $ref: paths/tax-rates_{id}.yaml
-  /store/currencies/{code}:
-    $ref: paths/store_currencies_{code}.yaml
-  /store:
-    $ref: paths/store.yaml
-  /store/payment-providers:
-    $ref: paths/store_payment-providers.yaml
-  /store/tax-providers:
-    $ref: paths/store_tax-providers.yaml
   /uploads/protected:
     $ref: paths/uploads_protected.yaml
   /uploads:

docs/api/admin/paths/order_{id}_claims.yaml

@@ -10,6 +10,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -17,6 +27,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderClaimsReq.yaml
   x-codegen:
     method: createClaim
+    params: AdminPostOrdersOrderClaimsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml

@@ -16,6 +16,16 @@ post:
       description: The ID of the Claim.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -23,6 +33,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml
   x-codegen:
     method: updateClaim
+    params: AdminPostOrdersOrderClaimsClaimParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/order_{id}_swaps.yaml

@@ -12,6 +12,20 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: >-
+        (Comma separated) Which fields should be expanded the order of the
+        result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: >-
+        (Comma separated) Which fields should be included the order of the
+        result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -19,6 +33,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderSwapsReq.yaml
   x-codegen:
     method: createSwap
+    queryParams: AdminPostOrdersOrderSwapsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}.yaml

@@ -68,6 +68,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -75,6 +85,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderReq.yaml
   x-codegen:
     method: update
+    params: AdminPostOrdersOrderParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_archive.yaml

@@ -10,8 +10,19 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: archive
+    params: AdminPostOrdersOrderArchiveParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_cancel.yaml

@@ -13,8 +13,19 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: cancel
+    params: AdminPostOrdersOrderCancel
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_capture.yaml

@@ -10,8 +10,19 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: capturePayment
+    params: AdminPostOrdersOrderCaptureParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml

@@ -16,8 +16,19 @@ post:
       description: The ID of the Claim.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: cancelClaim
+    params: AdminPostOrdersClaimCancel
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml

@@ -16,6 +16,16 @@ post:
       description: The ID of the Claim.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -24,6 +34,7 @@ post:
             ../components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml
   x-codegen:
     method: fulfillClaim
+    params: AdminPostOrdersOrderClaimsClaimFulfillmentsReq
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -22,8 +22,19 @@ post:
       description: The ID of the Fulfillment.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: cancelClaimFulfillment
+    params: AdminPostOrdersClaimFulfillmentsCancelParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml

@@ -16,6 +16,16 @@ post:
       description: The ID of the Claim.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -24,6 +34,7 @@ post:
             ../components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml
   x-codegen:
     method: createClaimShipment
+    params: AdminPostOrdersOrderClaimsClaimShipmentsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_complete.yaml

@@ -10,8 +10,19 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: complete
+    params: AdminPostOrdersOrderCompleteParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_fulfillment.yaml

@@ -12,6 +12,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -19,6 +29,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml
   x-codegen:
     method: createFulfillment
+    params: AdminPostOrdersOrderFulfillmentsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -16,8 +16,19 @@ post:
       description: The ID of the Fulfillment
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: cancelFulfillment
+    params: AdminPostOrdersOrderFulfillementsCancelParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_refund.yaml

@@ -10,6 +10,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -17,6 +27,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderRefundsReq.yaml
   x-codegen:
     method: refundPayment
+    params: AdminPostOrdersOrderRefundsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_return.yaml

@@ -12,6 +12,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -19,6 +29,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderReturnsReq.yaml
   x-codegen:
     method: requestReturn
+    params: AdminPostOrdersOrderReturnsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_shipment.yaml

@@ -10,6 +10,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -17,6 +27,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderShipmentReq.yaml
   x-codegen:
     method: createShipment
+    params: AdminPostOrdersOrderShipmentParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_shipping-methods.yaml

@@ -11,6 +11,16 @@ post:
       description: The ID of the Order.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -19,6 +29,7 @@ post:
   x-authenticated: true
   x-codegen:
     method: addShippingMethod
+    params: AdminPostOrdersOrderShippingMethodsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml

@@ -16,8 +16,19 @@ post:
       description: The ID of the Swap.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: cancelSwap
+    params: AdminPostOrdersSwapCancelParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml

@@ -16,6 +16,16 @@ post:
       description: The ID of the Swap.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -24,6 +34,7 @@ post:
             ../components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml
   x-codegen:
     method: fulfillSwap
+    params: AdminPostOrdersOrderSwapsSwapFulfillmentsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -22,8 +22,19 @@ post:
       description: The ID of the Fulfillment.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: cancelSwapFulfillment
+    params: AdminPostOrdersSwapFulfillementsCancelParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml

@@ -19,8 +19,19 @@ post:
       description: The ID of the Swap.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   x-codegen:
     method: processSwapPayment
+    params: AdminPostOrdersOrderSwapsSwapProcessPaymentParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml

@@ -16,6 +16,16 @@ post:
       description: The ID of the Swap.
       schema:
         type: string
+    - in: query
+      name: expand
+      description: Comma separated list of relations to include in the result.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Comma separated list of fields to include in the result.
+      schema:
+        type: string
   requestBody:
     content:
       application/json:
@@ -23,6 +33,7 @@ post:
           $ref: ../components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml
   x-codegen:
     method: createSwapShipment
+    params: AdminPostOrdersOrderSwapsSwapShipmentsParams
   x-codeSamples:
     - lang: JavaScript
       label: JS Client