asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
github-actions[bot]
2025-06-25 12:18:41 +00:00
committed by GitHub
parent 441334abf4
commit 7ac734ca21
168 changed files with 2982 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_claims.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_collections.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_currencies.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_invites.yaml
View File

@@ -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

8
www/apps/api-reference/specs/admin/paths/admin_notifications.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_orders.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_payments.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_product-types.yaml
View File

@@ -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: []

50
www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml
View File

@@ -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: []

37
www/apps/api-reference/specs/admin/paths/admin_products.yaml
View File

@@ -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: []

2
www/apps/api-reference/specs/admin/paths/admin_products_import.yaml
View File

@@ -83,3 +83,5 @@ post:
```
description: Emitted when products are deleted.
deprecated: false
deprecated: true
x-deprecated_message: use `POST /admin/products/imports` instead.

2
www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml
View File

@@ -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.

50
www/apps/api-reference/specs/admin/paths/admin_products_imports.yaml Normal file
View File

@@ -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

47
www/apps/api-reference/specs/admin/paths/admin_products_imports_{transaction_id}_confirm.yaml Normal file
View File

@@ -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

8
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml
View File

@@ -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: []

50
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_promotions.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_regions.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_reservations.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_returns.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_stores.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_tax-providers.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml
View File

@@ -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: []

8
www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml
View File

@@ -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: []

48
www/apps/api-reference/specs/admin/paths/admin_uploads_presigned-urls.yaml Normal file
View File

@@ -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

8
www/apps/api-reference/specs/admin/paths/admin_users.yaml
View File

@@ -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

8
www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml
View File

@@ -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: []