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

* 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:
authored and GitHub committed 2026-01-06 19:00:02 +02:00
1 parent 76ff8dcca8
commit 1af99f8d5c
219 files changed
+1509 -236

No files matched your search

@@ -29,7 +29,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -22,7 +22,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -311,6 +311,7 @@
* 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.
@@ -542,6 +543,7 @@
* 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
@@ -22,7 +22,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -13,7 +13,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -17,7 +17,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -17,7 +17,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -20,7 +20,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -14,7 +14,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -383,6 +383,7 @@
* 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.
@@ -614,6 +615,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: $and
* in: query
* required: false
@@ -22,7 +22,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -13,7 +13,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -354,6 +354,7 @@
* 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.
@@ -585,6 +586,7 @@
* 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.
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -13,7 +13,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -354,6 +354,7 @@
* 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.
@@ -585,6 +586,7 @@
* 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.
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -6,7 +6,7 @@
* Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
*
*
* You can retrieve the content of the products translated to a specific locale either by passing the `locale` query parameter or by setting the `Content-Language` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
* You can retrieve the content of the products translated to a specific locale either by passing the `locale` query parameter or by setting the `x-medusa-locale` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
*
*
* With localization, the products' content like title and description will be in the specified locale if a translation is available, and fallback to the original content otherwise. Learn more in the [Localization](#localization) section.
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -427,6 +427,7 @@
* 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.
@@ -658,6 +659,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: region_id
* in: query
* description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
@@ -6,7 +6,7 @@
* Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
*
*
* You can retrieve the content of the product translated to a specific locale either by passing the `locale` query parameter or by setting the `Content-Language` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
* You can retrieve the content of the product translated to a specific locale either by passing the `locale` query parameter or by setting the `x-medusa-locale` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
*
*
* With localization, the product's content like title and description will be in the specified locale if a translation is available, and fallback to the original content otherwise. Learn more in the [Localization](#localization) section.
@@ -29,7 +29,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -13,7 +13,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -28,9 +28,17 @@
* application/json:
* schema:
* type: object
* title: identifier
* description: The customer's identifier for the selected auth provider. For example, for the `emailpass` auth provider, the value is the customer's email.
* example: "customer@gmail.com"
* description: The input data necessary to generate a reset password token.
* required:
* - identifier
* properties:
* identifier:
* type: string
* description: The customer's identifier for the selected auth provider. For example, for the `emailpass` auth provider, the value is the customer's email.
* example: "customer@gmail.com"
* metadata:
* type: object
* description: Optional metadata to include with the reset password token generation request.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -93,6 +101,7 @@
* 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: |-
@@ -13,7 +13,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -21,7 +21,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -22,7 +22,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -29,7 +29,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -20,7 +20,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -17,7 +17,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -23,7 +23,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -22,7 +22,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -20,7 +20,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -20,7 +20,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -21,7 +21,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -16,7 +16,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -31,7 +31,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -13,7 +13,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
@@ -19,7 +19,7 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* - name: x-medusa-locale
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false