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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

docs/api/admin.oas.json

@@ -32392,7 +32392,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -32835,7 +32835,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           }
@@ -33945,7 +33945,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -34163,7 +34163,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -34438,7 +34438,7 @@
             "description": "The unique randomly generated key used to determine the state of a process.",
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -34565,6 +34565,18 @@
             "description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
             "type": "string"
           },
+          "title": {
+            "description": "Title of the inventory item",
+            "type": "string"
+          },
+          "description": {
+            "description": "Description of the inventory item",
+            "type": "string"
+          },
+          "thumbnail": {
+            "description": "Thumbnail for the inventory item",
+            "type": "string"
+          },
           "material": {
             "description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
             "type": "string"
@@ -35784,7 +35796,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -36263,7 +36275,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -36507,7 +36519,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -37884,7 +37896,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -38065,6 +38077,14 @@
             "description": "The id of the inventory item the reservation relates to",
             "type": "string"
           },
+          "description": {
+            "description": "Description of the reservation item",
+            "type": "string"
+          },
+          "created_by": {
+            "description": "UserId of user who created the reservation item",
+            "type": "string"
+          },
           "quantity": {
             "description": "The id of the reservation item",
             "type": "number"
@@ -38221,7 +38241,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -39519,7 +39539,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -39775,7 +39795,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },

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

@@ -129,8 +129,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   context:
     description: The context of the cart which can include info like IP or user agent.

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

@@ -140,6 +140,5 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.

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

@@ -70,8 +70,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -125,8 +125,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -25,8 +25,7 @@ properties:
       process.
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: Date which the idempotency key was locked.

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

@@ -21,6 +21,15 @@ properties:
       the Inventory Item. May be used by Fulfillment Providers to pass customs
       information to shipping carriers.
     type: string
+  title:
+    description: Title of the inventory item
+    type: string
+  description:
+    description: Description of the inventory item
+    type: string
+  thumbnail:
+    description: Thumbnail for the inventory item
+    type: string
   material:
     description: >-
       The material and composition that the Inventory Item is made of, May be

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

@@ -244,8 +244,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   external_id:
     description: The ID of an external order.

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

@@ -101,8 +101,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -81,8 +81,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   amount:
     description: The amount that the Payment Session has been authorized for.

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

@@ -66,8 +66,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -16,6 +16,12 @@ properties:
   inventory_item_id:
     description: The id of the inventory item the reservation relates to
     type: string
+  description:
+    description: Description of the reservation item
+    type: string
+  created_by:
+    description: UserId of user who created the reservation item
+    type: string
   quantity:
     description: The id of the reservation item
     type: number

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

@@ -102,8 +102,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   received_at:
     description: The date with timezone at which the return was received.

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

@@ -153,8 +153,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

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

@@ -43,8 +43,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

docs/api/store.oas.json

@@ -6489,7 +6489,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -6932,7 +6932,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           }
@@ -8042,7 +8042,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -8260,7 +8260,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -8535,7 +8535,7 @@
             "description": "The unique randomly generated key used to determine the state of a process.",
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -8662,6 +8662,18 @@
             "description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
             "type": "string"
           },
+          "title": {
+            "description": "Title of the inventory item",
+            "type": "string"
+          },
+          "description": {
+            "description": "Description of the inventory item",
+            "type": "string"
+          },
+          "thumbnail": {
+            "description": "Thumbnail for the inventory item",
+            "type": "string"
+          },
           "material": {
             "description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
             "type": "string"
@@ -9881,7 +9893,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -10360,7 +10372,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -10604,7 +10616,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -11981,7 +11993,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -12162,6 +12174,14 @@
             "description": "The id of the inventory item the reservation relates to",
             "type": "string"
           },
+          "description": {
+            "description": "Description of the reservation item",
+            "type": "string"
+          },
+          "created_by": {
+            "description": "UserId of user who created the reservation item",
+            "type": "string"
+          },
           "quantity": {
             "description": "The id of the reservation item",
             "type": "number"
@@ -12300,7 +12320,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -15176,7 +15196,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },
@@ -15432,7 +15452,7 @@
             "nullable": true,
             "type": "string",
             "externalDocs": {
-              "url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
+              "url": "https://docs.medusajs.com/development/idempotency-key/overview.md",
               "description": "Learn more how to use the idempotency key."
             }
           },

docs/api/store/components/schemas/Cart.yaml

@@ -129,8 +129,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   context:
     description: The context of the cart which can include info like IP or user agent.

docs/api/store/components/schemas/ClaimOrder.yaml

@@ -140,6 +140,5 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.

docs/api/store/components/schemas/DraftOrder.yaml

@@ -70,8 +70,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

docs/api/store/components/schemas/Fulfillment.yaml

@@ -125,8 +125,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

docs/api/store/components/schemas/IdempotencyKey.yaml

@@ -25,8 +25,7 @@ properties:
       process.
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: Date which the idempotency key was locked.

docs/api/store/components/schemas/InventoryItemDTO.yaml

@@ -21,6 +21,15 @@ properties:
       the Inventory Item. May be used by Fulfillment Providers to pass customs
       information to shipping carriers.
     type: string
+  title:
+    description: Title of the inventory item
+    type: string
+  description:
+    description: Description of the inventory item
+    type: string
+  thumbnail:
+    description: Thumbnail for the inventory item
+    type: string
   material:
     description: >-
       The material and composition that the Inventory Item is made of, May be

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

@@ -244,8 +244,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   external_id:
     description: The ID of an external order.

docs/api/store/components/schemas/Payment.yaml

@@ -101,8 +101,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

docs/api/store/components/schemas/PaymentSession.yaml

@@ -81,8 +81,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   amount:
     description: The amount that the Payment Session has been authorized for.

docs/api/store/components/schemas/Refund.yaml

@@ -66,8 +66,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

docs/api/store/components/schemas/ReservationItemDTO.yaml

@@ -16,6 +16,12 @@ properties:
   inventory_item_id:
     description: The id of the inventory item the reservation relates to
     type: string
+  description:
+    description: Description of the reservation item
+    type: string
+  created_by:
+    description: UserId of user who created the reservation item
+    type: string
   quantity:
     description: The id of the reservation item
     type: number

docs/api/store/components/schemas/Return.yaml

@@ -102,8 +102,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   received_at:
     description: The date with timezone at which the return was received.

docs/api/store/components/schemas/Swap.yaml

@@ -153,8 +153,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.

docs/api/store/components/schemas/TrackingLink.yaml

@@ -43,8 +43,7 @@ properties:
     nullable: true
     type: string
     externalDocs:
-      url: >-
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
-        https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
       description: Learn more how to use the idempotency key.
   created_at:
     description: The date with timezone at which the resource was created.