chore(docs): Updated API Reference (automated) (#10258)

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

Co-authored-by: Oli Juhl <[email protected]>
Co-authored-by: Shahed Nasser <[email protected]>

packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml

@@ -131,6 +131,12 @@ decorators:
         - AdminPaymentCollection
       StoreProductVariant:
         - StoreProduct
+      BaseCollection:
+        - BaseProduct
+      BaseProductCategory:
+        - AdminProduct
+      Return:
+        - OrderExchange
 theme:
   openapi:
     theme:

www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_transfer/post.sh

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/orders/{id}/transfer' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "customer_id": "cus_123"
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_transfer_cancel/post.sh

@@ -0,0 +1,2 @@
+curl -X POST '{backend_url}/admin/orders/{id}/transfer/cancel' \
+-H 'Authorization: Bearer {access_token}'

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

@@ -11,7 +11,7 @@ properties:
     type: array
     description: The products to update.
     items:
-      $ref: ./AdminUpdateProduct.yaml
+      $ref: ./AdminBatchUpdateProduct.yaml
   delete:
     type: array
     description: The products to delete.

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

@@ -0,0 +1,159 @@
+type: object
+description: The product's details.
+x-schemaName: AdminBatchUpdateProduct
+properties:
+  title:
+    type: string
+    title: title
+    description: The product's title.
+  subtitle:
+    type: string
+    title: subtitle
+    description: The product's subtitle.
+  description:
+    type: string
+    title: description
+    description: The product's description.
+  is_giftcard:
+    type: boolean
+    title: is_giftcard
+    description: Whether the product is a gift card.
+  discountable:
+    type: boolean
+    title: discountable
+    description: Whether discounts can be applied on the product.
+  images:
+    type: array
+    description: The product's images.
+    items:
+      type: object
+      description: The image's details.
+      required:
+        - url
+      properties:
+        url:
+          type: string
+          title: url
+          description: The image's URL.
+  thumbnail:
+    type: string
+    title: thumbnail
+    description: The product's thumbnail URL.
+  handle:
+    type: string
+    title: handle
+    description: The product's unique handle.
+  status:
+    type: string
+    description: The product's status.
+    enum:
+      - draft
+      - proposed
+      - published
+      - rejected
+  type_id:
+    type: string
+    title: type_id
+    description: The ID of the product's type.
+  collection_id:
+    type: string
+    title: collection_id
+    description: The ID of the product's collection.
+  categories:
+    type: array
+    description: The product's categories.
+    items:
+      type: object
+      description: The product's category.
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          title: id
+          description: The category's ID.
+  tags:
+    type: array
+    description: The product's tags.
+    items:
+      type: object
+      description: The product's tag.
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          title: id
+          description: The tag's ID.
+  options:
+    type: array
+    description: The product's options.
+    items:
+      $ref: ./AdminUpdateProductOption.yaml
+  variants:
+    type: array
+    description: >-
+      The product's variants. You can add new variants or update existing ones,
+      passing their IDs in the object.
+    items:
+      oneOf:
+        - $ref: ./AdminCreateProductVariant.yaml
+        - $ref: ./AdminUpdateProductVariant.yaml
+  sales_channels:
+    type: array
+    description: The sales channels that the product is available in.
+    items:
+      type: object
+      description: The sales channel's details.
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          title: id
+          description: The sales channel's ID.
+  weight:
+    type: number
+    title: weight
+    description: The product's weight.
+  length:
+    type: number
+    title: length
+    description: The product's length.
+  height:
+    type: number
+    title: height
+    description: The product's height.
+  width:
+    type: number
+    title: width
+    description: The product's width.
+  hs_code:
+    type: string
+    title: hs_code
+    description: The product's HS code.
+  mid_code:
+    type: string
+    title: mid_code
+    description: The product's MID code.
+  origin_country:
+    type: string
+    title: origin_country
+    description: The product's origin country.
+  material:
+    type: string
+    title: material
+    description: The product's material.
+  metadata:
+    type: object
+    description: The product's metadata, can hold custom key-value pairs.
+  external_id:
+    type: string
+    title: external_id
+    description: The ID of the product in an external or third-party system.
+  id:
+    type: string
+    title: id
+    description: The product's ID.
+required:
+  - id

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

@@ -28,6 +28,11 @@ properties:
   metadata:
     type: object
     description: The image's metadata, can hold custom key-value pairs.
+  rank:
+    type: number
+    title: rank
+    description: The image's rank among sibling images.
 required:
   - id
   - url
+  - rank

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

@@ -0,0 +1,20 @@
+type: object
+description: The details of the request to transfer the order.
+x-schemaName: AdminTransferOrder
+required:
+  - customer_id
+properties:
+  customer_id:
+    type: string
+    title: customer_id
+    description: The ID of the customer to transfer the order to.
+  description:
+    type: string
+    title: description
+    description: >-
+      The description of the order transfer, which can be shown to the customer
+      receiving the order transfer request.
+  internal_note:
+    type: string
+    title: internal_note
+    description: An internal note viewable only by admin users.

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

@@ -56,6 +56,60 @@ properties:
   calculated_price:
     type: object
     description: The calculated price's details.
+    properties:
+      id:
+        type: string
+        title: id
+        description: The ID of the price.
+      price_list_id:
+        type: string
+        title: price_list_id
+        description: The ID of the associated price list.
+      price_list_type:
+        type: string
+        title: price_list_type
+        description: The price list's type. For example, sale.
+      min_quantity:
+        type: number
+        title: min_quantity
+        description: The minimum quantity required in the cart for this price to apply.
+      max_quantity:
+        type: number
+        title: max_quantity
+        description: The maximum quantity allowed in the cart for this price to apply.
+    required:
+      - id
+      - price_list_id
+      - price_list_type
+      - min_quantity
+      - max_quantity
   original_price:
     type: object
     description: The original price's details.
+    properties:
+      id:
+        type: string
+        title: id
+        description: The ID of the price.
+      price_list_id:
+        type: string
+        title: price_list_id
+        description: The ID of the associated price list.
+      price_list_type:
+        type: string
+        title: price_list_type
+        description: The price list's type. For example, sale.
+      min_quantity:
+        type: number
+        title: min_quantity
+        description: The minimum quantity required in the cart for this price to apply.
+      max_quantity:
+        type: number
+        title: max_quantity
+        description: The maximum quantity allowed in the cart for this price to apply.
+    required:
+      - id
+      - price_list_id
+      - price_list_type
+      - min_quantity
+      - max_quantity

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

@@ -53,7 +53,7 @@ properties:
       services.
     externalDocs:
       url: >-
-        https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property
+        https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
   metadata:
     type: object
     description: The shipping method's metadata, can hold custom key-value pairs.
@@ -78,38 +78,38 @@ properties:
     title: updated_at
     description: The date the shipping method was updated.
   original_total:
-    type: string
+    type: number
     title: original_total
     description: The shipping method's total including taxes, excluding promotions.
   original_subtotal:
-    type: string
+    type: number
     title: original_subtotal
     description: The shipping method's total excluding taxes, including promotions.
   original_tax_total:
-    type: string
+    type: number
     title: original_tax_total
     description: >-
       The total taxes applied on the shipping method's amount including
       promotions.
   total:
-    type: string
+    type: number
     title: total
     description: The shipping method's total amount including taxes and promotions.
   subtotal:
-    type: string
+    type: number
     title: subtotal
     description: The shipping method's total amount excluding taxes, including promotions.
   tax_total:
-    type: string
+    type: number
     title: tax_total
     description: >-
       The total taxes applied on the shipping method's amount including
       promotions.
   discount_total:
-    type: string
+    type: number
     title: discount_total
     description: The total amount discounted.
   discount_tax_total:
-    type: string
-    title: discount_total
+    type: number
+    title: discount_tax_total
     description: The taxes applied on the discounted amount.

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

@@ -1,6 +1,14 @@
 type: object
 description: The adjustment's details.
 x-schemaName: BaseLineItemAdjustment
+required:
+  - item
+  - item_id
+  - id
+  - amount
+  - cart_id
+  - created_at
+  - updated_at
 properties:
   item:
     type: object
@@ -46,11 +54,3 @@ properties:
     format: date-time
     title: updated_at
     description: The date the adjustment was updated.
-required:
-  - item
-  - item_id
-  - id
-  - amount
-  - cart_id
-  - created_at
-  - updated_at