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

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>
2025-06-25 12:18:41 +00:00
parent 441334abf4
commit 7ac734ca21
168 changed files with 2982 additions and 25 deletions
@@ -58,5 +58,6 @@
 * x-workflow: deleteDraftOrdersWorkflow
 * x-events: []
 * x-version: 2.8.4
+ * 
 */

@@ -1050,6 +1050,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -45,6 +45,14 @@
 *       type: string
 *       title: order
 *       description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -808,6 +808,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -808,6 +808,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -87,6 +87,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -823,6 +823,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -3331,6 +3331,14 @@
 *       type: boolean
 *       title: has_account
 *       description: Filter by whether the customer is registered.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -159,6 +159,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -1421,6 +1421,14 @@
 *             type: string
 *             title: customer_id
 *             description: The customer id's details.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -780,6 +780,14 @@
 *           type: boolean
 *           title: $exists
 *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -89,6 +89,14 @@
 *             type: string
 *             title: stock_location_id
 *             description: A stock location's ID.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -380,6 +380,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -69,6 +69,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -458,6 +458,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -101,6 +101,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -603,6 +603,14 @@
 *             type: string
 *             title: customer_id
 *             description: The customer id's details.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -456,6 +456,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -85,6 +85,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -349,6 +349,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -115,6 +115,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -540,6 +540,14 @@
 *             type: string
 *             title: name
 *             description: The name's details.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -456,6 +456,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -456,6 +456,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -460,6 +460,56 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
+ *   - name: ean
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: ean
+ *           description: The product variant's ean.
+ *         - type: array
+ *           description: The product variant's ean.
+ *           items:
+ *             type: string
+ *             title: ean
+ *             description: The ean's details.
+ *   - name: upc
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: upc
+ *           description: The product variant's upc.
+ *         - type: array
+ *           description: The product variant's upc.
+ *           items:
+ *             type: string
+ *             title: upc
+ *             description: The upc's details.
+ *   - name: barcode
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: barcode
+ *           description: The product variant's barcode.
+ *         - type: array
+ *           description: The product variant's barcode.
+ *           items:
+ *             type: string
+ *             title: barcode
+ *             description: The barcode's details.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -588,10 +588,6 @@
 *       description: Filter the retrieved products' variants.
 *       x-schemaName: AdminProductVariantParams
 *       properties:
- *         q:
- *           type: string
- *           title: q
- *           description: Search term to apply on the variant's searchable properties.
 *         id:
 *           oneOf:
 *             - type: string
@@ -985,6 +981,39 @@
 *           items:
 *             type: object
 *           title: $or
+ *         ean:
+ *           oneOf:
+ *             - type: string
+ *               title: ean
+ *               description: The variant's ean.
+ *             - type: array
+ *               description: The variant's ean.
+ *               items:
+ *                 type: string
+ *                 title: ean
+ *                 description: The ean's details.
+ *         upc:
+ *           oneOf:
+ *             - type: string
+ *               title: upc
+ *               description: The variant's upc.
+ *             - type: array
+ *               description: The variant's upc.
+ *               items:
+ *                 type: string
+ *                 title: upc
+ *                 description: The upc's details.
+ *         barcode:
+ *           oneOf:
+ *             - type: string
+ *               title: barcode
+ *               description: The variant's barcode.
+ *             - type: array
+ *               description: The variant's barcode.
+ *               items:
+ *                 type: string
+ *                 title: barcode
+ *                 description: The barcode's details.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -108,6 +108,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -467,6 +467,56 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
+ *   - name: ean
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: ean
+ *           description: The product's ean.
+ *         - type: array
+ *           description: The product's ean.
+ *           items:
+ *             type: string
+ *             title: ean
+ *             description: The ean's details.
+ *   - name: upc
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: upc
+ *           description: The product's upc.
+ *         - type: array
+ *           description: The product's upc.
+ *           items:
+ *             type: string
+ *             title: upc
+ *             description: The upc's details.
+ *   - name: barcode
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: barcode
+ *           description: The product's barcode.
+ *         - type: array
+ *           description: The product's barcode.
+ *           items:
+ *             type: string
+ *             title: barcode
+ *             description: The barcode's details.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -503,6 +503,14 @@
 *             type: string
 *             title: application_method_type
 *             description: An application method type.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -74,6 +74,14 @@
 *       enum:
 *         - fixed
 *         - percentage
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -87,6 +87,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -470,6 +470,14 @@
 *             type: string
 *             title: currency_code
 *             description: The currency code's details.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -511,6 +511,14 @@
 *           type: boolean
 *           title: $exists
 *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -500,6 +500,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -603,6 +603,14 @@
 *             type: string
 *             title: customer_id
 *             description: The customer id's details.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -500,6 +500,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -510,6 +510,14 @@
 *       type: boolean
 *       title: admin_only
 *       description: Filter by whether the shipping option is used by admin users only.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -458,6 +458,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -484,6 +484,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -99,6 +99,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -92,6 +92,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -528,6 +528,14 @@
 *       type: string
 *       title: shipping_option_type_id
 *       description: Filter by a shipping option type's ID to retrieve its associated tax rates.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -989,6 +989,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -449,6 +449,14 @@
 *           type: boolean
 *           title: $exists
 *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -81,6 +81,14 @@
 *       type: string
 *       title: q
 *       description: Search query to filter by a workflow execution's searchable fields.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - api_token: []
 *   - cookie_auth: []
@@ -97,6 +97,8 @@
 *       ```
 *     description: Emitted when products are deleted.
 *     deprecated: false
+ * deprecated: true
+ * x-deprecated_message: use `POST /admin/products/imports` instead.
 * 
 */

@@ -55,6 +55,8 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
+ * deprecated: true
+ * x-deprecated_message: use `POST /admin/products/imports/:transaction_id/confirm` instead.
 * 
 */

@@ -0,0 +1,75 @@
+/**
+ * @oas [post] /admin/products/imports
+ * operationId: PostProductsImports
+ * summary: Create Product Import
+ * description: Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/imports` API route.
+ * x-authenticated: true
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/AdminImportProducts"
+ * x-codeSamples:
+ *   - lang: JavaScript
+ *     label: JS SDK
+ *     source: |-
+ *       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.product.createImport({
+ *         file // uploaded File instance
+ *       })
+ *       .then(({ transaction_id }) => {
+ *         console.log(transaction_id)
+ *       })
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/admin/products/imports' \
+ *       -H 'Authorization: Bearer {access_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "file_key": "{value}",
+ *         "originalname": "{value}",
+ *         "extension": "{value}",
+ *         "size": 38,
+ *         "mime_type": "{value}"
+ *       }'
+ * tags:
+ *   - Products
+ * responses:
+ *   "202":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminImportProductResponse"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * x-workflow: importProductsAsChunksWorkflow
+ * x-events: []
+ * x-version: 2.8.5
+ * 
+*/
+
@@ -0,0 +1,61 @@
+/**
+ * @oas [post] /admin/products/imports/{transaction_id}/confirm
+ * operationId: PostProductsImportsTransaction_idConfirm
+ * summary: Confirm Product Import
+ * description: Confirm that a created product import should start importing the products into Medusa.
+ * x-authenticated: true
+ * parameters:
+ *   - name: transaction_id
+ *     in: path
+ *     description: The product's transaction id.
+ *     required: true
+ *     schema:
+ *       type: string
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
+ * x-codeSamples:
+ *   - lang: JavaScript
+ *     label: JS SDK
+ *     source: |-
+ *       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.product.confirmImport("transaction_123")
+ *       .then(() => {
+ *         console.log("Import confirmed")
+ *       })
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/admin/products/imports/{transaction_id}/confirm' \
+ *       -H 'Authorization: Bearer {access_token}'
+ * tags:
+ *   - Products
+ * responses:
+ *   "202":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * x-version: 2.8.5
+ * 
+*/
+
@@ -0,0 +1,69 @@
+/**
+ * @oas [post] /admin/uploads/presigned-urls
+ * operationId: PostUploadsPresignedUrls
+ * summary: Get Presigned Upload URL
+ * description: Get a presigned URL for uploading a file to the configured File Module Provider. The presigned URL can be used to upload files directly to the third-party provider. This only works if your configured provider supports presigned URLs, such as the S3 provider.
+ * x-authenticated: true
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/AdminUploadPreSignedUrl"
+ * x-codeSamples:
+ *   - lang: JavaScript
+ *     label: JS SDK
+ *     source: |-
+ *       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.upload.presignedUrl({
+ *         name: "test.txt",
+ *         size: 1000,
+ *         type: "text/plain",
+ *       }))
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/admin/uploads/presigned-urls' \
+ *       -H 'Authorization: Bearer {access_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "originalname": "{value}",
+ *         "size": 43,
+ *         "mime_type": "{value}"
+ *       }'
+ * tags:
+ *   - Uploads
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminUploadPreSignedUrlResponse"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -574,6 +574,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -95,6 +95,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -112,6 +112,14 @@
 *       type: string
 *       title: q
 *       description: Search term to filter the address's searchable properties.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * security:
 *   - cookie_auth: []
 *   - jwt_token: []
@@ -121,6 +121,14 @@
 *               - completed
 *               - draft
 *               - archived
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -64,6 +64,14 @@
 *       type: string
 *       title: region_id
 *       description: Filter by a region ID.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -636,6 +636,14 @@
 *             type: string
 *             title: name
 *             description: A product category name.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -575,6 +575,14 @@
 *           type: boolean
 *           title: $exists
 *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -575,6 +575,14 @@
 *           type: boolean
 *           title: $exists
 *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -126,6 +126,14 @@
 *       items:
 *         type: object
 *       title: $or
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: JavaScript
 *     label: JS SDK
@@ -53,6 +53,14 @@
 *       type: string
 *       title: order
 *       description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
+ *   - name: with_deleted
+ *     in: query
+ *     description: Whether to include deleted records in the result.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: with_deleted
+ *       description: Whether to include deleted records in the result.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   payment_collections:
 *     type: array
@@ -250,6 +251,10 @@
 *     description: The draft order's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The draft order's credit line total.
 * 
 */

@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   return_requested_total:
 *     type: number
@@ -629,6 +630,10 @@
 *     description: The order preview's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The draft order preview's credit line total.
 * 
 */

@@ -0,0 +1,37 @@
+/**
+ * @schema AdminImportProducts
+ * type: object
+ * description: The details of the product's import file.
+ * x-schemaName: AdminImportProducts
+ * required:
+ *   - file_key
+ *   - originalname
+ *   - extension
+ *   - size
+ *   - mime_type
+ * properties:
+ *   file_key:
+ *     type: string
+ *     title: file_key
+ *     description: The name of the file as stored in the configured File Module Provider.
+ *   originalname:
+ *     type: string
+ *     title: originalname
+ *     description: The file's original name.
+ *   extension:
+ *     type: string
+ *     title: extension
+ *     description: The file's extension.
+ *     example: csv
+ *   size:
+ *     type: number
+ *     title: size
+ *     description: The file's size in bytes.
+ *   mime_type:
+ *     type: string
+ *     title: mime_type
+ *     description: The file's mime type.
+ *     example: text/csv
+ * 
+*/
+
@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   payment_collections:
 *     type: array
@@ -249,6 +250,10 @@
 *     description: The order's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   return_requested_total:
 *     type: number
@@ -629,6 +630,10 @@
 *     description: The order preview's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order preview's credit line total.
 * 
 */

@@ -63,6 +63,10 @@
 *       - draft
 *       - active
 *       - inactive
+ *   is_tax_inclusive:
+ *     type: boolean
+ *     title: is_tax_inclusive
+ *     description: Whether the promotion is tax inclusive. If enabled, the promotion is applied after tax is calculated.
 * 
 */

@@ -0,0 +1,32 @@
+/**
+ * @schema AdminUploadPreSignedUrl
+ * type: object
+ * description: The details of the file to upload.
+ * x-schemaName: AdminUploadPreSignedUrl
+ * required:
+ *   - originalname
+ *   - size
+ *   - mime_type
+ * properties:
+ *   originalname:
+ *     type: string
+ *     title: originalname
+ *     description: The file's original name.
+ *   size:
+ *     type: number
+ *     title: size
+ *     description: The file's size in bytes.
+ *   mime_type:
+ *     type: string
+ *     title: mime_type
+ *     description: The file's mime type.
+ *     example: text/csv
+ *   access:
+ *     type: string
+ *     description: The access level of the file. If `private`, the file will not be publicly accessible. The default value depends on the configured File Module Provider.
+ *     enum:
+ *       - public
+ *       - private
+ * 
+*/
+
@@ -0,0 +1,42 @@
+/**
+ * @schema AdminUploadPreSignedUrlResponse
+ * type: object
+ * description: The result of the pre-signed URL upload request.
+ * x-schemaName: AdminUploadPreSignedUrlResponse
+ * required:
+ *   - url
+ *   - filename
+ *   - originalname
+ *   - mime_type
+ *   - extension
+ *   - size
+ * properties:
+ *   url:
+ *     type: string
+ *     title: url
+ *     description: The file's pre-signed upload URL.
+ *   filename:
+ *     type: string
+ *     title: filename
+ *     description: The file's filename.
+ *   originalname:
+ *     type: string
+ *     title: originalname
+ *     description: The file's orignal name.
+ *   mime_type:
+ *     type: string
+ *     title: mime_type
+ *     description: The file's mime type.
+ *     example: text/csv
+ *   extension:
+ *     type: string
+ *     title: extension
+ *     description: The file's extension.
+ *     example: csv
+ *   size:
+ *     type: number
+ *     title: size
+ *     description: The file's size in bytes.
+ * 
+*/
+
@@ -41,6 +41,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   payment_collections:
 *     type: array
@@ -237,6 +238,10 @@
 *     type: string
 *     title: status
 *     description: The order's status.
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -26,6 +26,7 @@
 *   - discount_subtotal
 *   - discount_total
 *   - discount_tax_total
+ *   - credit_line_total
 *   - gift_card_total
 *   - gift_card_tax_total
 *   - shipping_total
@@ -301,6 +302,10 @@
 *     format: date-time
 *     title: deleted_at
 *     description: The date the order was deleted.
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -40,6 +40,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   id:
 *     type: string
@@ -235,6 +236,10 @@
 *     type: string
 *     title: status
 *     description: The order's status.
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -130,10 +130,10 @@
 *   - deleted_at
 *   - sku
 *   - barcode
+ *   - manage_inventory
+ *   - allow_backorder
 *   - ean
 *   - upc
- *   - allow_backorder
- *   - manage_inventory
 * 
 */

@@ -494,7 +494,7 @@
  "POST /admin/products/imports": {
    "js-sdk": "sdk.admin.product.createImport({\n  file // uploaded File instance\n})\n.then(({ transaction_id }) => {\n  console.log(transaction_id)\n})"
  },
-  "POST /admin/products/import/{transactionid}/confirm": {
+  "POST /admin/products/imports/{transactionid}/confirm": {
    "js-sdk": "sdk.admin.product.confirmImport(\"transaction_123\")\n.then(() => {\n  console.log(\"Import confirmed\")\n})"
  },
  "POST /admin/products/export": {