chore(docs): Generated API Reference (automated) (#9962)

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

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

@@ -25,6 +25,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -211,3 +212,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

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

@@ -11,6 +11,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -211,3 +212,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

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

@@ -29,30 +29,33 @@ required:
   - updated_at
   - deleted_at
 properties:
-  id:
-    type: string
-    title: id
-    description: The product's ID.
+  collection:
+    $ref: ./BaseCollection.yaml
+  categories:
+    type: array
+    description: The product's categories.
+    items:
+      $ref: ./BaseProductCategory.yaml
+  variants:
+    type: array
+    description: The product's variants.
+    items:
+      type: object
+  type:
+    $ref: ./BaseProductType.yaml
+  tags:
+    type: array
+    description: The product's tags.
+    items:
+      $ref: ./BaseProductTag.yaml
+  length:
+    type: number
+    title: length
+    description: The product's length.
   title:
     type: string
     title: title
     description: The product's title.
-  handle:
-    type: string
-    title: handle
-    description: The product's handle.
-  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.
   status:
     type: string
     description: The product's status.
@@ -61,10 +64,48 @@ properties:
       - proposed
       - published
       - rejected
+  options:
+    type: array
+    description: The product's options.
+    items:
+      $ref: ./BaseProductOption.yaml
+  description:
+    type: string
+    title: description
+    description: The product's description.
+  id:
+    type: string
+    title: id
+    description: The product's ID.
+  metadata:
+    type: object
+    description: The product's metadata, can hold custom key-value pairs.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the product was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the product was updated.
+  handle:
+    type: string
+    title: handle
+    description: The product's unique handle.
+  subtitle:
+    type: string
+    title: subtitle
+    description: The product's subtitle.
+  is_giftcard:
+    type: boolean
+    title: is_giftcard
+    description: Whether the product is a gift card.
   thumbnail:
     type: string
     title: thumbnail
-    description: The product's thumbnail URL.
+    description: The product's thumbnail.
   width:
     type: number
     title: width
@@ -73,10 +114,6 @@ properties:
     type: number
     title: weight
     description: The product's weight.
-  length:
-    type: number
-    title: length
-    description: The product's length.
   height:
     type: number
     title: height
@@ -88,47 +125,23 @@ properties:
   hs_code:
     type: string
     title: hs_code
-    description: The product's hs code.
+    description: The product's HS code.
   mid_code:
     type: string
     title: mid_code
-    description: The product's mid code.
+    description: The product's MID code.
   material:
     type: string
     title: material
     description: The product's material.
-  collection:
-    $ref: ./BaseCollection.yaml
   collection_id:
     type: string
     title: collection_id
-    description: The ID of the collection the product belongs to.
-  categories:
-    type: array
-    description: The product's categories.
-    items:
-      $ref: ./BaseProductCategory.yaml
-  type:
-    $ref: ./BaseProductType.yaml
+    description: The ID of the collection that the product belongs to.
   type_id:
     type: string
     title: type_id
-    description: The ID of the type the product belongs to.
-  tags:
-    type: array
-    description: The product's tags.
-    items:
-      $ref: ./BaseProductTag.yaml
-  variants:
-    type: array
-    description: The product's variants.
-    items:
-      type: object
-  options:
-    type: array
-    description: The product's options.
-    items:
-      $ref: ./BaseProductOption.yaml
+    description: The ID of the product's type.
   images:
     type: array
     description: The product's images.
@@ -137,26 +150,13 @@ properties:
   discountable:
     type: boolean
     title: discountable
-    description: Whether the product is discountable.
+    description: Whether discounts can be applied on the product.
   external_id:
     type: string
     title: external_id
-    description: The ID of the product in an external or third-party system.
-  created_at:
-    type: string
-    format: date-time
-    title: created_at
-    description: The date the product was created.
-  updated_at:
-    type: string
-    format: date-time
-    title: updated_at
-    description: The date the product was updated.
+    description: The ID of a product in an external system, such as an ERP or CMS.
   deleted_at:
     type: string
     format: date-time
     title: deleted_at
     description: The date the product was deleted.
-  metadata:
-    type: object
-    description: The product's metadata, can hold custom key-value pairs.

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

@@ -20,9 +20,9 @@ properties:
     type: array
     description: The category's children.
     items:
-      type: object
+      $ref: ./AdminProductCategory.yaml
   parent_category:
-    type: object
+    $ref: ./AdminProductCategory.yaml
   products:
     type: array
     description: The category's products.

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

@@ -4,6 +4,7 @@ x-schemaName: Order
 required:
   - id
   - version
+  - display_id
   - status
   - currency_code
   - created_at
@@ -206,3 +207,7 @@ properties:
     type: number
     title: original_shipping_tax_total
     description: The total taxes of the order's shipping excluding promotions.
+  display_id:
+    type: number
+    title: display_id
+    description: The order's display id.

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

@@ -23,8 +23,19 @@ properties:
     title: no_notification
     description: Whether to send the customer notifications when the exchange is updated.
   difference_due:
-    type: number
-    title: difference_due
+    oneOf:
+      - type: string
+        title: difference_due
+        description: The exchange's difference due.
+      - type: number
+        title: difference_due
+        description: The exchange's difference due.
+      - type: string
+        title: difference_due
+        description: The exchange's difference due.
+      - type: number
+        title: difference_due
+        description: The exchange's difference due.
     description: >-
       The amount to be exchanged or refunded. If the amount is negative, it must
       be refunded. If positive, additional payment is required from the

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

@@ -194,3 +194,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total amount that can be refunded of a single quantity of the item.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

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

@@ -22,8 +22,19 @@ properties:
       - received
       - partially_received
   refund_amount:
-    type: number
-    title: refund_amount
+    oneOf:
+      - type: string
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: number
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: string
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: number
+        title: refund_amount
+        description: The return order's refund amount.
     description: The amount refunded by this return.
   order_id:
     type: string

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

@@ -26,6 +26,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -4009,3 +4010,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

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

@@ -18,3 +18,6 @@ properties:
     type: string
     title: phone
     description: The customer's phone.
+  metadata:
+    type: object
+    description: The customer's metadata.