From 7ac734ca219adaeb1579ba1767eca0bdda4aba76 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 25 Jun 2025 12:18:41 +0000 Subject: [PATCH] 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> --- .../JavaScript/admin_products_imports/post.js | 16 + .../post.js | 14 + .../admin_uploads_presigned-urls/post.js | 15 + .../Shell/admin_products_imports/post.sh | 10 + .../post.sh | 2 + .../admin_uploads_presigned-urls/post.sh | 8 + .../components/schemas/AdminDraftOrder.yaml | 5 + .../schemas/AdminDraftOrderPreview.yaml | 5 + .../schemas/AdminImportProducts.yaml | 32 + .../admin/components/schemas/AdminOrder.yaml | 5 + .../components/schemas/AdminOrderPreview.yaml | 5 + .../components/schemas/AdminPromotion.yaml | 6 + .../schemas/AdminUploadPreSignedUrl.yaml | 30 + .../AdminUploadPreSignedUrlResponse.yaml | 37 + .../admin/components/schemas/BaseOrder.yaml | 5 + .../specs/admin/components/schemas/Order.yaml | 5 + .../admin/components/schemas/StoreOrder.yaml | 5 + .../schemas/StoreProductVariant.yaml | 4 +- .../specs/admin/openapi.full.yaml | 807 +++++++++++++++++- .../api-reference/specs/admin/openapi.yaml | 6 + .../specs/admin/paths/admin_api-keys.yaml | 8 + .../specs/admin/paths/admin_campaigns.yaml | 8 + .../specs/admin/paths/admin_claims.yaml | 8 + .../specs/admin/paths/admin_collections.yaml | 8 + .../specs/admin/paths/admin_currencies.yaml | 8 + .../admin/paths/admin_customer-groups.yaml | 8 + .../specs/admin/paths/admin_customers.yaml | 8 + .../paths/admin_customers_{id}_addresses.yaml | 8 + .../specs/admin/paths/admin_draft-orders.yaml | 8 + .../specs/admin/paths/admin_exchanges.yaml | 8 + .../paths/admin_fulfillment-providers.yaml | 8 + .../admin/paths/admin_inventory-items.yaml | 8 + ..._inventory-items_{id}_location-levels.yaml | 8 + .../specs/admin/paths/admin_invites.yaml | 8 + .../admin/paths/admin_notifications.yaml | 8 + .../specs/admin/paths/admin_orders.yaml | 8 + .../specs/admin/paths/admin_payments.yaml | 8 + .../admin_payments_payment-providers.yaml | 8 + .../specs/admin/paths/admin_price-lists.yaml | 8 + .../admin/paths/admin_price-preferences.yaml | 8 + .../admin/paths/admin_product-categories.yaml | 8 + .../specs/admin/paths/admin_product-tags.yaml | 8 + .../admin/paths/admin_product-types.yaml | 8 + .../admin/paths/admin_product-variants.yaml | 50 ++ .../specs/admin/paths/admin_products.yaml | 37 +- .../admin/paths/admin_products_import.yaml | 2 + ...ducts_import_{transaction_id}_confirm.yaml | 2 + .../admin/paths/admin_products_imports.yaml | 50 ++ ...ucts_imports_{transaction_id}_confirm.yaml | 47 + .../paths/admin_products_{id}_options.yaml | 8 + .../paths/admin_products_{id}_variants.yaml | 50 ++ .../specs/admin/paths/admin_promotions.yaml | 8 + ...tions_{rule_type}_{rule_attribute_id}.yaml | 8 + .../admin/paths/admin_refund-reasons.yaml | 8 + .../specs/admin/paths/admin_regions.yaml | 8 + .../specs/admin/paths/admin_reservations.yaml | 8 + .../admin/paths/admin_return-reasons.yaml | 8 + .../specs/admin/paths/admin_returns.yaml | 8 + .../admin/paths/admin_sales-channels.yaml | 8 + .../admin/paths/admin_shipping-options.yaml | 8 + .../admin/paths/admin_shipping-profiles.yaml | 8 + .../admin/paths/admin_stock-locations.yaml | 8 + .../specs/admin/paths/admin_stores.yaml | 8 + .../admin/paths/admin_tax-providers.yaml | 8 + .../specs/admin/paths/admin_tax-rates.yaml | 8 + .../specs/admin/paths/admin_tax-regions.yaml | 8 + .../paths/admin_uploads_presigned-urls.yaml | 48 ++ .../specs/admin/paths/admin_users.yaml | 8 + .../paths/admin_workflows-executions.yaml | 8 + .../components/schemas/AdminDraftOrder.yaml | 5 + .../schemas/AdminDraftOrderPreview.yaml | 5 + .../schemas/AdminImportProducts.yaml | 32 + .../store/components/schemas/AdminOrder.yaml | 5 + .../components/schemas/AdminOrderPreview.yaml | 5 + .../components/schemas/AdminPromotion.yaml | 6 + .../schemas/AdminUploadPreSignedUrl.yaml | 30 + .../AdminUploadPreSignedUrlResponse.yaml | 37 + .../store/components/schemas/BaseOrder.yaml | 5 + .../specs/store/components/schemas/Order.yaml | 5 + .../store/components/schemas/StoreOrder.yaml | 5 + .../schemas/StoreProductVariant.yaml | 4 +- .../specs/store/openapi.full.yaml | 222 ++++- .../specs/store/paths/store_collections.yaml | 8 + .../specs/store/paths/store_currencies.yaml | 8 + .../paths/store_customers_me_addresses.yaml | 8 + .../specs/store/paths/store_orders.yaml | 8 + .../store/paths/store_payment-providers.yaml | 8 + .../store/paths/store_product-categories.yaml | 8 + .../specs/store/paths/store_product-tags.yaml | 8 + .../store/paths/store_product-types.yaml | 8 + .../specs/store/paths/store_regions.yaml | 8 + .../store/paths/store_return-reasons.yaml | 8 + .../admin/delete_admin_draft-orders_[id].ts | 1 + .../operations/admin/get_admin_api-keys.ts | 8 + .../operations/admin/get_admin_campaigns.ts | 8 + .../operations/admin/get_admin_claims.ts | 8 + .../operations/admin/get_admin_collections.ts | 8 + .../operations/admin/get_admin_currencies.ts | 8 + .../admin/get_admin_customer-groups.ts | 8 + .../operations/admin/get_admin_customers.ts | 8 + .../get_admin_customers_[id]_addresses.ts | 8 + .../admin/get_admin_draft-orders.ts | 8 + .../operations/admin/get_admin_exchanges.ts | 8 + .../admin/get_admin_fulfillment-providers.ts | 8 + .../admin/get_admin_inventory-items.ts | 8 + ...in_inventory-items_[id]_location-levels.ts | 8 + .../operations/admin/get_admin_invites.ts | 8 + .../admin/get_admin_notifications.ts | 8 + .../operations/admin/get_admin_orders.ts | 8 + .../operations/admin/get_admin_payments.ts | 8 + .../get_admin_payments_payment-providers.ts | 8 + .../operations/admin/get_admin_price-lists.ts | 8 + .../admin/get_admin_price-preferences.ts | 8 + .../admin/get_admin_product-categories.ts | 8 + .../admin/get_admin_product-tags.ts | 8 + .../admin/get_admin_product-types.ts | 8 + .../admin/get_admin_product-variants.ts | 50 ++ .../operations/admin/get_admin_products.ts | 37 +- .../admin/get_admin_products_[id]_options.ts | 8 + .../admin/get_admin_products_[id]_variants.ts | 50 ++ .../operations/admin/get_admin_promotions.ts | 8 + ...options_[rule_type]_[rule_attribute_id].ts | 8 + .../admin/get_admin_refund-reasons.ts | 8 + .../operations/admin/get_admin_regions.ts | 8 + .../admin/get_admin_reservations.ts | 8 + .../admin/get_admin_return-reasons.ts | 8 + .../operations/admin/get_admin_returns.ts | 8 + .../admin/get_admin_sales-channels.ts | 8 + .../admin/get_admin_shipping-options.ts | 8 + .../admin/get_admin_shipping-profiles.ts | 8 + .../admin/get_admin_stock-locations.ts | 8 + .../operations/admin/get_admin_stores.ts | 8 + .../admin/get_admin_tax-providers.ts | 8 + .../operations/admin/get_admin_tax-rates.ts | 8 + .../operations/admin/get_admin_tax-regions.ts | 8 + .../operations/admin/get_admin_users.ts | 8 + .../admin/get_admin_workflows-executions.ts | 8 + .../admin/post_admin_products_import.ts | 2 + ...roducts_import_[transaction_id]_confirm.ts | 2 + .../admin/post_admin_products_imports.ts | 75 ++ ...oducts_imports_[transaction_id]_confirm.ts | 61 ++ .../post_admin_uploads_presigned-urls.ts | 69 ++ .../operations/store/get_store_collections.ts | 8 + .../operations/store/get_store_currencies.ts | 8 + .../store/get_store_customers_me_addresses.ts | 8 + .../operations/store/get_store_orders.ts | 8 + .../store/get_store_payment-providers.ts | 8 + .../store/get_store_product-categories.ts | 8 + .../store/get_store_product-tags.ts | 8 + .../store/get_store_product-types.ts | 8 + .../operations/store/get_store_regions.ts | 8 + .../store/get_store_return-reasons.ts | 8 + .../oas-output/schemas/AdminDraftOrder.ts | 5 + .../schemas/AdminDraftOrderPreview.ts | 5 + .../oas-output/schemas/AdminImportProducts.ts | 37 + .../oas-output/schemas/AdminOrder.ts | 5 + .../oas-output/schemas/AdminOrderPreview.ts | 5 + .../oas-output/schemas/AdminPromotion.ts | 4 + .../schemas/AdminUploadPreSignedUrl.ts | 32 + .../AdminUploadPreSignedUrlResponse.ts | 42 + .../generated/oas-output/schemas/BaseOrder.ts | 5 + .../generated/oas-output/schemas/Order.ts | 5 + .../oas-output/schemas/StoreOrder.ts | 5 + .../oas-output/schemas/StoreProductVariant.ts | 4 +- .../route-examples-output/route-examples.json | 2 +- .../src/classes/generators/route-examples.ts | 1 + .../docs-generator/src/classes/kinds/oas.ts | 7 +- .../docs-generator/src/utils/get-base-path.ts | 6 +- 168 files changed, 2982 insertions(+), 25 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports/post.js create mode 100644 www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports_{transaction_id}_confirm/post.js create mode 100644 www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_presigned-urls/post.js create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports_{transaction_id}_confirm/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_presigned-urls/post.sh create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminImportProducts.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrl.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrlResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_products_imports.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_products_imports_{transaction_id}_confirm.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_uploads_presigned-urls.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminImportProducts.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrl.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrlResponse.yaml create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_products_imports.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_products_imports_[transaction_id]_confirm.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_uploads_presigned-urls.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminImportProducts.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrl.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrlResponse.ts diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports/post.js new file mode 100644 index 0000000000..5c8c8845b5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports/post.js @@ -0,0 +1,16 @@ +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) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports_{transaction_id}_confirm/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports_{transaction_id}_confirm/post.js new file mode 100644 index 0000000000..a6f3118760 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_imports_{transaction_id}_confirm/post.js @@ -0,0 +1,14 @@ +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") +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_presigned-urls/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_presigned-urls/post.js new file mode 100644 index 0000000000..5966d58e63 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_presigned-urls/post.js @@ -0,0 +1,15 @@ +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", +})) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports/post.sh new file mode 100644 index 0000000000..0aa8c4dd42 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports/post.sh @@ -0,0 +1,10 @@ +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}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports_{transaction_id}_confirm/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports_{transaction_id}_confirm/post.sh new file mode 100644 index 0000000000..01931c3e10 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_imports_{transaction_id}_confirm/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/products/imports/{transaction_id}/confirm' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_presigned-urls/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_presigned-urls/post.sh new file mode 100644 index 0000000000..3a7ff1cb05 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_presigned-urls/post.sh @@ -0,0 +1,8 @@ +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}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml index 7b02e34a88..d0807a7018 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml @@ -40,6 +40,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -254,3 +255,7 @@ properties: description: The draft order's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The draft order's credit line total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml index 76ed108602..992e94feb2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml @@ -40,6 +40,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -653,3 +654,7 @@ properties: description: The order preview's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The draft order preview's credit line total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminImportProducts.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminImportProducts.yaml new file mode 100644 index 0000000000..ad00a75fb7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminImportProducts.yaml @@ -0,0 +1,32 @@ +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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index ff5651f98a..ac1c9a0489 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -40,6 +40,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -247,3 +248,7 @@ properties: description: The order's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The order's credit line total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index be48d39907..030a16e48c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -42,6 +42,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -655,3 +656,7 @@ properties: description: The order preview's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The order preview's credit line total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml index fe6b74aa09..1864b76ff4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml @@ -63,3 +63,9 @@ properties: - 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrl.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrl.yaml new file mode 100644 index 0000000000..045c809c17 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrl.yaml @@ -0,0 +1,30 @@ +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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrlResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrlResponse.yaml new file mode 100644 index 0000000000..c08c8d8146 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadPreSignedUrlResponse.yaml @@ -0,0 +1,37 @@ +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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml index f40d10d6dd..daa6b8cc66 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml @@ -39,6 +39,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -235,3 +236,7 @@ properties: 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index 4a07709e36..a933e4e94d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -24,6 +24,7 @@ required: - discount_subtotal - discount_total - discount_tax_total + - credit_line_total - gift_card_total - gift_card_tax_total - shipping_total @@ -303,3 +304,7 @@ properties: 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index beb82d8909..8235fd5e24 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -38,6 +38,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: id: type: string @@ -233,3 +234,7 @@ properties: 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml index a71c20070e..677ad64a10 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml @@ -134,7 +134,7 @@ required: - deleted_at - sku - barcode + - manage_inventory + - allow_backorder - ean - upc - - allow_backorder - - manage_inventory diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index eec376a010..7b37e63101 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -1571,6 +1571,14 @@ paths: 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: [] @@ -2176,6 +2184,14 @@ paths: 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: [] @@ -3613,6 +3629,14 @@ paths: 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: [] @@ -6119,6 +6143,14 @@ paths: 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: [] @@ -6717,6 +6749,14 @@ paths: 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: [] @@ -7659,6 +7699,14 @@ paths: 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: [] @@ -11477,6 +11525,14 @@ paths: 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: [] @@ -12138,6 +12194,14 @@ paths: 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: [] @@ -14282,6 +14346,14 @@ paths: 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: [] @@ -16857,6 +16929,14 @@ paths: 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: [] @@ -18380,6 +18460,14 @@ paths: 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: [] @@ -20557,6 +20645,14 @@ paths: 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: [] @@ -21186,6 +21282,14 @@ paths: 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: [] @@ -22082,6 +22186,14 @@ paths: 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 @@ -22723,6 +22835,14 @@ paths: 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: [] @@ -24246,6 +24366,14 @@ paths: 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: [] @@ -26615,6 +26743,14 @@ paths: 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: [] @@ -26777,6 +26913,14 @@ paths: 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: [] @@ -27522,6 +27666,14 @@ paths: 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: [] @@ -28243,6 +28395,14 @@ paths: 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: [] @@ -29108,6 +29268,14 @@ paths: 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: [] @@ -30082,6 +30250,14 @@ paths: 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: [] @@ -30916,6 +31092,14 @@ paths: 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: [] @@ -31754,6 +31938,56 @@ paths: 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: [] @@ -32419,10 +32653,6 @@ paths: 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 @@ -32815,6 +33045,39 @@ paths: 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: [] @@ -33322,6 +33585,8 @@ paths: ``` description: Emitted when products are deleted. deprecated: false + deprecated: true + x-deprecated_message: use `POST /admin/products/imports` instead. /admin/products/import/{transaction_id}/confirm: post: operationId: PostProductsImportTransaction_idConfirm @@ -33379,6 +33644,138 @@ paths: $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. + /admin/products/imports: + post: + 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 + /admin/products/imports/{transaction_id}/confirm: + post: + 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 /admin/products/{id}: get: operationId: GetProductsId @@ -33725,6 +34122,14 @@ paths: 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: [] @@ -34656,6 +35061,56 @@ paths: 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: [] @@ -36124,6 +36579,14 @@ paths: 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: [] @@ -36759,6 +37222,14 @@ paths: 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: [] @@ -37707,6 +38178,14 @@ paths: 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: [] @@ -38505,6 +38984,14 @@ paths: 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: [] @@ -39470,6 +39957,14 @@ paths: 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: [] @@ -40384,6 +40879,14 @@ paths: 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: [] @@ -41327,6 +41830,14 @@ paths: 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: [] @@ -43675,6 +44186,14 @@ paths: 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: [] @@ -44686,6 +45205,14 @@ paths: 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: [] @@ -45829,6 +46356,14 @@ paths: 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: [] @@ -46698,6 +47233,14 @@ paths: 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: [] @@ -48710,6 +49253,14 @@ paths: 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: [] @@ -49008,6 +49559,14 @@ paths: 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: [] @@ -49619,6 +50178,14 @@ paths: 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: [] @@ -51139,6 +51706,14 @@ paths: 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: [] @@ -52023,6 +52598,72 @@ paths: $ref: '#/components/responses/500_error' x-workflow: uploadFilesWorkflow x-events: [] + /admin/uploads/presigned-urls: + post: + 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' /admin/uploads/{id}: get: operationId: GetUploadsId @@ -52624,6 +53265,14 @@ paths: 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 @@ -53041,6 +53690,14 @@ paths: 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: [] @@ -57779,6 +58436,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -57987,6 +58645,10 @@ components: 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. AdminDraftOrderListResponse: type: object description: The list of draft orders with pagination fields. @@ -58062,6 +58724,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -58649,6 +59312,10 @@ components: 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. AdminDraftOrderPreviewResponse: type: object description: The details of the preview on the draft order. @@ -59633,6 +60300,39 @@ components: type: number title: toUpdate description: The number of products that will be updated by this import. + 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 AdminInventoryItem: type: object description: The inventory item's details. @@ -59999,6 +60699,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -60206,6 +60907,10 @@ components: 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. AdminOrderAddress: type: object description: An order address. @@ -60937,6 +61642,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -61524,6 +62230,10 @@ components: 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. AdminOrderPreviewResponse: type: object description: The preview of an order. @@ -64228,6 +64938,10 @@ components: - 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. AdminPromotionResponse: type: object description: The promotion's details. @@ -67305,6 +68019,72 @@ components: type: number title: required_quantity description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. + 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 + 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. AdminUpsertStockLocationAddress: type: object description: The details of the stock location address to create. @@ -68703,6 +69483,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -68899,6 +69680,10 @@ components: 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. BaseOrderAddress: type: object description: An order address. @@ -71529,6 +72314,7 @@ components: - discount_subtotal - discount_total - discount_tax_total + - credit_line_total - gift_card_total - gift_card_tax_total - shipping_total @@ -71804,6 +72590,10 @@ components: 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. OrderAddress: type: object description: The address's details. @@ -75240,6 +76030,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: id: type: string @@ -75435,6 +76226,10 @@ components: 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. StoreOrderAddress: type: object description: An order address @@ -82245,10 +83040,10 @@ components: - deleted_at - sku - barcode + - manage_inventory + - allow_backorder - ean - upc - - allow_backorder - - manage_inventory StoreRegion: type: object description: The region's details. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 919ab32008..4e54385350 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -981,6 +981,10 @@ paths: $ref: paths/admin_products_import.yaml /admin/products/import/{transaction_id}/confirm: $ref: paths/admin_products_import_{transaction_id}_confirm.yaml + /admin/products/imports: + $ref: paths/admin_products_imports.yaml + /admin/products/imports/{transaction_id}/confirm: + $ref: paths/admin_products_imports_{transaction_id}_confirm.yaml /admin/products/{id}: $ref: paths/admin_products_{id}.yaml /admin/products/{id}/options: @@ -1115,6 +1119,8 @@ paths: $ref: paths/admin_transaction-groups.yaml /admin/uploads: $ref: paths/admin_uploads.yaml + /admin/uploads/presigned-urls: + $ref: paths/admin_uploads_presigned-urls.yaml /admin/uploads/{id}: $ref: paths/admin_uploads_{id}.yaml /admin/users: diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml index 74aa3e57cc..3364358bab 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml @@ -1222,6 +1222,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index 036acd0d9b..bd30e0a4af 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -57,6 +57,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml index af81fc7ca6..fc0d160305 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -984,6 +984,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml index f369065360..f679cf528f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -942,6 +942,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml index b31482e672..1ef4750c34 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -107,6 +107,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index 0412dd9c26..a7611ed009 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -961,6 +961,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index eae1b1111e..197a5993ae 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -4159,6 +4159,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index 88eb6bf087..10ef227c9c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -185,6 +185,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml index f02c22b93e..34425dcc62 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -1745,6 +1745,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index f3518c8121..f5b5b75e1f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -906,6 +906,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml index d874f46e28..bf6d9fa3e5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml @@ -102,6 +102,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index 82f81d397e..c7f480c81d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -430,6 +430,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index ef8e75fadf..98286d0eb8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -86,6 +86,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index 73abc3bb86..6243ed25d3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -534,6 +534,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml index 306d2b12da..d53ac7c00d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -117,6 +117,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index 1981297f63..81ac981dfb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -701,6 +701,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml index f3a5b046d2..e6ee275926 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -536,6 +536,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml index 692d2a329f..5d915b10aa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml @@ -102,6 +102,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index 9dfe6a479e..9da2274da3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -409,6 +409,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml index 346c718cec..6b727df2d5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml @@ -136,6 +136,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index 9bbebdce0b..0221078fbb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -643,6 +643,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index 2eeac85cdb..362e6295ba 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -532,6 +532,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index 8d17b00fc5..a85582a402 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -532,6 +532,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml index f8adb70015..6de4e8ef28 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml @@ -540,6 +540,56 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index 49e87cf28a..e98fef46ce 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -676,10 +676,6 @@ get: 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 @@ -1183,6 +1179,39 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml index 3424605392..d17757042e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml @@ -83,3 +83,5 @@ post: ``` description: Emitted when products are deleted. deprecated: false + deprecated: true + x-deprecated_message: use `POST /admin/products/imports` instead. diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml index 3801815cc1..5648fe0b44 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml @@ -44,3 +44,5 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + deprecated: true + x-deprecated_message: use `POST /admin/products/imports/:transaction_id/confirm` instead. diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_imports.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_imports.yaml new file mode 100644 index 0000000000..334d557533 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_imports.yaml @@ -0,0 +1,50 @@ +post: + 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.yaml + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: ../code_samples/JavaScript/admin_products_imports/post.js + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_products_imports/post.sh + tags: + - Products + responses: + '202': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminImportProductResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: importProductsAsChunksWorkflow + x-events: [] + x-version: 2.8.5 diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_imports_{transaction_id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_imports_{transaction_id}_confirm.yaml new file mode 100644 index 0000000000..31519e0b05 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_imports_{transaction_id}_confirm.yaml @@ -0,0 +1,47 @@ +post: + 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: + $ref: >- + ../code_samples/JavaScript/admin_products_imports_{transaction_id}_confirm/post.js + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_imports_{transaction_id}_confirm/post.sh + tags: + - Products + responses: + '202': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-version: 2.8.5 diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index c651b4a343..fab7dc5dd7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -128,6 +128,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index 4c02f89be6..f37896e646 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -547,6 +547,56 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 7f4d05b9b9..46827b636e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -591,6 +591,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml index 30ae7314a6..18945b8058 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml @@ -82,6 +82,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml index 8be2706c7a..d9beba083a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml @@ -107,6 +107,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index 431c14e15a..0f4e529539 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -546,6 +546,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index c0de085694..fd8f57eda3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -606,6 +606,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml index 5b66d9c24b..6c72a98743 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml @@ -590,6 +590,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index 5a6cf52362..4baea5c063 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -699,6 +699,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index 120b7d6471..c74c7f6139 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -584,6 +584,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml index c55d8d1dbc..8f4770a9b5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -602,6 +602,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index 5b78405b47..1173ead5b8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -535,6 +535,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index c597ddee63..cc7279c784 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -562,6 +562,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml index c51f0ef327..16a0b8ed16 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml @@ -115,6 +115,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-providers.yaml index 83c1cd5892..afd261f02e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-providers.yaml @@ -112,6 +112,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index 3551bc1247..476f964b2b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -628,6 +628,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index a49e9496fb..fcd69dd7ed 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -1259,6 +1259,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_presigned-urls.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_presigned-urls.yaml new file mode 100644 index 0000000000..7c67c749a8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_presigned-urls.yaml @@ -0,0 +1,48 @@ +post: + 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.yaml + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: ../code_samples/JavaScript/admin_uploads_presigned-urls/post.js + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_uploads_presigned-urls/post.sh + tags: + - Uploads + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUploadPreSignedUrlResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_users.yaml b/www/apps/api-reference/specs/admin/paths/admin_users.yaml index eeb6efcef9..e4cb0f1c93 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -521,6 +521,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml index d8ca673b96..a3a093fd81 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml @@ -94,6 +94,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml index 7b02e34a88..d0807a7018 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml @@ -40,6 +40,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -254,3 +255,7 @@ properties: description: The draft order's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The draft order's credit line total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml index 76ed108602..992e94feb2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml @@ -40,6 +40,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -653,3 +654,7 @@ properties: description: The order preview's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The draft order preview's credit line total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminImportProducts.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminImportProducts.yaml new file mode 100644 index 0000000000..ad00a75fb7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminImportProducts.yaml @@ -0,0 +1,32 @@ +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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index ff5651f98a..ac1c9a0489 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -40,6 +40,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -247,3 +248,7 @@ properties: description: The order's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The order's credit line total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index be48d39907..030a16e48c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -42,6 +42,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -655,3 +656,7 @@ properties: description: The order preview's credit lines. items: $ref: ./OrderCreditLine.yaml + credit_line_total: + type: number + title: credit_line_total + description: The order preview's credit line total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml index fe6b74aa09..1864b76ff4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml @@ -63,3 +63,9 @@ properties: - 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrl.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrl.yaml new file mode 100644 index 0000000000..045c809c17 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrl.yaml @@ -0,0 +1,30 @@ +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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrlResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrlResponse.yaml new file mode 100644 index 0000000000..c08c8d8146 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUploadPreSignedUrlResponse.yaml @@ -0,0 +1,37 @@ +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. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml index f40d10d6dd..daa6b8cc66 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml @@ -39,6 +39,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -235,3 +236,7 @@ properties: 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index 4a07709e36..a933e4e94d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -24,6 +24,7 @@ required: - discount_subtotal - discount_total - discount_tax_total + - credit_line_total - gift_card_total - gift_card_tax_total - shipping_total @@ -303,3 +304,7 @@ properties: 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index beb82d8909..8235fd5e24 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -38,6 +38,7 @@ required: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: id: type: string @@ -233,3 +234,7 @@ properties: 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml index a71c20070e..677ad64a10 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml @@ -134,7 +134,7 @@ required: - deleted_at - sku - barcode + - manage_inventory + - allow_backorder - ean - upc - - allow_backorder - - manage_inventory diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 32d14d99d8..1a59bbda8d 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -2840,6 +2840,14 @@ paths: 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 @@ -3094,6 +3102,14 @@ paths: 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 @@ -3591,6 +3607,14 @@ paths: 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: [] @@ -4787,6 +4811,14 @@ paths: - 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 @@ -5582,6 +5614,14 @@ paths: 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 @@ -6291,6 +6331,14 @@ paths: 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 @@ -7013,6 +7061,14 @@ paths: 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 @@ -7677,6 +7733,14 @@ paths: 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 @@ -8851,6 +8915,14 @@ paths: 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 @@ -9064,6 +9136,14 @@ paths: 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 @@ -13539,6 +13619,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -13747,6 +13828,10 @@ components: 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. AdminDraftOrderListResponse: type: object description: The list of draft orders with pagination fields. @@ -13822,6 +13907,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -14409,6 +14495,10 @@ components: 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. AdminDraftOrderPreviewResponse: type: object description: The details of the preview on the draft order. @@ -15393,6 +15483,39 @@ components: type: number title: toUpdate description: The number of products that will be updated by this import. + 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 AdminInventoryItem: type: object description: The inventory item's details. @@ -15759,6 +15882,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -15966,6 +16090,10 @@ components: 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. AdminOrderAddress: type: object description: An order address. @@ -16697,6 +16825,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: return_requested_total: type: number @@ -17284,6 +17413,10 @@ components: 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. AdminOrderPreviewResponse: type: object description: The preview of an order. @@ -19988,6 +20121,10 @@ components: - 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. AdminPromotionResponse: type: object description: The promotion's details. @@ -23065,6 +23202,72 @@ components: type: number title: required_quantity description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. + 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 + 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. AdminUpsertStockLocationAddress: type: object description: The details of the stock location address to create. @@ -24463,6 +24666,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: payment_collections: type: array @@ -24659,6 +24863,10 @@ components: 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. BaseOrderAddress: type: object description: An order address. @@ -27289,6 +27497,7 @@ components: - discount_subtotal - discount_total - discount_tax_total + - credit_line_total - gift_card_total - gift_card_tax_total - shipping_total @@ -27564,6 +27773,10 @@ components: 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. OrderAddress: type: object description: The address's details. @@ -31000,6 +31213,7 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + - credit_line_total properties: id: type: string @@ -31195,6 +31409,10 @@ components: 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. StoreOrderAddress: type: object description: An order address @@ -38005,10 +38223,10 @@ components: - deleted_at - sku - barcode + - manage_inventory + - allow_backorder - ean - upc - - allow_backorder - - manage_inventory StoreRegion: type: object description: The region's details. diff --git a/www/apps/api-reference/specs/store/paths/store_collections.yaml b/www/apps/api-reference/specs/store/paths/store_collections.yaml index 51b2ede8b7..7851d0ff1e 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -671,6 +671,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_currencies.yaml b/www/apps/api-reference/specs/store/paths/store_currencies.yaml index dd91e0f46b..2a4afa1d20 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies.yaml @@ -115,6 +115,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index baee0aa0a5..d49b326f54 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml @@ -132,6 +132,14 @@ get: 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: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml index d6f35a2a69..aefbee7af9 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -133,6 +133,14 @@ get: - 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 diff --git a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml index 86016ded76..10f38e1519 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml @@ -79,6 +79,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml index 06ee3647bb..40e9611a81 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -752,6 +752,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml b/www/apps/api-reference/specs/store/paths/store_product-tags.yaml index e4c249058f..4cbfef7159 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-tags.yaml @@ -671,6 +671,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_product-types.yaml b/www/apps/api-reference/specs/store/paths/store_product-types.yaml index 0cb17e2b9e..577a6bd697 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-types.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-types.yaml @@ -668,6 +668,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_regions.yaml b/www/apps/api-reference/specs/store/paths/store_regions.yaml index 4337a44ec4..af075265f7 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -148,6 +148,14 @@ get: 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 diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml index 53246815cf..76311e5dc0 100644 --- a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml @@ -65,6 +65,14 @@ get: 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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts index 8c4c5b61ec..b9248dc11b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts @@ -58,5 +58,6 @@ * x-workflow: deleteDraftOrdersWorkflow * x-events: [] * x-version: 2.8.4 + * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts index e612f7d42c..e4512a7090 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts index 5d90ca0286..54cdb2f74b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts index 1ac8b0fccc..c9c3300a22 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts index c75b8fcacf..aa4d4e9fc0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts index 900529567d..f3058bcce5 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts index a687150683..328f086f8b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index 4687bdf7ca..aa1795001e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 08b070a23f..b55f1eec29 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index d24a096890..5047b6206a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts index efd1d105f7..f99640fb7a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts index 47eae9c83b..f181ec8dfb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index 742806d7bb..8a462c5392 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index 05211b2dc5..de56f8c4ff 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index 4e654a5327..9cd4478d97 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts index c2ac135fd9..adde089740 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index 9c69330550..f60421fb8c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index a8a282598e..bc72f3505f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts index 71f267f62d..d11066c4ed 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts index ac50443480..ec14343c13 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts index 1413fcb2d6..eecb9a43cb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 88b265fbad..29ed097ace 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts index 87c057e73c..0c4e79a2c3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index c33ded0782..25bc1b94c0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts index bd45917707..3fdde20687 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index 126769f1ca..59da1df09d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts index b80c493994..31a4aa9429 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts index e5747beb26..1ceaf1eb2f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts index 3ade016505..c719f9811c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index 6dac6c2ee9..05bca11bf0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts index 7b3f3c9183..898afb73af 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts index 08a4587335..e63b0e6567 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index 0028ddff2d..c0817fc187 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts index a725bb5535..76f37b536e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index 79e1f125c9..56323038e7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts index e1aa2d48db..f76b6cae8d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index 93cb0fae96..ecf3068066 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts index dd40d0e967..aa5b90acba 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index 6c36aed778..171c3660fc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts index 373e08f375..1f25adcf4e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-providers.ts index 63a1bcdcc8..54e8e9b962 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-providers.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index 9b68df6a67..98138f2a3a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index 67ecec5f96..21a8e42c69 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts index 643c6fae46..b93c4883e4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts index 35c156beaf..50df1784ba 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts index 5b702745ea..59ac870b57 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts @@ -97,6 +97,8 @@ * ``` * description: Emitted when products are deleted. * deprecated: false + * deprecated: true + * x-deprecated_message: use `POST /admin/products/imports` instead. * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts index 468d3afc49..0f3adc43d4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_imports.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_imports.ts new file mode 100644 index 0000000000..bcc9d348aa --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_imports.ts @@ -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 + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_imports_[transaction_id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_imports_[transaction_id]_confirm.ts new file mode 100644 index 0000000000..b4d8c098ce --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_imports_[transaction_id]_confirm.ts @@ -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 + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_uploads_presigned-urls.ts b/www/utils/generated/oas-output/operations/admin/post_admin_uploads_presigned-urls.ts new file mode 100644 index 0000000000..fc0b92655c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_uploads_presigned-urls.ts @@ -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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections.ts b/www/utils/generated/oas-output/operations/store/get_store_collections.ts index d8511ac41d..aceaff932c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts index 541e77b5de..ca28e0f3a7 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index 80597ac3dc..1ee1911879 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index 2dd35f2311..9efa4ed746 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts index f8c67cea3a..05d05b7dc0 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index 8e895b5d33..5692832112 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-tags.ts b/www/utils/generated/oas-output/operations/store/get_store_product-tags.ts index 47c29d79ff..89f088e187 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-tags.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-tags.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-types.ts b/www/utils/generated/oas-output/operations/store/get_store_product-types.ts index 2d0c521566..70240a16db 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-types.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-types.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions.ts b/www/utils/generated/oas-output/operations/store/get_store_regions.ts index e0de1e58c9..dd01a314cf 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts index aed274d711..c38c6243c5 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts @@ -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 diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts index f18491807b..d4d28b9a8f 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts index f305c14690..623a0f0f5c 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminImportProducts.ts b/www/utils/generated/oas-output/schemas/AdminImportProducts.ts new file mode 100644 index 0000000000..9dacde5595 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminImportProducts.ts @@ -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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index 155ccb913c..0f3a1462c1 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index b17213c740..9d9dbeda34 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPromotion.ts b/www/utils/generated/oas-output/schemas/AdminPromotion.ts index 736702e3b7..268bcfd425 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotion.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotion.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrl.ts b/www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrl.ts new file mode 100644 index 0000000000..2424531a3c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrl.ts @@ -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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrlResponse.ts b/www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrlResponse.ts new file mode 100644 index 0000000000..cf63c04266 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUploadPreSignedUrlResponse.ts @@ -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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrder.ts b/www/utils/generated/oas-output/schemas/BaseOrder.ts index ae4db44ab8..e0e0ecfe09 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrder.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrder.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index 77e24c4403..d1c03b36bb 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index ff4e6c550d..8188e97a89 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts index 282122b37d..69ce0d5efd 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts @@ -130,10 +130,10 @@ * - deleted_at * - sku * - barcode + * - manage_inventory + * - allow_backorder * - ean * - upc - * - allow_backorder - * - manage_inventory * */ diff --git a/www/utils/generated/route-examples-output/route-examples.json b/www/utils/generated/route-examples-output/route-examples.json index d475ebb62a..8e01e8f902 100644 --- a/www/utils/generated/route-examples-output/route-examples.json +++ b/www/utils/generated/route-examples-output/route-examples.json @@ -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": { diff --git a/www/utils/packages/docs-generator/src/classes/generators/route-examples.ts b/www/utils/packages/docs-generator/src/classes/generators/route-examples.ts index e932fe24a5..19791a3293 100644 --- a/www/utils/packages/docs-generator/src/classes/generators/route-examples.ts +++ b/www/utils/packages/docs-generator/src/classes/generators/route-examples.ts @@ -72,6 +72,7 @@ class RouteExamplesGenerator extends AbstractGenerator { * @returns Whether the Route Examples generator can run on this file. */ isFileIncluded(fileName: string): boolean { + console.log(fileName, getBasePath(fileName)) return ( super.isFileIncluded(fileName) && minimatch( diff --git a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts index e945d1cbe3..8546da64c9 100644 --- a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts +++ b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts @@ -132,7 +132,12 @@ class OasKindGenerator extends FunctionKindGenerator { ] readonly RESPONSE_TYPE_NAMES = ["MedusaResponse"] readonly FIELD_QUERY_PARAMS = ["fields", "expand"] - readonly PAGINATION_QUERY_PARAMS = ["limit", "offset", "order"] + readonly PAGINATION_QUERY_PARAMS = [ + "limit", + "offset", + "order", + "with_deleted", + ] /** * This map collects tags of all the generated OAS, then, once the generation process finishes, diff --git a/www/utils/packages/docs-generator/src/utils/get-base-path.ts b/www/utils/packages/docs-generator/src/utils/get-base-path.ts index ab85839c12..94f5cbccf5 100644 --- a/www/utils/packages/docs-generator/src/utils/get-base-path.ts +++ b/www/utils/packages/docs-generator/src/utils/get-base-path.ts @@ -5,5 +5,9 @@ * @returns The path without the relative part. */ export default function getBasePath(fileName: string) { - return fileName.substring(fileName.lastIndexOf("../") + 3) + let index = fileName.indexOf("packages/") + if (index === -1) { + index = fileName.indexOf("src/") + } + return fileName.substring(index) }