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

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

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

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

@@ -3,9 +3,9 @@ description: The filfillment's details.
 x-schemaName: AdminCreateFulfillment
 required:
   - data
-  - order_id
-  - metadata
   - items
+  - metadata
+  - order_id
   - location_id
   - provider_id
   - delivery_address

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

@@ -3,6 +3,7 @@ description: The product's details.
 x-schemaName: AdminCreateProduct
 required:
   - title
+  - options
 properties:
   title:
     type: string

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

@@ -2,19 +2,87 @@ type: object
 description: The shipping option's details.
 x-schemaName: AdminCreateShippingOption
 required:
-  - label
-  - description
-  - code
+  - name
+  - service_zone_id
+  - shipping_profile_id
+  - price_type
+  - provider_id
+  - type
+  - prices
 properties:
-  label:
+  name:
     type: string
-    title: label
-    description: The type's label.
-  description:
+    title: name
+    description: The shipping option's name.
+  service_zone_id:
     type: string
-    title: description
-    description: The type's description.
-  code:
+    title: service_zone_id
+    description: The ID of the associated service zone.
+  shipping_profile_id:
     type: string
-    title: code
-    description: The type's code.
+    title: shipping_profile_id
+    description: The ID of the associated shipping profile.
+  data:
+    type: object
+    description: >-
+      The shipping option's data, useful for the fulfillment provider handling
+      its processing.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
+  price_type:
+    type: string
+    description: >-
+      The shipping option's price type. If `flat`, the shipping option has a
+      fixed price set in `prices`. Otherwise, the shipping option's price is
+      calculated by the fulfillment provider.
+    enum:
+      - flat
+      - calculated
+  provider_id:
+    type: string
+    title: provider_id
+    description: The ID of the fulfillment provider handling this shipping option.
+  type:
+    $ref: ./AdminCreateShippingOptionType.yaml
+  prices:
+    type: array
+    description: The shipping option's prices.
+    items:
+      oneOf:
+        - type: object
+          description: The price's details.
+          x-schemaName: AdminCreateShippingOptionPriceWithCurrency
+          required:
+            - currency_code
+            - amount
+          properties:
+            currency_code:
+              type: string
+              title: currency_code
+              description: The price's currency code.
+              example: usd
+            amount:
+              type: number
+              title: amount
+              description: The price's amount.
+        - type: object
+          description: The price's details.
+          x-schemaName: AdminCreateShippingOptionPriceWithRegion
+          required:
+            - region_id
+            - amount
+          properties:
+            region_id:
+              type: string
+              title: region_id
+              description: The ID of the region this price is used in.
+            amount:
+              type: number
+              title: amount
+              description: The price's amount.
+  rules:
+    type: array
+    description: The shipping option's rules.
+    items:
+      $ref: ./AdminCreateShippingOptionRule.yaml

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

@@ -0,0 +1,20 @@
+type: object
+description: The shipping option type's details.
+x-schemaName: AdminCreateShippingOptionType
+required:
+  - label
+  - description
+  - code
+properties:
+  label:
+    type: string
+    title: label
+    description: The type's label.
+  description:
+    type: string
+    title: description
+    description: The type's description.
+  code:
+    type: string
+    title: code
+    description: The type's code.

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

@@ -95,7 +95,7 @@ properties:
     title: deleted_at
     description: The date the exchange was deleted.
   order:
-    $ref: ./AdminOrder.yaml
+    $ref: ./BaseOrder.yaml
   allow_backorder:
     type: boolean
     title: allow_backorder

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

@@ -6,7 +6,6 @@ required:
   - exchange
 properties:
   order:
-    description: The details of the associated order.
     $ref: ./Order.yaml
   exchange:
     $ref: ./AdminExchange.yaml

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

@@ -7,16 +7,16 @@ required:
   - shipping_methods
   - currency_code
   - id
-  - created_at
-  - updated_at
-  - email
   - version
   - region_id
   - customer_id
   - sales_channel_id
+  - email
   - payment_status
   - fulfillment_status
   - summary
+  - created_at
+  - updated_at
   - original_item_total
   - original_item_subtotal
   - original_item_tax_total

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

@@ -8,12 +8,12 @@ required:
   - exchange
   - actions
   - status
-  - order_id
-  - metadata
   - id
+  - version
+  - metadata
   - created_at
   - updated_at
-  - version
+  - order_id
   - canceled_at
   - return_id
   - exchange_id
@@ -62,11 +62,7 @@ properties:
     title: claim_id
     description: The ID of the associated claim.
   order:
-    type: string
-    title: order
-    description: The order change's order.
-    externalDocs:
-      url: '#pagination'
+    $ref: ./AdminOrder.yaml
   return_order:
     $ref: ./AdminReturn.yaml
   exchange:

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

@@ -4,11 +4,11 @@ x-schemaName: AdminOrderChangeAction
 required:
   - order_change
   - order
-  - order_id
-  - internal_note
   - id
   - created_at
   - updated_at
+  - order_id
+  - internal_note
   - return_id
   - exchange_id
   - claim_id
@@ -45,11 +45,7 @@ properties:
     title: exchange_id
     description: The ID of the associated exchange.
   order:
-    type: string
-    title: order
-    description: The order change's order.
-    externalDocs:
-      url: '#pagination'
+    $ref: ./AdminOrder.yaml
   reference:
     type: string
     title: reference

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

@@ -0,0 +1,45 @@
+type: object
+description: The order item's details.
+x-schemaName: AdminOrderItem
+required:
+  - order_id
+  - item_id
+  - version
+  - history
+  - item
+properties:
+  order_id:
+    type: string
+    title: order_id
+    description: The ID of the order this item belongs to.
+  item_id:
+    type: string
+    title: item_id
+    description: The ID of the associated line item.
+  version:
+    type: number
+    title: version
+    description: The order item's version.
+  history:
+    type: object
+    description: The order item's history.
+    required:
+      - version
+    properties:
+      version:
+        type: object
+        description: The version changes of the item.
+        required:
+          - from
+          - to
+        properties:
+          from:
+            type: number
+            title: from
+            description: The original version.
+          to:
+            type: number
+            title: to
+            description: The new version.
+  item:
+    $ref: ./AdminOrderLineItem.yaml

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

@@ -3,10 +3,8 @@ description: The item's details.
 x-schemaName: AdminOrderLineItem
 required:
   - title
-  - metadata
   - id
-  - subtitle
-  - thumbnail
+  - metadata
   - created_at
   - updated_at
   - item_total
@@ -20,6 +18,8 @@ required:
   - tax_total
   - discount_total
   - discount_tax_total
+  - subtitle
+  - thumbnail
   - variant_id
   - product_id
   - product_title

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

@@ -8,17 +8,17 @@ required:
   - order_change
   - currency_code
   - id
-  - created_at
-  - updated_at
-  - email
   - version
   - region_id
   - customer_id
   - sales_channel_id
+  - email
   - payment_collections
   - payment_status
   - fulfillment_status
   - summary
+  - created_at
+  - updated_at
   - original_item_total
   - original_item_subtotal
   - original_item_tax_total

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

@@ -37,3 +37,7 @@ properties:
         metadata:
           type: object
           description: The item's metadata, can hold custom key-value pairs.
+        compare_at_unit_price:
+          type: number
+          title: compare_at_unit_price
+          description: The original price of the item before a promotion or sale.

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

@@ -14,3 +14,7 @@ properties:
     type: number
     title: unit_price
     description: The item's unit price.
+  compare_at_unit_price:
+    type: number
+    title: compare_at_unit_price
+    description: The original price of the item before a promotion or sale.

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

@@ -16,3 +16,7 @@ properties:
     type: number
     title: unit_price
     description: The item's unit price.
+  compare_at_unit_price:
+    type: number
+    title: compare_at_unit_price
+    description: The original price of the item before a promotion or sale.

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

@@ -11,10 +11,12 @@ required:
   - status
   - description
   - id
-  - handle
+  - created_at
+  - updated_at
   - subtitle
-  - is_giftcard
   - thumbnail
+  - handle
+  - is_giftcard
   - width
   - weight
   - height
@@ -26,8 +28,6 @@ required:
   - type_id
   - discountable
   - external_id
-  - created_at
-  - updated_at
   - deleted_at
 properties:
   collection:

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

@@ -0,0 +1,11 @@
+type: object
+description: The details to update in a tax region.
+x-schemaName: AdminUpdateTaxRegion
+properties:
+  province_code:
+    type: string
+    title: province_code
+    description: The tax region's province code.
+  metadata:
+    type: object
+    description: The tax region's metadata, can hold custom key-value pairs.

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

@@ -56,60 +56,6 @@ properties:
   calculated_price:
     type: object
     description: The calculated price's details.
-    properties:
-      id:
-        type: string
-        title: id
-        description: The calculated price's ID.
-      price_list_id:
-        type: string
-        title: price_list_id
-        description: The ID of the price list that the price belongs to.
-      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 required 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 original price's ID.
-      price_list_id:
-        type: string
-        title: price_list_id
-        description: The ID of the price list that the price belongs to.
-      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 required 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/BaseCollection.yaml

@@ -1,3 +1,47 @@
 type: object
-description: The collection's details.
+description: The product collection's details.
 x-schemaName: BaseCollection
+required:
+  - id
+  - title
+  - handle
+  - created_at
+  - updated_at
+  - deleted_at
+  - metadata
+properties:
+  id:
+    type: string
+    title: id
+    description: The collection's ID.
+  title:
+    type: string
+    title: title
+    description: The collection's title.
+  handle:
+    type: string
+    title: handle
+    description: The collection's handle.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The collection's creation date.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The collection's update date.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The collection's deletion date.
+  products:
+    type: array
+    description: The collection's products.
+    items:
+      $ref: ./AdminProduct.yaml
+  metadata:
+    type: object
+    description: The collection's metadata, used to store custom key-value pairs.

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

@@ -2,7 +2,6 @@ type: object
 description: The order's details.
 x-schemaName: BaseOrder
 required:
-  - payment_collections
   - id
   - version
   - region_id
@@ -15,7 +14,6 @@ required:
   - payment_status
   - fulfillment_status
   - summary
-  - metadata
   - created_at
   - updated_at
   - original_item_total
@@ -45,20 +43,16 @@ properties:
     type: array
     description: The order's payment collections.
     items:
-      $ref: ./AdminPaymentCollection.yaml
+      $ref: ./BasePaymentCollection.yaml
   fulfillments:
     type: array
     description: The order's fulfillments.
     items:
       $ref: ./BaseOrderFulfillment.yaml
-  sales_channel:
-    $ref: ./AdminSalesChannel.yaml
-  customer:
-    $ref: ./AdminCustomer.yaml
   shipping_address:
-    $ref: ./AdminOrderAddress.yaml
+    $ref: ./BaseOrderAddress.yaml
   billing_address:
-    $ref: ./AdminOrderAddress.yaml
+    $ref: ./BaseOrderAddress.yaml
   id:
     type: string
     title: id

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

@@ -1,5 +1,5 @@
 type: object
-description: An order address
+description: An order address.
 x-schemaName: BaseOrderAddress
 required:
   - id
@@ -48,8 +48,6 @@ properties:
     title: country_code
     description: The address's country code.
     example: us
-  country:
-    $ref: ./AdminRegionCountry.yaml
   province:
     type: string
     title: province

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

@@ -1,5 +1,5 @@
 type: object
-description: The fulfillment's fulfillments.
+description: The fulfillment's details.
 x-schemaName: BaseOrderFulfillment
 required:
   - id
@@ -8,6 +8,7 @@ required:
   - shipped_at
   - delivered_at
   - canceled_at
+  - requires_shipping
   - data
   - provider_id
   - shipping_option_id
@@ -72,3 +73,7 @@ properties:
     format: date-time
     title: updated_at
     description: The date the fulfillment was updated.
+  requires_shipping:
+    type: boolean
+    title: requires_shipping
+    description: Whether the fulfillment requires shipping.

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

@@ -1,5 +1,5 @@
 type: object
-description: The payment provider's payment providers.
+description: The payment provider's details.
 x-schemaName: BasePaymentProvider
 required:
   - id

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

@@ -1,3 +1,84 @@
 type: object
-description: The category's categories.
+description: The product category's details.
 x-schemaName: BaseProductCategory
+required:
+  - id
+  - name
+  - description
+  - handle
+  - is_active
+  - is_internal
+  - rank
+  - parent_category_id
+  - parent_category
+  - category_children
+  - created_at
+  - updated_at
+  - deleted_at
+properties:
+  category_children:
+    type: array
+    description: The category's children.
+    items:
+      type: object
+  parent_category:
+    type: object
+  products:
+    type: array
+    description: The category's products.
+    items:
+      type: object
+  name:
+    type: string
+    title: name
+    description: The category's name.
+  description:
+    type: string
+    title: description
+    description: The category's description.
+  id:
+    type: string
+    title: id
+    description: The category's ID.
+  metadata:
+    type: object
+    description: The category's metadata, can hold custom key-value pairs.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the category was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the category was updated.
+  handle:
+    type: string
+    title: handle
+    description: The category's unique handle.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The date the category was deleted.
+  is_active:
+    type: boolean
+    title: is_active
+    description: >-
+      Whether the category is active. If disabled, the category isn't shown in
+      the storefront.
+  is_internal:
+    type: boolean
+    title: is_internal
+    description: >-
+      Whether the category is internal. If enabled, the category is only seen by
+      admin users.
+  rank:
+    type: number
+    title: rank
+    description: The category's rank among sibling categories.
+  parent_category_id:
+    type: string
+    title: parent_category_id
+    description: The ID of the category's parent.

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

@@ -1,44 +1,44 @@
 type: object
 description: The product option's details.
 x-schemaName: BaseProductOption
+required:
+  - id
+  - title
 properties:
   id:
     type: string
     title: id
-    description: The option's ID.
+    description: The product option's ID.
   title:
     type: string
     title: title
-    description: The option's title.
+    description: The product option's title.
   product:
     type: object
   product_id:
     type: string
     title: product_id
-    description: The option's product id.
+    description: The ID of the product this option belongs to.
   values:
     type: array
-    description: The option's values.
+    description: The product option's values.
     items:
       $ref: ./BaseProductOptionValue.yaml
   metadata:
     type: object
-    description: The option's metadata.
+    description: The product option's metadata, can hold custom key-value pairs.
   created_at:
     type: string
     format: date-time
     title: created_at
-    description: The option's created at.
+    description: The date the product option was created.
   updated_at:
     type: string
     format: date-time
     title: updated_at
-    description: The option's updated at.
+    description: The date the product option was updated.
   deleted_at:
     type: string
     format: date-time
     title: deleted_at
-    description: The option's deleted at.
-required:
-  - id
-  - title
+    description: The date the product option was deleted.

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

@@ -1,3 +1,35 @@
 type: object
-description: The tag's tags.
+description: The product tag's details.
 x-schemaName: BaseProductTag
+required:
+  - id
+  - value
+  - created_at
+  - updated_at
+properties:
+  id:
+    type: string
+    title: id
+    description: The tag's ID.
+  value:
+    type: string
+    title: value
+    description: The tag's value.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the tag was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the tag was updated.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The date the tag was deleted.
+  metadata:
+    type: object
+    description: The tag's metadata, can hold custom key-value pairs.

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

@@ -31,28 +31,6 @@ required:
   - original_shipping_total
   - original_shipping_subtotal
   - original_shipping_tax_total
-  - raw_original_item_total
-  - raw_original_item_subtotal
-  - raw_original_item_tax_total
-  - raw_item_total
-  - raw_item_subtotal
-  - raw_item_tax_total
-  - raw_original_total
-  - raw_original_subtotal
-  - raw_original_tax_total
-  - raw_total
-  - raw_subtotal
-  - raw_tax_total
-  - raw_discount_total
-  - raw_discount_tax_total
-  - raw_gift_card_total
-  - raw_gift_card_tax_total
-  - raw_shipping_total
-  - raw_shipping_subtotal
-  - raw_shipping_tax_total
-  - raw_original_shipping_total
-  - raw_original_shipping_subtotal
-  - raw_original_shipping_tax_total
 properties:
   id:
     type: string
@@ -228,69 +206,3 @@ properties:
     type: number
     title: original_shipping_tax_total
     description: The total taxes of the order's shipping excluding promotions.
-  raw_original_item_total:
-    type: object
-    description: The order's raw original item total.
-  raw_original_item_subtotal:
-    type: object
-    description: The order's raw original item subtotal.
-  raw_original_item_tax_total:
-    type: object
-    description: The order's raw original item tax total.
-  raw_item_total:
-    type: object
-    description: The order's raw item total.
-  raw_item_subtotal:
-    type: object
-    description: The order's raw item subtotal.
-  raw_item_tax_total:
-    type: object
-    description: The order's raw item tax total.
-  raw_original_total:
-    type: object
-    description: The order's raw original total.
-  raw_original_subtotal:
-    type: object
-    description: The order's raw original subtotal.
-  raw_original_tax_total:
-    type: object
-    description: The order's raw original tax total.
-  raw_total:
-    type: object
-    description: The order's raw total.
-  raw_subtotal:
-    type: object
-    description: The order's raw subtotal.
-  raw_tax_total:
-    type: object
-    description: The order's raw tax total.
-  raw_discount_total:
-    type: object
-    description: The order's raw discount total.
-  raw_discount_tax_total:
-    type: object
-    description: The order's raw discount tax total.
-  raw_gift_card_total:
-    type: object
-    description: The order's raw gift card total.
-  raw_gift_card_tax_total:
-    type: object
-    description: The order's raw gift card tax total.
-  raw_shipping_total:
-    type: object
-    description: The order's raw shipping total.
-  raw_shipping_subtotal:
-    type: object
-    description: The order's raw shipping subtotal.
-  raw_shipping_tax_total:
-    type: object
-    description: The order's raw shipping tax total.
-  raw_original_shipping_total:
-    type: object
-    description: The order's raw original shipping total.
-  raw_original_shipping_subtotal:
-    type: object
-    description: The order's raw original shipping subtotal.
-  raw_original_shipping_tax_total:
-    type: object
-    description: The order's raw original shipping tax total.

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

@@ -2,44 +2,14 @@ type: object
 description: The order change's claim.
 x-schemaName: OrderClaim
 required:
+  - id
+  - type
   - order_id
+  - order_version
+  - display_id
   - claim_items
   - additional_items
-  - currency_code
-  - id
-  - region_id
-  - customer_id
-  - sales_channel_id
-  - email
-  - shipping_methods
-  - payment_status
-  - fulfillment_status
-  - summary
   - metadata
-  - created_at
-  - updated_at
-  - original_item_total
-  - original_item_subtotal
-  - original_item_tax_total
-  - item_total
-  - item_subtotal
-  - item_tax_total
-  - original_total
-  - original_subtotal
-  - original_tax_total
-  - total
-  - subtotal
-  - tax_total
-  - discount_total
-  - discount_tax_total
-  - gift_card_total
-  - gift_card_tax_total
-  - shipping_total
-  - shipping_subtotal
-  - shipping_tax_total
-  - original_shipping_total
-  - original_shipping_subtotal
-  - original_shipping_tax_total
 properties:
   id:
     type: string
@@ -70,79 +40,29 @@ properties:
     title: no_notification
     description: Whether the customer should be notified about changes in the claim.
   refund_amount:
-    type: number
-    title: refund_amount
+    oneOf:
+      - type: string
+        title: refund_amount
+        description: The claim's refund amount.
+      - type: number
+        title: refund_amount
+        description: The claim's refund amount.
+      - type: string
+        title: refund_amount
+        description: The claim's refund amount.
+      - type: number
+        title: refund_amount
+        description: The claim's refund amount.
     description: The amount to be refunded.
-  currency_code:
-    type: string
-    title: currency_code
-    description: The claim's currency code.
-  region_id:
-    type: string
-    title: region_id
-    description: The ID of the region associated with the claim.
-  customer_id:
-    type: string
-    title: customer_id
-    description: The ID of the customer associated with the claim's order.
-  sales_channel_id:
-    type: string
-    title: sales_channel_id
-    description: The ID of the sales channel the claim's order is created in.
-  email:
-    type: string
-    title: email
-    description: The email associated with the claim's order.
-    format: email
   display_id:
     type: number
     title: display_id
     description: The claim's display ID.
-  shipping_address:
-    $ref: ./BaseOrderAddress.yaml
-  billing_address:
-    $ref: ./BaseOrderAddress.yaml
   shipping_methods:
     type: array
     description: The claim's shipping methods.
     items:
-      $ref: ./BaseOrderShippingMethod.yaml
-  payment_collections:
-    type: array
-    description: The claim's payment collections.
-    items:
-      $ref: ./BasePaymentCollection.yaml
-  payment_status:
-    type: string
-    description: The claim's payment status.
-    enum:
-      - canceled
-      - not_paid
-      - awaiting
-      - authorized
-      - partially_authorized
-      - captured
-      - partially_captured
-      - partially_refunded
-      - refunded
-      - requires_action
-  fulfillments:
-    type: array
-    description: The claim's fulfillments.
-    items:
-      $ref: ./BaseOrderFulfillment.yaml
-  fulfillment_status:
-    type: string
-    description: The claim's fulfillment status.
-    enum:
-      - canceled
-      - not_fulfilled
-      - partially_fulfilled
-      - fulfilled
-      - partially_shipped
-      - shipped
-      - partially_delivered
-      - delivered
+      $ref: ./OrderShippingMethod.yaml
   transactions:
     type: array
     description: The claim's transactions.
@@ -151,9 +71,7 @@ properties:
         https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
       description: Learn more about transactions of orders and associated models.
     items:
-      $ref: ./BaseOrderTransaction.yaml
-  summary:
-    $ref: ./BaseOrderSummary.yaml
+      $ref: ./OrderTransaction.yaml
   metadata:
     type: object
     description: The claim's metadata, used to store custom key-value pairs.
@@ -167,91 +85,43 @@ properties:
     format: date-time
     title: updated_at
     description: The claim's update date.
-  original_item_total:
+  type:
+    type: string
+    description: The claim's type.
+    enum:
+      - replace
+      - refund
+  order:
+    $ref: ./Order.yaml
+  order_version:
     type: number
-    title: original_item_total
-    description: The total of the original items in the associated order.
-  original_item_subtotal:
-    type: number
-    title: original_item_subtotal
-    description: The subtotal of the original items in the associated order.
-  original_item_tax_total:
-    type: number
-    title: original_item_tax_total
-    description: The tax total of the original items in the associated order.
-  item_total:
-    type: number
-    title: item_total
-    description: The total of the claim's items.
-  item_subtotal:
-    type: number
-    title: item_subtotal
-    description: The subtotal of the claim's items.
-  item_tax_total:
-    type: number
-    title: item_tax_total
-    description: The tax total of the claim's items.
-  original_total:
-    type: number
-    title: original_total
-    description: The associated order's original total.
-  original_subtotal:
-    type: number
-    title: original_subtotal
-    description: The associated order's original subtotal.
-  original_tax_total:
-    type: number
-    title: original_tax_total
-    description: The associated order's original tax total.
-  total:
-    type: number
-    title: total
-    description: The associated order's total.
-  subtotal:
-    type: number
-    title: subtotal
-    description: The claim's subtotal.
-  tax_total:
-    type: number
-    title: tax_total
-    description: The claim's tax total.
-  discount_total:
-    type: number
-    title: discount_total
-    description: The claim's discount total.
-  discount_tax_total:
-    type: number
-    title: discount_tax_total
-    description: The claim's discount tax total.
-  gift_card_total:
-    type: number
-    title: gift_card_total
-    description: The claim's gift card total.
-  gift_card_tax_total:
-    type: number
-    title: gift_card_tax_total
-    description: The claim's gift card tax total.
-  shipping_total:
-    type: number
-    title: shipping_total
-    description: The claim's shipping total.
-  shipping_subtotal:
-    type: number
-    title: shipping_subtotal
-    description: The claim's shipping subtotal.
-  shipping_tax_total:
-    type: number
-    title: shipping_tax_total
-    description: The claim's shipping tax total.
-  original_shipping_total:
-    type: number
-    title: original_shipping_total
-    description: The associated order's original shipping total.
-  original_shipping_subtotal:
-    type: number
-    title: original_shipping_subtotal
-    description: The associated order's original shipping subtotal.
-  original_shipping_tax_total:
-    type: number
-    title: original_shipping_tax_total
-    description: The associated order's original shipping tax total.
+    title: order_version
+    description: The claim's order version.
+  raw_refund_amount:
+    oneOf:
+      - type: string
+        title: raw_refund_amount
+        description: The claim's raw refund amount.
+      - type: number
+        title: raw_refund_amount
+        description: The claim's raw refund amount.
+      - type: string
+        title: raw_refund_amount
+        description: The claim's raw refund amount.
+      - type: number
+        title: raw_refund_amount
+        description: The claim's raw refund amount.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the claim.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The date the claim was deleted.
+  canceled_at:
+    type: string
+    title: canceled_at
+    description: The date the claim was canceled.
+    format: date-time

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

@@ -2,54 +2,17 @@ type: object
 description: The order change's exchange.
 x-schemaName: OrderExchange
 required:
-  - order_id
-  - return_items
-  - additional_items
-  - currency_code
   - id
-  - region_id
-  - customer_id
-  - sales_channel_id
-  - email
-  - shipping_methods
-  - payment_status
-  - fulfillment_status
-  - summary
+  - order_id
+  - order_version
+  - display_id
+  - additional_items
   - metadata
-  - created_at
-  - updated_at
-  - original_item_total
-  - original_item_subtotal
-  - original_item_tax_total
-  - item_total
-  - item_subtotal
-  - item_tax_total
-  - original_total
-  - original_subtotal
-  - original_tax_total
-  - total
-  - subtotal
-  - tax_total
-  - discount_total
-  - discount_tax_total
-  - gift_card_total
-  - gift_card_tax_total
-  - shipping_total
-  - shipping_subtotal
-  - shipping_tax_total
-  - original_shipping_total
-  - original_shipping_subtotal
-  - original_shipping_tax_total
 properties:
   order_id:
     type: string
     title: order_id
     description: The ID of the order the exchange is created for.
-  return_items:
-    type: array
-    description: The items returned (inbound) by the exchange.
-    items:
-      $ref: ./AdminReturnItem.yaml
   additional_items:
     type: array
     description: The new items (outbound) sent by the exchange.
@@ -67,88 +30,24 @@ properties:
       be refunded. If positive, additional payment is required from the
       customer.
   return:
-    description: the return associated with the exchange.
-    $ref: ./AdminReturn.yaml
+    $ref: ./Return.yaml
   return_id:
     type: string
     title: return_id
     description: The ID of the associated exchange.
-  currency_code:
-    type: string
-    title: currency_code
-    description: The exchange's currency code.
   id:
     type: string
     title: id
     description: The exchange's ID.
-  region_id:
-    type: string
-    title: region_id
-    description: The ID of the associated order's region.
-  customer_id:
-    type: string
-    title: customer_id
-    description: The ID of the customer that placed the order.
-  sales_channel_id:
-    type: string
-    title: sales_channel_id
-    description: The ID of the sales channel the associated order belongs to.
-  email:
-    type: string
-    title: email
-    description: The email used when placing the order.
-    format: email
   display_id:
     type: number
     title: display_id
     description: The exchange's display ID.
-  shipping_address:
-    description: The shipping address to send new items to.
-    $ref: ./BaseOrderAddress.yaml
-  billing_address:
-    description: The customer's billing address.
-    $ref: ./BaseOrderAddress.yaml
   shipping_methods:
     type: array
     description: The shipping methods used to send the new (outbound) items.
     items:
-      $ref: ./BaseOrderShippingMethod.yaml
-  payment_collections:
-    type: array
-    description: The exchange's payment collections.
-    items:
-      $ref: ./BasePaymentCollection.yaml
-  payment_status:
-    type: string
-    description: The exchange's payment status.
-    enum:
-      - canceled
-      - not_paid
-      - awaiting
-      - authorized
-      - partially_authorized
-      - captured
-      - partially_captured
-      - partially_refunded
-      - refunded
-      - requires_action
-  fulfillments:
-    type: array
-    description: The exchange's fulfillments of new (outbound) items.
-    items:
-      $ref: ./BaseOrderFulfillment.yaml
-  fulfillment_status:
-    type: string
-    description: The exchange's fulfillment status.
-    enum:
-      - canceled
-      - not_fulfilled
-      - partially_fulfilled
-      - fulfilled
-      - partially_shipped
-      - shipped
-      - partially_delivered
-      - delivered
+      $ref: ./OrderShippingMethod.yaml
   transactions:
     type: array
     description: The exchange's transactions.
@@ -156,10 +55,7 @@ properties:
       url: >-
         https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
     items:
-      $ref: ./BaseOrderTransaction.yaml
-  summary:
-    description: The totals summary of the exchange.
-    $ref: ./BaseOrderSummary.yaml
+      $ref: ./OrderTransaction.yaml
   metadata:
     type: object
     description: The exchange's metadata, can hold custom key-value pairs.
@@ -173,91 +69,43 @@ properties:
     format: date-time
     title: updated_at
     description: The date that the exchange was updated.
-  original_item_total:
+  order:
+    $ref: ./Order.yaml
+  order_version:
     type: number
-    title: original_item_total
-    description: The total of the original items in the order.
-  original_item_subtotal:
-    type: number
-    title: original_item_subtotal
-    description: The subtotal of the original items in the order.
-  original_item_tax_total:
-    type: number
-    title: original_item_tax_total
-    description: The total tax of the original items in the order.
-  item_total:
-    type: number
-    title: item_total
-    description: The total of the exchange's new items.
-  item_subtotal:
-    type: number
-    title: item_subtotal
-    description: The subtotal of the exchange's new items.
-  item_tax_total:
-    type: number
-    title: item_tax_total
-    description: The tax total of the exchange's new items.
-  original_total:
-    type: number
-    title: original_total
-    description: The total of the order.
-  original_subtotal:
-    type: number
-    title: original_subtotal
-    description: The subtotal of the order.
-  original_tax_total:
-    type: number
-    title: original_tax_total
-    description: The tax total of the order.
-  total:
-    type: number
-    title: total
-    description: The total of the exchange.
-  subtotal:
-    type: number
-    title: subtotal
-    description: The subtotal of the exchange.
-  tax_total:
-    type: number
-    title: tax_total
-    description: The tax total of the exchange.
-  discount_total:
-    type: number
-    title: discount_total
-    description: The discount total of the exchange.
-  discount_tax_total:
-    type: number
-    title: discount_tax_total
-    description: The total taxes on discount of the exchange.
-  gift_card_total:
-    type: number
-    title: gift_card_total
-    description: The gift cards total of the exchange.
-  gift_card_tax_total:
-    type: number
-    title: gift_card_tax_total
-    description: The total taxes on the gift card of the exchange.
-  shipping_total:
-    type: number
-    title: shipping_total
-    description: The exchange's shipping total.
-  shipping_subtotal:
-    type: number
-    title: shipping_subtotal
-    description: The exchange's shipping subtotal.
-  shipping_tax_total:
-    type: number
-    title: shipping_tax_total
-    description: The exchange's shipping tax total.
-  original_shipping_total:
-    type: number
-    title: original_shipping_total
-    description: The order's shipping total.
-  original_shipping_subtotal:
-    type: number
-    title: original_shipping_subtotal
-    description: The order's shipping subtotal.
-  original_shipping_tax_total:
-    type: number
-    title: original_shipping_tax_total
-    description: The order's shipping tax total.
+    title: order_version
+    description: The version of the order when the exchange is applied.
+  raw_difference_due:
+    oneOf:
+      - type: string
+        title: raw_difference_due
+        description: The exchange's raw difference due.
+      - type: number
+        title: raw_difference_due
+        description: The exchange's raw difference due.
+      - type: string
+        title: raw_difference_due
+        description: The exchange's raw difference due.
+      - type: number
+        title: raw_difference_due
+        description: The exchange's raw difference due.
+  allow_backorder:
+    type: boolean
+    title: allow_backorder
+    description: >-
+      Whether variants that are out of stock can be added to the exchange as
+      outbound items.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the exchange.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The date the exchange was deleted.
+  canceled_at:
+    type: string
+    title: canceled_at
+    description: The date the exchange was canceled.
+    format: date-time

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

@@ -6,21 +6,13 @@ required:
   - item_id
   - item
   - quantity
-  - raw_quantity
   - fulfilled_quantity
-  - raw_fulfilled_quantity
   - delivered_quantity
-  - raw_delivered_quantity
   - shipped_quantity
-  - raw_shipped_quantity
   - return_requested_quantity
-  - raw_return_requested_quantity
   - return_received_quantity
-  - raw_return_received_quantity
   - return_dismissed_quantity
-  - raw_return_dismissed_quantity
   - written_off_quantity
-  - raw_written_off_quantity
   - metadata
   - created_at
   - updated_at
@@ -39,58 +31,34 @@ properties:
     type: number
     title: quantity
     description: The item's quantity.
-  raw_quantity:
-    type: object
-    description: The item's raw quantity.
   fulfilled_quantity:
     type: number
     title: fulfilled_quantity
     description: The item's fulfilled quantity.
-  raw_fulfilled_quantity:
-    type: object
-    description: The item's raw fulfilled quantity.
   delivered_quantity:
     type: number
     title: delivered_quantity
     description: The item's delivered quantity.
-  raw_delivered_quantity:
-    type: object
-    description: The item's raw delivered quantity.
   shipped_quantity:
     type: number
     title: shipped_quantity
     description: The item's shipped quantity.
-  raw_shipped_quantity:
-    type: object
-    description: The item's raw shipped quantity.
   return_requested_quantity:
     type: number
     title: return_requested_quantity
     description: The item's quantity that's requested to be returned.
-  raw_return_requested_quantity:
-    type: object
-    description: The item's raw return requested quantity.
   return_received_quantity:
     type: number
     title: return_received_quantity
     description: The item's quantity that's received through a return.
-  raw_return_received_quantity:
-    type: object
-    description: The item's raw return received quantity.
   return_dismissed_quantity:
     type: number
     title: return_dismissed_quantity
     description: The item's quantity that's returned but dismissed because it's damaged.
-  raw_return_dismissed_quantity:
-    type: object
-    description: The item's raw return dismissed quantity.
   written_off_quantity:
     type: number
     title: written_off_quantity
     description: The item's quantity that's removed due to an order change.
-  raw_written_off_quantity:
-    type: object
-    description: The item's raw written off quantity.
   metadata:
     type: object
     description: The item's metadata, can hold custom key-value pairs.

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

@@ -8,9 +8,7 @@ required:
   - is_discountable
   - is_tax_inclusive
   - unit_price
-  - raw_unit_price
   - quantity
-  - raw_quantity
   - detail
   - created_at
   - updated_at
@@ -27,19 +25,6 @@ required:
   - discount_tax_total
   - refundable_total
   - refundable_total_per_unit
-  - raw_original_total
-  - raw_original_subtotal
-  - raw_original_tax_total
-  - raw_item_total
-  - raw_item_subtotal
-  - raw_item_tax_total
-  - raw_total
-  - raw_subtotal
-  - raw_tax_total
-  - raw_discount_total
-  - raw_discount_tax_total
-  - raw_refundable_total
-  - raw_refundable_total_per_unit
 properties:
   id:
     type: string
@@ -122,56 +107,14 @@ properties:
     type: number
     title: compare_at_unit_price
     description: The original price of the item before a promotion or sale.
-  raw_compare_at_unit_price:
-    type: object
-    description: The item's raw compare at unit price.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw compare at unit price's value.
-          - type: number
-            title: value
-            description: The raw compare at unit price's value.
   unit_price:
     type: number
     title: unit_price
     description: The item's price for a single quantity.
-  raw_unit_price:
-    type: object
-    description: The item's raw unit price.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw unit price's value.
-          - type: number
-            title: value
-            description: The raw unit price's value.
   quantity:
     type: number
     title: quantity
     description: The item's quantity.
-  raw_quantity:
-    type: object
-    description: The item's raw quantity.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw quantity's value.
-          - type: number
-            title: value
-            description: The raw quantity's value.
   tax_lines:
     type: array
     description: The item's tax lines.
@@ -251,185 +194,3 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total amount that can be refunded of a single quantity of the item.
-  raw_original_total:
-    type: object
-    description: The item's raw original total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw original total's value.
-          - type: number
-            title: value
-            description: The raw original total's value.
-  raw_original_subtotal:
-    type: object
-    description: The item's raw original subtotal.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw original subtotal's value.
-          - type: number
-            title: value
-            description: The raw original subtotal's value.
-  raw_original_tax_total:
-    type: object
-    description: The item's raw original tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw original tax total's value.
-          - type: number
-            title: value
-            description: The raw original tax total's value.
-  raw_item_total:
-    type: object
-    description: The item's raw item total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw item total's value.
-          - type: number
-            title: value
-            description: The raw item total's value.
-  raw_item_subtotal:
-    type: object
-    description: The item's raw item subtotal.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw item subtotal's value.
-          - type: number
-            title: value
-            description: The raw item subtotal's value.
-  raw_item_tax_total:
-    type: object
-    description: The item's raw item tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw item tax total's value.
-          - type: number
-            title: value
-            description: The raw item tax total's value.
-  raw_total:
-    type: object
-    description: The item's raw total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw total's value.
-          - type: number
-            title: value
-            description: The raw total's value.
-  raw_subtotal:
-    type: object
-    description: The item's raw subtotal.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw subtotal's value.
-          - type: number
-            title: value
-            description: The raw subtotal's value.
-  raw_tax_total:
-    type: object
-    description: The item's raw tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw tax total's value.
-          - type: number
-            title: value
-            description: The raw tax total's value.
-  raw_discount_total:
-    type: object
-    description: The item's raw discount total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw discount total's value.
-          - type: number
-            title: value
-            description: The raw discount total's value.
-  raw_discount_tax_total:
-    type: object
-    description: The item's raw discount tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw discount tax total's value.
-          - type: number
-            title: value
-            description: The raw discount tax total's value.
-  raw_refundable_total:
-    type: object
-    description: The item's raw refundable total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw refundable total's value.
-          - type: number
-            title: value
-            description: The raw refundable total's value.
-  raw_refundable_total_per_unit:
-    type: object
-    description: The item's raw refundable total per unit.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw refundable total per unit's value.
-          - type: number
-            title: value
-            description: The raw refundable total per unit's value.

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

@@ -6,8 +6,6 @@ required:
   - item_id
   - total
   - subtotal
-  - raw_total
-  - raw_subtotal
   - id
   - code
   - rate
@@ -28,12 +26,6 @@ properties:
     type: number
     title: subtotal
     description: The item's total excluding taxes, including promotions.
-  raw_total:
-    type: object
-    description: The tax line's raw total.
-  raw_subtotal:
-    type: object
-    description: The tax line's raw subtotal.
   id:
     type: string
     title: id

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

@@ -3,11 +3,10 @@ description: The item's items.
 x-schemaName: OrderReturnItem
 required:
   - id
-  - quantity
-  - received_quantity
-  - damaged_quantity
-  - item_id
   - return_id
+  - order_id
+  - item_id
+  - quantity
 properties:
   id:
     type: string
@@ -23,20 +22,10 @@ properties:
     description: >-
       The received quantity of the item. This quantity is added to the stocked
       inventory quantity of the item.
-  damaged_quantity:
-    type: number
-    title: damaged_quantity
-    description: >-
-      The received damaged quantity of the item, which isn't added to the
-      stocked inventory quantity of the item.
   reason_id:
     type: string
     title: reason_id
     description: The ID of the return reason associated with the item.
-  note:
-    type: string
-    title: note
-    description: A note about why the item was returned.
   item_id:
     type: string
     title: item_id
@@ -48,3 +37,17 @@ properties:
   metadata:
     type: object
     description: The return item's metadata, can hold custom key-value pairs.
+  order_id:
+    type: string
+    title: order_id
+    description: The ID of the order the return belongs to.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the item was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the item was updated.

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

@@ -6,7 +6,6 @@ required:
   - order_id
   - name
   - amount
-  - raw_amount
   - is_tax_inclusive
   - created_at
   - updated_at
@@ -18,14 +17,6 @@ required:
   - tax_total
   - discount_total
   - discount_tax_total
-  - raw_original_total
-  - raw_original_subtotal
-  - raw_original_tax_total
-  - raw_total
-  - raw_subtotal
-  - raw_tax_total
-  - raw_discount_total
-  - raw_discount_tax_total
 properties:
   id:
     type: string
@@ -47,20 +38,6 @@ properties:
     type: number
     title: amount
     description: The shipping method's amount.
-  raw_amount:
-    type: object
-    description: The shipping method's raw amount.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw amount's value.
-          - type: number
-            title: value
-            description: The raw amount's value.
   is_tax_inclusive:
     type: boolean
     title: is_tax_inclusive
@@ -132,115 +109,3 @@ properties:
     type: number
     title: discount_tax_total
     description: The total taxes of the discount amount.
-  raw_original_total:
-    type: object
-    description: The shipping method's raw original total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw original total's value.
-          - type: number
-            title: value
-            description: The raw original total's value.
-  raw_original_subtotal:
-    type: object
-    description: The shipping method's raw original subtotal.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw original subtotal's value.
-          - type: number
-            title: value
-            description: The raw original subtotal's value.
-  raw_original_tax_total:
-    type: object
-    description: The shipping method's raw original tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw original tax total's value.
-          - type: number
-            title: value
-            description: The raw original tax total's value.
-  raw_total:
-    type: object
-    description: The shipping method's raw total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw total's value.
-          - type: number
-            title: value
-            description: The raw total's value.
-  raw_subtotal:
-    type: object
-    description: The shipping method's raw subtotal.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw subtotal's value.
-          - type: number
-            title: value
-            description: The raw subtotal's value.
-  raw_tax_total:
-    type: object
-    description: The shipping method's raw tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw tax total's value.
-          - type: number
-            title: value
-            description: The raw tax total's value.
-  raw_discount_total:
-    type: object
-    description: The shipping method's raw discount total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw discount total's value.
-          - type: number
-            title: value
-            description: The raw discount total's value.
-  raw_discount_tax_total:
-    type: object
-    description: The shipping method's raw discount tax total.
-    required:
-      - value
-    properties:
-      value:
-        oneOf:
-          - type: string
-            title: value
-            description: The raw discount tax total's value.
-          - type: number
-            title: value
-            description: The raw discount tax total's value.

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

@@ -6,8 +6,6 @@ required:
   - shipping_method_id
   - total
   - subtotal
-  - raw_total
-  - raw_subtotal
   - id
   - code
   - rate
@@ -28,12 +26,6 @@ properties:
     type: number
     title: subtotal
     description: The shipping method's total excluding taxes, including promotions.
-  raw_total:
-    type: object
-    description: The tax line's raw total.
-  raw_subtotal:
-    type: object
-    description: The tax line's raw subtotal.
   id:
     type: string
     title: id

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

@@ -4,6 +4,7 @@ x-schemaName: OrderTransaction
 required:
   - id
   - order_id
+  - order
   - amount
   - currency_code
   - reference
@@ -56,3 +57,5 @@ properties:
     format: date-time
     title: updated_at
     description: The date that the transaction was updated.
+  order:
+    type: object

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

@@ -6,54 +6,8 @@ required:
   - status
   - order_id
   - items
-  - currency_code
-  - created_at
-  - updated_at
-  - original_item_total
-  - original_item_subtotal
-  - original_item_tax_total
-  - item_total
-  - item_subtotal
-  - item_tax_total
-  - original_total
-  - original_subtotal
-  - original_tax_total
-  - total
-  - subtotal
-  - tax_total
-  - discount_total
-  - discount_tax_total
-  - gift_card_total
-  - gift_card_tax_total
-  - shipping_total
-  - shipping_subtotal
-  - shipping_tax_total
-  - original_shipping_total
-  - original_shipping_subtotal
-  - original_shipping_tax_total
-  - discount_subtotal
-  - raw_original_item_total
-  - raw_original_item_subtotal
-  - raw_original_item_tax_total
-  - raw_item_total
-  - raw_item_subtotal
-  - raw_item_tax_total
-  - raw_original_total
-  - raw_original_subtotal
-  - raw_original_tax_total
-  - raw_total
-  - raw_subtotal
-  - raw_tax_total
-  - raw_discount_total
-  - raw_discount_tax_total
-  - raw_gift_card_total
-  - raw_gift_card_tax_total
-  - raw_shipping_total
-  - raw_shipping_subtotal
-  - raw_shipping_tax_total
-  - raw_original_shipping_total
-  - raw_original_shipping_subtotal
-  - raw_original_shipping_tax_total
+  - display_id
+  - metadata
 properties:
   id:
     type: string
@@ -80,32 +34,6 @@ properties:
     description: The return's items.
     items:
       $ref: ./OrderReturnItem.yaml
-  region_id:
-    type: string
-    title: region_id
-    description: The ID of the region this return belongs to.
-  customer_id:
-    type: string
-    title: customer_id
-    description: The ID of the customer that placed the order.
-  sales_channel_id:
-    type: string
-    title: sales_channel_id
-    description: The ID of the associated order's sales channel.
-  email:
-    type: string
-    title: email
-    description: The email of the customer that placed the order.
-    format: email
-  currency_code:
-    type: string
-    title: currency_code
-    description: The return's currency code.
-    example: usd
-  shipping_address:
-    $ref: ./OrderAddress.yaml
-  billing_address:
-    $ref: ./OrderAddress.yaml
   shipping_methods:
     type: array
     description: The return's shipping methods.
@@ -116,9 +44,6 @@ properties:
     description: The return's transactions.
     items:
       $ref: ./OrderTransaction.yaml
-  summary:
-    type: object
-    description: The return's summary.
   metadata:
     type: object
     description: The return's metadata, can hold custom key-value pairs.
@@ -132,168 +57,67 @@ properties:
     format: date-time
     title: updated_at
     description: The date the return was updated.
-  original_item_total:
-    type: number
-    title: original_item_total
-    description: The return's original item total.
-  original_item_subtotal:
-    type: number
-    title: original_item_subtotal
-    description: The return's original item subtotal.
-  original_item_tax_total:
-    type: number
-    title: original_item_tax_total
-    description: The return's original item tax total.
-  item_total:
-    type: number
-    title: item_total
-    description: The return's item total.
-  item_subtotal:
-    type: number
-    title: item_subtotal
-    description: The return's item subtotal.
-  item_tax_total:
-    type: number
-    title: item_tax_total
-    description: The return's item tax total.
-  original_total:
-    type: number
-    title: original_total
-    description: The return's original total.
-  original_subtotal:
-    type: number
-    title: original_subtotal
-    description: The return's original subtotal.
-  original_tax_total:
-    type: number
-    title: original_tax_total
-    description: The return's original tax total.
-  total:
-    type: number
-    title: total
-    description: The return's total.
-  subtotal:
-    type: number
-    title: subtotal
-    description: The return's subtotal.
-  tax_total:
-    type: number
-    title: tax_total
-    description: The return's tax total.
-  discount_total:
-    type: number
-    title: discount_total
-    description: The return's discount total.
-  discount_tax_total:
-    type: number
-    title: discount_tax_total
-    description: The return's discount tax total.
-  gift_card_total:
-    type: number
-    title: gift_card_total
-    description: The return's gift card total.
-  gift_card_tax_total:
-    type: number
-    title: gift_card_tax_total
-    description: The return's gift card tax total.
-  shipping_total:
-    type: number
-    title: shipping_total
-    description: The return's shipping total.
-  shipping_subtotal:
-    type: number
-    title: shipping_subtotal
-    description: The return's shipping subtotal.
-  shipping_tax_total:
-    type: number
-    title: shipping_tax_total
-    description: The return's shipping tax total.
-  original_shipping_total:
-    type: number
-    title: original_shipping_total
-    description: The return's original shipping total.
-  original_shipping_subtotal:
-    type: number
-    title: original_shipping_subtotal
-    description: The return's original shipping subtotal.
-  original_shipping_tax_total:
-    type: number
-    title: original_shipping_tax_total
-    description: The return's original shipping tax total.
-  order_change:
-    $ref: ./OrderChange.yaml
   canceled_at:
     type: string
     title: canceled_at
     description: The date the return was canceled.
     format: date-time
-  discount_subtotal:
+  raw_refund_amount:
+    oneOf:
+      - type: string
+        title: raw_refund_amount
+        description: The return order's raw refund amount.
+      - type: number
+        title: raw_refund_amount
+        description: The return order's raw refund amount.
+      - type: string
+        title: raw_refund_amount
+        description: The return order's raw refund amount.
+      - type: number
+        title: raw_refund_amount
+        description: The return order's raw refund amount.
+  order:
+    $ref: ./Order.yaml
+  exchange_id:
+    type: string
+    title: exchange_id
+    description: The ID of the exchange this return belongs to, if any.
+  exchange:
+    type: object
+  claim_id:
+    type: string
+    title: claim_id
+    description: The ID of the claim this return belongs to, if any.
+  claim:
+    $ref: ./OrderClaim.yaml
+  display_id:
     type: number
-    title: discount_subtotal
-    description: The return's discount subtotal.
-  raw_original_item_total:
-    type: object
-    description: The return's raw original item total.
-  raw_original_item_subtotal:
-    type: object
-    description: The return's raw original item subtotal.
-  raw_original_item_tax_total:
-    type: object
-    description: The return's raw original item tax total.
-  raw_item_total:
-    type: object
-    description: The return's raw item total.
-  raw_item_subtotal:
-    type: object
-    description: The return's raw item subtotal.
-  raw_item_tax_total:
-    type: object
-    description: The return's raw item tax total.
-  raw_original_total:
-    type: object
-    description: The return's raw original total.
-  raw_original_subtotal:
-    type: object
-    description: The return's raw original subtotal.
-  raw_original_tax_total:
-    type: object
-    description: The return's raw original tax total.
-  raw_total:
-    type: object
-    description: The return's raw total.
-  raw_subtotal:
-    type: object
-    description: The return's raw subtotal.
-  raw_tax_total:
-    type: object
-    description: The return's raw tax total.
-  raw_discount_total:
-    type: object
-    description: The return's raw discount total.
-  raw_discount_tax_total:
-    type: object
-    description: The return's raw discount tax total.
-  raw_gift_card_total:
-    type: object
-    description: The return's raw gift card total.
-  raw_gift_card_tax_total:
-    type: object
-    description: The return's raw gift card tax total.
-  raw_shipping_total:
-    type: object
-    description: The return's raw shipping total.
-  raw_shipping_subtotal:
-    type: object
-    description: The return's raw shipping subtotal.
-  raw_shipping_tax_total:
-    type: object
-    description: The return's raw shipping tax total.
-  raw_original_shipping_total:
-    type: object
-    description: The return's raw original shipping total.
-  raw_original_shipping_subtotal:
-    type: object
-    description: The return's raw original shipping subtotal.
-  raw_original_shipping_tax_total:
-    type: object
-    description: The return's raw original shipping tax total.
+    title: display_id
+    description: The return order's display ID.
+  location_id:
+    type: string
+    title: location_id
+    description: The ID of the stock location the items are returned to.
+  no_notification:
+    type: boolean
+    title: no_notification
+    description: Whether to notify the customer about changes in the return.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the return.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The date the return was deleted.
+  requested_at:
+    type: string
+    title: requested_at
+    description: The date the return was requested.
+    format: date-time
+  received_at:
+    type: string
+    title: received_at
+    description: The date the return was received.
+    format: date-time

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

@@ -3,11 +3,11 @@ description: The collection's details.
 x-schemaName: StoreCollection
 required:
   - title
-  - metadata
   - id
-  - handle
+  - metadata
   - created_at
   - updated_at
+  - handle
   - deleted_at
 properties:
   id:

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

@@ -2,19 +2,17 @@ type: object
 description: The order's details.
 x-schemaName: StoreOrder
 required:
+  - items
+  - shipping_methods
+  - currency_code
   - id
-  - version
   - region_id
   - customer_id
   - sales_channel_id
   - email
-  - currency_code
-  - items
-  - shipping_methods
   - payment_status
   - fulfillment_status
   - summary
-  - metadata
   - created_at
   - updated_at
   - original_item_total
@@ -44,10 +42,6 @@ properties:
     type: string
     title: id
     description: The order's ID.
-  version:
-    type: number
-    title: version
-    description: The order's version.
   region_id:
     type: string
     title: region_id
@@ -75,24 +69,24 @@ properties:
     title: display_id
     description: The order's display ID.
   shipping_address:
-    $ref: ./BaseOrderAddress.yaml
+    $ref: ./StoreOrderAddress.yaml
   billing_address:
-    $ref: ./BaseOrderAddress.yaml
+    $ref: ./StoreOrderAddress.yaml
   items:
     type: array
     description: The order's items.
     items:
-      $ref: ./BaseOrderLineItem.yaml
+      $ref: ./StoreOrderLineItem.yaml
   shipping_methods:
     type: array
     description: The order's shipping methods.
     items:
-      $ref: ./BaseOrderShippingMethod.yaml
+      $ref: ./StoreOrderShippingMethod.yaml
   payment_collections:
     type: array
     description: The order's payment collections.
     items:
-      $ref: ./BasePaymentCollection.yaml
+      $ref: ./StorePaymentCollection.yaml
   payment_status:
     type: string
     description: The order's payment status.
@@ -111,7 +105,7 @@ properties:
     type: array
     description: The order's fulfillments.
     items:
-      $ref: ./BaseOrderFulfillment.yaml
+      $ref: ./StoreOrderFulfillment.yaml
   fulfillment_status:
     type: string
     description: The order's fulfillment status.
@@ -227,3 +221,10 @@ properties:
     type: number
     title: original_shipping_tax_total
     description: The total taxes of the order's shipping excluding promotions.
+  customer:
+    $ref: ./StoreCustomer.yaml
+  transactions:
+    type: array
+    description: The order's transactions.
+    items:
+      $ref: ./BaseOrderTransaction.yaml

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

@@ -0,0 +1,73 @@
+type: object
+description: An order address
+x-schemaName: StoreOrderAddress
+required:
+  - id
+  - metadata
+  - created_at
+  - updated_at
+properties:
+  id:
+    type: string
+    title: id
+    description: The address's ID.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The ID of the customer this address belongs to.
+  first_name:
+    type: string
+    title: first_name
+    description: The address's first name.
+  last_name:
+    type: string
+    title: last_name
+    description: The address's last name.
+  phone:
+    type: string
+    title: phone
+    description: The address's phone.
+  company:
+    type: string
+    title: company
+    description: The address's company.
+  address_1:
+    type: string
+    title: address_1
+    description: The address's first line.
+  address_2:
+    type: string
+    title: address_2
+    description: The address's second line.
+  city:
+    type: string
+    title: city
+    description: The address's city.
+  country_code:
+    type: string
+    title: country_code
+    description: The address's country code.
+    example: us
+  country:
+    $ref: ./StoreRegionCountry.yaml
+  province:
+    type: string
+    title: province
+    description: The address's province.
+  postal_code:
+    type: string
+    title: postal_code
+    description: The address's postal code.
+  metadata:
+    type: object
+    description: The address's metadata, can hold custom key-value pairs.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the address was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the address was updated.

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

@@ -0,0 +1,79 @@
+type: object
+description: The fulfillment's details.
+x-schemaName: StoreOrderFulfillment
+required:
+  - id
+  - location_id
+  - packed_at
+  - shipped_at
+  - delivered_at
+  - canceled_at
+  - requires_shipping
+  - data
+  - provider_id
+  - shipping_option_id
+  - metadata
+  - created_at
+  - updated_at
+properties:
+  id:
+    type: string
+    title: id
+    description: The fulfillment's ID.
+  location_id:
+    type: string
+    title: location_id
+    description: The ID of the location the items are fulfilled from.
+  packed_at:
+    type: string
+    title: packed_at
+    description: The date the items were packed.
+    format: date-time
+  shipped_at:
+    type: string
+    title: shipped_at
+    description: The date the items were shipped.
+    format: date-time
+  delivered_at:
+    type: string
+    title: delivered_at
+    description: The date the items were delivered.
+    format: date-time
+  canceled_at:
+    type: string
+    title: canceled_at
+    description: The date the items were canceled.
+    format: date-time
+  data:
+    type: object
+    description: >-
+      Data useful for the fulfillment provider handling it. This is taken from
+      the associated shipping option.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
+  provider_id:
+    type: string
+    title: provider_id
+    description: The ID of the fulfillment provider used to handle the fulfillment.
+  shipping_option_id:
+    type: string
+    title: shipping_option_id
+    description: The ID of the associated shipping option.
+  metadata:
+    type: object
+    description: The fulfillment's metadata, can hold custom key-value pairs.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the fulfillment was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the fulfillment was updated.
+  requires_shipping:
+    type: boolean
+    title: requires_shipping
+    description: The fulfillment's requires shipping.

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

@@ -10,10 +10,12 @@ required:
   - status
   - description
   - id
-  - handle
+  - created_at
+  - updated_at
   - subtitle
-  - is_giftcard
   - thumbnail
+  - handle
+  - is_giftcard
   - width
   - weight
   - height
@@ -25,8 +27,6 @@ required:
   - type_id
   - discountable
   - external_id
-  - created_at
-  - updated_at
   - deleted_at
 properties:
   categories:

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

@@ -122,6 +122,8 @@ required:
   - length
   - title
   - id
+  - created_at
+  - updated_at
   - width
   - weight
   - height
@@ -129,8 +131,6 @@ required:
   - hs_code
   - mid_code
   - material
-  - created_at
-  - updated_at
   - deleted_at
   - sku
   - barcode

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

@@ -0,0 +1,33 @@
+type: object
+description: The country's details.
+x-schemaName: StoreRegionCountry
+required:
+  - id
+properties:
+  id:
+    type: string
+    title: id
+    description: The country's ID.
+  iso_2:
+    type: string
+    title: iso_2
+    description: The country's ISO 2.
+    example: us
+  iso_3:
+    type: string
+    title: iso_3
+    description: The country's ISO 3.
+    example: usa
+  num_code:
+    type: string
+    title: num_code
+    description: The country's num code.
+    example: 840
+  name:
+    type: string
+    title: name
+    description: The country's name.
+  display_name:
+    type: string
+    title: display_name
+    description: The country's display name.

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

@@ -3,10 +3,10 @@ description: The return's details.
 x-schemaName: StoreReturn
 required:
   - items
-  - order_id
   - id
-  - created_at
   - display_id
+  - created_at
+  - order_id
   - canceled_at
   - received_at
 properties: