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

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

Browse Source 
* chore(docs): Generated API Reference (automated)

* fixes

* fix locale header

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2026-01-06 19:00:02 +02:00
committed by GitHub
parent 76ff8dcca8
commit 1af99f8d5c
219 changed files with 1509 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_translations_entities/get.js Normal file
View File

@@ -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.translation.entities({
type: "product"
})
.then(({ data, count, offset, limit }) => {
console.log(data)
})

2
www/apps/api-reference/specs/admin/code_samples/Shell/admin_translations_entities/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/admin/translations/entities' \
-H 'Authorization: Bearer {access_token}'

2
www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml
View File

@@ -6,9 +6,9 @@ required:
- type
- options
- images
- length
- title
- status
- length
- id
- created_at
- updated_at

41
www/apps/api-reference/specs/admin/components/schemas/AdminTranslationEntitiesResponse.yaml Normal file
View File

@@ -0,0 +1,41 @@
type: object
description: The list of translatable entities.
x-schemaName: AdminTranslationEntitiesResponse
required:
- data
- count
- offset
- limit
properties:
data:
type: array
description: The list of translatable entities.
items:
allOf:
- type: object
description: The entity's data.
required:
- id
- translations
properties:
id:
type: string
title: id
description: The entity's ID.
translations:
type: array
description: The entity's translations.
items:
$ref: ./AdminTranslation.yaml
count:
type: number
title: count
description: The total number of translatable entities.
offset:
type: number
title: offset
description: The number of items skipped before retrieving the returned items.
limit:
type: number
title: limit
description: The maximum number of items returned in the response.

5
www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml
View File

@@ -208,3 +208,8 @@ properties:
description: The cart's promotions.
items:
$ref: ./StoreCartPromotion.yaml
completed_at:
type: string
title: completed_at
description: The date the cart was completed.
format: date-time

2
www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml
View File

@@ -131,8 +131,8 @@ properties:
$ref: ./BaseProductImage.yaml
required:
- options
- length
- title
- length
- id
- created_at
- updated_at

387
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

File diff suppressed because it is too large Load Diff

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

@@ -1212,6 +1212,8 @@ paths:
$ref: paths/admin_translations.yaml
/admin/translations/batch:
$ref: paths/admin_translations_batch.yaml
/admin/translations/entities:
$ref: paths/admin_translations_entities.yaml
/admin/translations/settings:
$ref: paths/admin_translations_settings.yaml
/admin/translations/statistics:

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

@@ -387,6 +387,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the API key's update date.
@@ -656,6 +657,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the API key's deletion date.
@@ -925,6 +927,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: revoked_at
in: query
description: Filter by the API key's revoke date.
@@ -1194,6 +1197,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: revoked_at
- name: $and
in: query
description: >-

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

@@ -340,6 +340,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: q
in: query
description: The claim's q.
@@ -673,6 +674,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the claim's update date.
@@ -956,6 +958,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: $and
in: query
description: >-
@@ -1219,6 +1222,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -1358,6 +1362,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -1497,6 +1502,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml
View File

@@ -198,6 +198,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -337,6 +338,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -476,6 +478,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml
View File

@@ -208,6 +208,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -347,6 +348,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -486,6 +488,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml
View File

@@ -209,6 +209,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -348,6 +349,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -487,6 +489,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml
View File

@@ -198,6 +198,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -337,6 +338,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -476,6 +478,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml
View File

@@ -209,6 +209,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -348,6 +349,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -487,6 +489,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml
View File

@@ -198,6 +198,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -337,6 +338,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -476,6 +478,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml
View File

@@ -209,6 +209,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -348,6 +349,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -487,6 +489,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

3
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml
View File

@@ -196,6 +196,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a claim's update date.
@@ -335,6 +336,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a claim's deletion date.
@@ -474,6 +476,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
security:
- api_token: []
- cookie_auth: []

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

@@ -326,6 +326,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: q
in: query
description: Search term to filter the collection's searchable properties by.
@@ -645,6 +646,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the collection's update date.
@@ -914,6 +916,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: $and
in: query
description: >-

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

@@ -395,6 +395,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter the customer groups by their update date.
@@ -664,6 +665,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter the customer groups by their deletion date.
@@ -933,6 +935,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

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

@@ -3585,6 +3585,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a customer's update date.
@@ -3854,6 +3855,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter a customer by their deletion date.
@@ -4123,6 +4125,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

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

@@ -1462,6 +1462,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the draft order's update date.
@@ -1731,6 +1732,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: customer_id
in: query
required: false

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

@@ -326,6 +326,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: id
in: query
required: false
@@ -637,6 +638,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the exchange's update date.
@@ -906,6 +908,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: with_deleted
in: query
description: Whether to include deleted records in the result.

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

@@ -234,6 +234,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the invite's update date.
@@ -373,6 +374,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the invite's deletion date.
@@ -512,6 +514,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

3
www/apps/api-reference/specs/admin/paths/admin_order-changes_{id}.yaml
View File

@@ -283,6 +283,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the order change's update date.
@@ -552,6 +553,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the order change's deletion date.
@@ -821,6 +823,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: id
in: query
required: false

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

@@ -418,6 +418,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the order's update date.
@@ -687,6 +688,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: customer_id
in: query
required: false

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

@@ -215,6 +215,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by an order's update date.
@@ -354,6 +355,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: limit
in: query
description: Limit the number of items returned in the list.

3
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml
View File

@@ -306,6 +306,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the order change's update date.
@@ -575,6 +576,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the order change's deletion date.
@@ -844,6 +846,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: id
in: query
required: false

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

@@ -236,6 +236,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the payment's update date.
@@ -375,6 +376,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the payment's deletion date.
@@ -514,6 +516,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -218,6 +218,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: starts_at
- name: ends_at
in: query
description: Filter by the price list's end date.
@@ -357,6 +358,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: ends_at
- name: status
in: query
description: Filter by the price list's status.
@@ -636,6 +638,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: starts_at
- name: ends_at
in: query
description: Filter by a price list's end date.
@@ -775,6 +778,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: ends_at
- name: status
in: query
description: Filter by price list statuses.

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

@@ -329,6 +329,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the category's update date.
@@ -468,6 +469,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the category's deletion date.
@@ -607,6 +609,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

3
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
View File

@@ -441,6 +441,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the category's update date.
@@ -710,6 +711,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the category's deletion date.
@@ -979,6 +981,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: limit
in: query
description: Limit the number of items returned in the list.

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

@@ -232,6 +232,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the tag's update date.
@@ -371,6 +372,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the tag's deletion date.
@@ -510,6 +512,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -232,6 +232,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the type's update date.
@@ -371,6 +372,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the type's deletion date.
@@ -510,6 +512,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -234,6 +234,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the product variant's update date.
@@ -373,6 +374,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the product variant's deletion date.
@@ -512,6 +514,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

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

@@ -347,6 +347,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a product's update date.
@@ -486,6 +487,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a product's deletion date.
@@ -625,6 +627,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

3
www/apps/api-reference/specs/admin/paths/admin_products_export.yaml
View File

@@ -274,6 +274,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a product's update date.
@@ -413,6 +414,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: handle
in: query
required: false
@@ -602,6 +604,7 @@ post:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: order
in: query
description: >-

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

@@ -241,6 +241,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the product's update date.
@@ -380,6 +381,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by the product's deletion date.
@@ -519,6 +521,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

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

@@ -255,6 +255,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a promotion's update date.
@@ -394,6 +395,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a promotion's deletion date.
@@ -533,6 +535,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -232,6 +232,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a region's update date.
@@ -371,6 +372,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a region's deletion date.
@@ -510,6 +512,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -328,6 +328,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a reservation's update date.
@@ -467,6 +468,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a reservation's deletion date.
@@ -606,6 +608,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
@@ -721,46 +724,44 @@ get:
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
type: number
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
type: number
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
type: number
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
type: number
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
type: number
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
type: number
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
type: number
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: quantity
security:
- api_token: []
- cookie_auth: []

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

@@ -284,6 +284,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a return reason's update date.
@@ -423,6 +424,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a return reason's deletion date.
@@ -562,6 +564,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

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

@@ -416,6 +416,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by the return's update date.
@@ -685,6 +686,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: customer_id
in: query
required: false

2
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml
View File

@@ -622,6 +622,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -934,6 +935,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
security:
- api_token: []
- cookie_auth: []

2
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml
View File

@@ -622,6 +622,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -934,6 +935,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
security:
- api_token: []
- cookie_auth: []

2
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml
View File

@@ -621,6 +621,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -933,6 +934,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
security:
- api_token: []
- cookie_auth: []

2
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml
View File

@@ -621,6 +621,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -933,6 +934,7 @@ delete:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
security:
- api_token: []
- cookie_auth: []

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

@@ -250,6 +250,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a sales channel's update date.
@@ -389,6 +390,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a sales channel's deletion date.
@@ -528,6 +530,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: location_id
in: query
required: false

3
www/apps/api-reference/specs/admin/paths/admin_shipping-option-types.yaml
View File

@@ -263,6 +263,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a shipping option type's update date.
@@ -402,6 +403,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a shipping option type's deletion date.
@@ -541,6 +543,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
description: >-

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

@@ -290,6 +290,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a shipping option's update date.
@@ -429,6 +430,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a shipping option's deletion date.
@@ -568,6 +570,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: stock_location_id
in: query
required: false
@@ -742,4 +745,14 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createShippingOptionsWorkflow
x-events: []
x-events:
- name: shipping-option.created
payload: |-
```ts
{
id, // The ID of the shipping option
}
```
description: Emitted when shipping options are created.
deprecated: false
since: 2.12.4

24
www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml
View File

@@ -136,7 +136,17 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateShippingOptionsWorkflow
x-events: []
x-events:
- name: shipping-option.updated
payload: |-
```ts
{
id, // The ID of the shipping option
}
```
description: Emitted when shipping options are updated.
deprecated: false
since: 2.12.4
delete:
operationId: DeleteShippingOptionsId
summary: Delete a Shipping Option
@@ -184,4 +194,14 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteShippingOptionsWorkflow
x-events: []
x-events:
- name: shipping-option.deleted
payload: |-
```ts
{
id, // The ID of the shipping option
}
```
description: Emitted when shipping options are deleted.
deprecated: false
since: 2.12.4

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

@@ -235,6 +235,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a shipping profile's update date.
@@ -374,6 +375,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a shipping profile's deletion date.
@@ -513,6 +515,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -262,6 +262,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a stock location's update date.
@@ -401,6 +402,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a stock location's deletion date.
@@ -540,6 +542,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

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

@@ -286,6 +286,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a tax rate's update date.
@@ -425,6 +426,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a tax rate's deletion date.
@@ -564,6 +566,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: $and
in: query
required: false

128
www/apps/api-reference/specs/admin/paths/admin_translations_entities.yaml Normal file
View File

@@ -0,0 +1,128 @@
get:
operationId: GetTranslationsEntities
summary: List Translatable Entities
description: >-
Retrieve a list of translatable entities. The entities can be filtered by
fields such as `id`. The entities can also be sorted or paginated.
x-authenticated: true
parameters:
- name: type
in: query
description: Filter by a translatable entity type.
required: true
schema:
type: string
title: type
description: Filter by a translatable entity type.
example: product
- name: id
in: query
required: false
schema:
oneOf:
- type: string
title: id
description: Filter by an entity's ID.
- type: array
description: Filter by entity IDs.
items:
type: string
title: id
description: An entity's ID.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: order
in: query
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 `-`.
required: false
schema:
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 `-`.
externalDocs:
url: '#pagination'
- name: with_deleted
in: query
description: The translation's with deleted.
required: false
schema:
type: boolean
title: with_deleted
description: The translation's with deleted.
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data. If
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. Without prefix it will
replace the entire default fields.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
If a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. Without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: JavaScript
label: JS SDK
source:
$ref: ../code_samples/JavaScript/admin_translations_entities/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_translations_entities/get.sh
tags:
- Translations
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminTranslationEntitiesResponse.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-since: 2.12.4
x-featureFlag: translation

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

@@ -243,6 +243,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a user's update date.
@@ -382,6 +383,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: deleted_at
in: query
description: Filter by a user's deletion date.
@@ -521,6 +523,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: deleted_at
- name: with_deleted
in: query
description: Whether to include deleted records in the result.

2
www/apps/api-reference/specs/admin/paths/admin_views_{entity}_configurations.yaml
View File

@@ -259,6 +259,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: created_at
- name: updated_at
in: query
description: Filter by a view configuration's update date.
@@ -398,6 +399,7 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
title: updated_at
- name: fields
in: query
description: >-

21
www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_reset-password.yaml
View File

@@ -38,11 +38,21 @@ post:
application/json:
schema:
type: object
title: identifier
description: >-
The user's identifier for the selected auth provider. For example,
for the `emailpass` auth provider, the value is the user's email.
example: admin@medusa-test.com
description: The input data necessary to generate a reset password token.
required:
- identifier
properties:
identifier:
type: string
description: >-
The identifier of the admin user. For example, their email
address.
example: admin@medusa-test.com
metadata:
type: object
description: >-
Optional metadata to include with the reset password token
generation request.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -79,6 +89,7 @@ post:
entity_id, // The identifier of the user or customer. For example, an email address.
actor_type, // The type of actor. For example, "customer", "user", or custom.
token, // The generated token.
metadata, // Optional custom metadata passed from the request.
}
```
description: >-