chore: generate and update OAS for translations (#14281)

* chore: generate and update OAS for translations

* support localization header

* add locale to all store routes

* fixes

* small fix
This commit is contained in:
Shahed Nasser
2025-12-16 15:52:33 +02:00
committed by GitHub
parent 6815b3d7db
commit 53cdbaa069
75 changed files with 2322 additions and 6 deletions
@@ -29,6 +29,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -41,6 +51,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -22,6 +22,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -34,6 +44,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -23,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -37,6 +47,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -596,6 +606,16 @@
* type: string
* title: id
* description: The collection's ID.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -22,6 +22,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -34,6 +44,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -13,6 +13,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -103,6 +113,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -17,6 +17,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -17,6 +17,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: city
* in: query
* description: Filter by the address's city.
@@ -118,6 +128,16 @@
* items:
* type: object
* title: $or
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -20,6 +20,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -34,6 +44,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -0,0 +1,91 @@
/**
* @oas [get] /store/locales
* operationId: GetLocales
* summary: List Locales
* description: Retrieve the list of supported locales. You can use this list to allow customers to select their preferred locale in your storefront.
* externalDocs:
* url: https://docs.medusajs.com/resources/storefront-development/localization
* description: Learn how to serve localized content in your storefront.
* x-authenticated: false
* parameters:
* - name: x-publishable-api-key
* in: header
* description: Publishable API Key created in the Medusa Admin.
* required: true
* schema:
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* let MEDUSA_BACKEND_URL = "http://localhost:9000"
*
* if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
* MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
* }
*
* export const sdk = new Medusa({
* baseUrl: MEDUSA_BACKEND_URL,
* debug: process.env.NODE_ENV === "development",
* publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
* })
*
* sdk.store.locale.list()
* .then(({ locales }) => {
* console.log(locales)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/store/locales' \
* -H 'x-publishable-api-key: {your_publishable_api_key}'
* tags:
* - Locales
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreLocaleListResponse"
* "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-since: 2.12.3
* x-featureFlag: translation
*
*/
@@ -14,6 +14,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -129,6 +139,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -72,6 +82,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -644,6 +654,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -22,6 +22,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -56,6 +66,16 @@
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
* `fields=category_children.id,category_children.name`.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -13,6 +13,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -583,6 +593,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -33,6 +43,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -13,6 +13,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -583,6 +593,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -33,6 +43,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -2,7 +2,14 @@
* @oas [get] /store/products
* operationId: GetProducts
* summary: List Products
* description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
* description: >
* 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.
*
*
* 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.
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/resources/storefront-development/products/price
@@ -16,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -732,6 +749,16 @@
* type: string
* title: cart_id
* description: The product's cart id.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -2,7 +2,14 @@
* @oas [get] /store/products/{id}
* operationId: GetProductsId
* summary: Get a Product
* description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
* description: >
* 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.
*
*
* 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.
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/resources/storefront-development/products/price
@@ -22,6 +29,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -73,6 +90,16 @@
* type: string
* title: cart_id
* description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -134,6 +144,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -13,6 +13,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -61,6 +71,16 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -95,6 +105,16 @@
* type: boolean
* title: is_return
* description: Whether the shipping option can be used for returns.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -13,6 +13,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -25,6 +35,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -21,6 +21,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -33,6 +43,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -22,6 +22,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -34,6 +44,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -23,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -37,6 +47,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -23,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -35,6 +45,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -29,6 +29,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -41,6 +51,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -23,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -35,6 +45,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -23,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -35,6 +45,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -20,6 +20,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -32,6 +42,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -29,6 +39,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -29,6 +39,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -17,6 +17,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -31,6 +41,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -23,6 +23,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -37,6 +47,16 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -22,6 +22,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -36,6 +46,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -20,6 +20,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -34,6 +44,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -20,6 +20,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -34,6 +44,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -21,6 +21,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -35,6 +45,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -16,6 +16,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -28,6 +38,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -31,6 +31,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - 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
@@ -43,6 +53,16 @@
* fields. without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -13,6 +13,26 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json:
@@ -19,6 +19,16 @@
* type: string
* externalDocs:
* url: https://docs.medusajs.com/api/store#publishable-api-key
* - name: Content-Language
* in: header
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* - name: fields
* in: query
* description: |-
@@ -33,6 +43,16 @@
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: locale
* in: query
* description: The locale in BCP 47 format to retrieve localized content.
* required: false
* schema:
* type: string
* example: en-US
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
* description: Learn more in the Serve Translations in Storefront guide.
* requestBody:
* content:
* application/json: