docs: generate API reference for 2.12.0 (#14185)

Author: shahednasser

www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-changes_{id}/post.js

@@ -0,0 +1,19 @@
+import Medusa from "@medusajs/js-sdk"
+
+export const sdk = new Medusa({
+  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
+  debug: import.meta.env.DEV,
+  auth: {
+    type: "session",
+  },
+})
+
+sdk.admin.order.updateOrderChange(
+  "ordch_123",
+  {
+    carry_over_promotions: true
+  }
+)
+.then(({ order_change }) => {
+  console.log(order_change)
+})

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

@@ -1,2 +1,6 @@
 curl -X POST '{backend_url}/admin/draft-orders/{id}' \
--H 'Authorization: Bearer {jwt_token}'
+-H 'Authorization: Bearer {jwt_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "email": "[email protected]"
+}'

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

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/order-changes/{id}' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "carry_over_promotions": true
+}'

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

@@ -272,3 +272,10 @@ properties:
     type: number
     title: shipping_discount_total
     description: The total discount amount applied on the draft order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the draft order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

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

@@ -677,3 +677,10 @@ properties:
     type: number
     title: shipping_discount_total
     description: The total discount amount applied on the draft order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the draft order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

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

@@ -265,3 +265,10 @@ properties:
     type: number
     title: shipping_discount_total
     description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

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

@@ -139,3 +139,9 @@ properties:
     format: date-time
     title: updated_at
     description: The date the order change was updated.
+  carry_over_promotions:
+    type: boolean
+    title: carry_over_promotions
+    description: >-
+      Whether promotions from the original order should be carried over to the
+      order change (specifically, exchanges).

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

@@ -0,0 +1,8 @@
+type: object
+description: The details of the order change.
+x-schemaName: AdminOrderChangeResponse
+required:
+  - order_change
+properties:
+  order_change:
+    $ref: ./AdminOrderChange.yaml

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

@@ -679,3 +679,10 @@ properties:
     type: number
     title: shipping_discount_total
     description: The total discount amount applied on the order's shipping.
+  custom_display_id:
+    type: string
+    title: custom_display_id
+    description: The custom display ID of the order.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

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

@@ -11,6 +11,7 @@ required:
   - ean
   - upc
   - thumbnail
+  - images
   - allow_backorder
   - manage_inventory
   - hs_code
@@ -149,7 +150,7 @@ properties:
     type: array
     description: The variant's images.
     items:
-      $ref: ./AdminProductImage.yaml
+      $ref: ./BaseProductImage.yaml
   thumbnail:
     type: string
     title: thumbnail