docs: generate API reference for 2.12.3 (#14341)

This commit is contained in:
Shahed Nasser
2025-12-17 18:19:46 +02:00
committed by GitHub
parent c0ec54fc15
commit 52e965f411
134 changed files with 7706 additions and 12 deletions
@@ -12,6 +12,17 @@ post:
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: >-
@@ -30,6 +41,17 @@ post:
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,17 @@ get:
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: >-
@@ -38,6 +49,17 @@ get:
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
@@ -94,6 +116,17 @@ post:
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: >-
@@ -112,6 +145,17 @@ post:
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,17 @@ post:
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: >-
@@ -40,6 +51,17 @@ post:
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
@@ -26,6 +26,17 @@ post:
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: >-
@@ -46,6 +57,17 @@ post:
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,17 @@ post:
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: >-
@@ -41,6 +52,17 @@ post:
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,17 @@ post:
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: >-
@@ -47,6 +58,17 @@ post:
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:
@@ -147,6 +169,17 @@ delete:
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: >-
@@ -165,6 +198,17 @@ delete:
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,17 @@ post:
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: >-
@@ -41,6 +52,17 @@ post:
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:
@@ -98,6 +120,17 @@ delete:
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: >-
@@ -116,6 +149,17 @@ delete:
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
@@ -25,6 +25,17 @@ post:
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: >-
@@ -43,6 +54,17 @@ post:
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:
@@ -19,6 +19,17 @@ post:
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 +48,17 @@ post:
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
@@ -18,6 +18,17 @@ get:
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: >-
@@ -693,6 +704,17 @@ get:
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
@@ -24,6 +24,17 @@ get:
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: >-
@@ -42,6 +53,17 @@ get:
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
@@ -14,6 +14,17 @@ get:
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: >-
@@ -123,6 +134,17 @@ get:
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
@@ -20,6 +20,17 @@ get:
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: >-
@@ -38,6 +49,17 @@ get:
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,17 @@ post:
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: >-
@@ -41,6 +52,17 @@ post:
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:
@@ -19,6 +19,17 @@ get:
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: >-
@@ -45,6 +56,17 @@ get:
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: []
@@ -96,6 +118,17 @@ post:
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: >-
@@ -118,6 +151,17 @@ post:
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: []
@@ -20,6 +20,17 @@ get:
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.
@@ -129,6 +140,17 @@ get:
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: []
@@ -181,6 +203,17 @@ post:
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: >-
@@ -207,6 +240,17 @@ post:
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: []
@@ -21,6 +21,17 @@ get:
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: >-
@@ -47,6 +58,17 @@ get:
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: []
@@ -106,6 +128,17 @@ post:
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: >-
@@ -132,6 +165,17 @@ post:
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: []
@@ -199,6 +243,17 @@ delete:
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: >-
@@ -225,6 +280,17 @@ delete:
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,73 @@
get:
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:
$ref: ../code_samples/JavaScript/store_locales/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/store_locales/get.sh
tags:
- Locales
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/StoreLocaleListResponse.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.3
x-featureFlag: translation
@@ -15,6 +15,17 @@ get:
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: >-
@@ -141,6 +152,17 @@ get:
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
@@ -20,6 +20,17 @@ get:
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: >-
@@ -38,6 +49,17 @@ get:
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
@@ -26,6 +26,17 @@ post:
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: >-
@@ -46,6 +57,17 @@ post:
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,17 @@ post:
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: >-
@@ -43,6 +54,17 @@ post:
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,17 @@ post:
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: >-
@@ -42,6 +53,17 @@ post:
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,17 @@ post:
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: >-
@@ -43,6 +54,17 @@ post:
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:
@@ -18,6 +18,17 @@ post:
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 +47,17 @@ post:
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:
@@ -43,6 +43,17 @@ post:
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: >-
@@ -61,6 +72,17 @@ post:
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:
@@ -18,6 +18,17 @@ get:
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: >-
@@ -87,6 +98,17 @@ get:
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,17 @@ get:
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: >-
@@ -760,6 +771,17 @@ get:
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
@@ -24,6 +24,17 @@ get:
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: >-
@@ -82,6 +93,17 @@ get:
`*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
@@ -14,6 +14,17 @@ get:
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: >-
@@ -679,6 +690,17 @@ get:
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
@@ -20,6 +20,17 @@ get:
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: >-
@@ -40,6 +51,17 @@ get:
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
@@ -14,6 +14,17 @@ get:
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: |-
@@ -676,6 +687,17 @@ get:
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
@@ -20,6 +20,17 @@ get:
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 +48,17 @@ get:
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
@@ -1,9 +1,22 @@
get:
operationId: GetProducts
summary: List Products
description: >-
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
@@ -17,6 +30,17 @@ get:
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: >-
@@ -840,6 +864,17 @@ get:
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
@@ -1,9 +1,22 @@
get:
operationId: GetProductsId
summary: Get a Product
description: >-
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
@@ -23,6 +36,17 @@ get:
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: >-
@@ -101,6 +125,17 @@ get:
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
@@ -17,6 +17,17 @@ get:
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: >-
@@ -156,6 +167,17 @@ get:
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
@@ -20,6 +20,17 @@ get:
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: >-
@@ -38,6 +49,17 @@ get:
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
@@ -14,6 +14,17 @@ get:
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: >-
@@ -73,6 +84,17 @@ get:
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
@@ -20,6 +20,17 @@ get:
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: >-
@@ -38,6 +49,17 @@ get:
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
@@ -14,6 +14,28 @@ post:
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:
@@ -21,6 +21,17 @@ get:
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: >-
@@ -116,6 +127,17 @@ get:
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
@@ -18,6 +18,17 @@ post:
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: >-
@@ -38,6 +49,17 @@ post:
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: