docs: generate API reference for 2.12.3 (#14341)
This commit is contained in:
Shahed Nasser
GitHub
@@ -0,0 +1,14 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.locale.list()
|
||||
.then(({ locales, count, limit, offset }) => {
|
||||
console.log(locales)
|
||||
})
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.locale.retrieve("en-US")
|
||||
.then(({ locale }) => {
|
||||
console.log(locale)
|
||||
})
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.order.export()
|
||||
.then(({ transaction_id }) => {
|
||||
console.log(transaction_id)
|
||||
})
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.priceList.prices("plist_123")
|
||||
.then(({ prices }) => {
|
||||
console.log(prices)
|
||||
})
|
||||
@@ -0,0 +1,14 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.translation.list()
|
||||
.then(({ translations, count, limit, offset }) => {
|
||||
console.log(translations)
|
||||
})
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.translation.batch({
|
||||
create: [
|
||||
{
|
||||
reference_id: "prod_123",
|
||||
reference: "product",
|
||||
locale_code: "en-US",
|
||||
translations: { title: "Shirt" }
|
||||
}
|
||||
],
|
||||
update: [
|
||||
{
|
||||
id: "trans_123",
|
||||
translations: { title: "Pants" }
|
||||
}
|
||||
],
|
||||
delete: ["trans_321"]
|
||||
})
|
||||
.then(({ created, updated, deleted }) => {
|
||||
console.log(created, updated, deleted)
|
||||
})
|
||||
```
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.translation.settings({
|
||||
entity_type: "product"
|
||||
})
|
||||
.then(({ translatable_fields }) => {
|
||||
console.log(translatable_fields)
|
||||
})
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
import Medusa from "@medusajs/js-sdk"
|
||||
|
||||
export const sdk = new Medusa({
|
||||
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
debug: import.meta.env.DEV,
|
||||
auth: {
|
||||
type: "session",
|
||||
},
|
||||
})
|
||||
|
||||
sdk.admin.translation.statistics({
|
||||
entity_type: "product"
|
||||
})
|
||||
.then(({ statistics }) => {
|
||||
console.log(statistics)
|
||||
})
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/locales' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/locales/fr-FR' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl -X POST '{backend_url}/admin/orders/export' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/price-lists/{id}/prices' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/translations' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
curl -X POST '{backend_url}/admin/translations/batch' \
|
||||
-H 'Authorization: Bearer {access_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-d '{
|
||||
"create": [
|
||||
{
|
||||
"reference": "product",
|
||||
"reference_id": "prod_123",
|
||||
"locale_code": "fr-FR",
|
||||
"translations": {
|
||||
"title": "Chaussures",
|
||||
"description": "Des chaussures élégantes."
|
||||
}
|
||||
}
|
||||
]
|
||||
}'
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/translations/settings' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/admin/translations/statistics' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
@@ -48,3 +48,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
translations:
|
||||
type: array
|
||||
description: The collection's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: The details of the order export.
|
||||
x-schemaName: AdminExportOrderResponse
|
||||
required:
|
||||
- transaction_id
|
||||
properties:
|
||||
transaction_id:
|
||||
type: string
|
||||
title: transaction_id
|
||||
description: >-
|
||||
The ID of the workflow execution's transaction. Use it to check the status
|
||||
of the export by sending a GET request to
|
||||
`/admin/workflows-executions/export-orders/:transaction-id`
|
||||
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
description: The locale's details.
|
||||
x-schemaName: AdminLocale
|
||||
required:
|
||||
- code
|
||||
- name
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The locale's code in BCP 47 format.
|
||||
example: fr-FR
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The locale's display name.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date and time at which the locale was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date and time at which the locale was last updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date and time at which the locale was deleted.
|
||||
@@ -0,0 +1,33 @@
|
||||
type: object
|
||||
description: The list of locales with pagination details.
|
||||
x-schemaName: AdminLocaleListResponse
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
- locales
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The maximum number of locales returned.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of locales skipped before retrieving the returned locales.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The total number of locales matching the query.
|
||||
estimate_count:
|
||||
type: number
|
||||
title: estimate_count
|
||||
description: >-
|
||||
The estimated count retrieved from the PostgreSQL query planner, which may
|
||||
be inaccurate.
|
||||
x-featureFlag: index_engine
|
||||
locales:
|
||||
type: array
|
||||
description: The list of locales.
|
||||
items:
|
||||
$ref: ./AdminLocale.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: The locale's details.
|
||||
x-schemaName: AdminLocaleResponse
|
||||
required:
|
||||
- locale
|
||||
properties:
|
||||
locale:
|
||||
$ref: ./AdminLocale.yaml
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
type: object
|
||||
description: The list of prices.
|
||||
x-schemaName: AdminPriceListPriceListResponse
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
- prices
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The maximum number of prices returned.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items skipped before retrieving the prices.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The total number of prices.
|
||||
estimate_count:
|
||||
type: number
|
||||
title: estimate_count
|
||||
description: >-
|
||||
The estimated count retrieved from the PostgreSQL query planner, which may
|
||||
be inaccurate.
|
||||
x-featureFlag: index_engine
|
||||
prices:
|
||||
type: array
|
||||
description: The list of prices.
|
||||
items:
|
||||
$ref: ./AdminPrice.yaml
|
||||
@@ -171,3 +171,8 @@ properties:
|
||||
description: The date the product was deleted.
|
||||
shipping_profile:
|
||||
$ref: ./AdminShippingProfile.yaml
|
||||
translations:
|
||||
type: array
|
||||
description: The product's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -36,3 +36,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
translations:
|
||||
type: array
|
||||
description: The tag's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -36,3 +36,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
translations:
|
||||
type: array
|
||||
description: The type's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -155,3 +155,8 @@ properties:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The variant's thumbnail.
|
||||
translations:
|
||||
type: array
|
||||
description: The variant's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -5,6 +5,7 @@ required:
|
||||
- id
|
||||
- name
|
||||
- supported_currencies
|
||||
- supported_locales
|
||||
- default_sales_channel_id
|
||||
- default_region_id
|
||||
- default_location_id
|
||||
@@ -53,3 +54,8 @@ properties:
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the store was updated.
|
||||
supported_locales:
|
||||
type: array
|
||||
description: The store's supported locales.
|
||||
items:
|
||||
$ref: ./AdminStoreLocale.yaml
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
type: object
|
||||
description: The details of a store's locale.
|
||||
x-schemaName: AdminStoreLocale
|
||||
required:
|
||||
- id
|
||||
- locale_code
|
||||
- store_id
|
||||
- locale
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The locale's ID.
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: The locale's code in BCP 47 format.
|
||||
store_id:
|
||||
type: string
|
||||
title: store_id
|
||||
description: The ID of the store to which the locale belongs.
|
||||
locale:
|
||||
$ref: ./AdminLocale.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date the locale was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the locale was updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date the locale was deleted.
|
||||
@@ -0,0 +1,57 @@
|
||||
type: object
|
||||
description: The translation's details.
|
||||
x-schemaName: AdminTranslation
|
||||
required:
|
||||
- id
|
||||
- reference_id
|
||||
- reference
|
||||
- locale_code
|
||||
- translations
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The translation's ID.
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: >-
|
||||
The ID of the resource that the translation belongs to. For example, the
|
||||
ID of a product.
|
||||
example: prod_123
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The resource that the translation belongs to.
|
||||
example: product
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: The translation's locale code in BCP 47 format.
|
||||
example: fr-FR
|
||||
translations:
|
||||
type: object
|
||||
description: >-
|
||||
The translation key-value pairs. Each key is a field in the resource, and
|
||||
the value is the translated text.
|
||||
example:
|
||||
title: Chaussures
|
||||
description: Des chaussures élégantes.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date that the translation was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date that the translation was updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date that the translation was deleted.
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
type: object
|
||||
description: The translation settings' details.
|
||||
x-schemaName: AdminTranslationSettingsResponse
|
||||
required:
|
||||
- translatable_fields
|
||||
properties:
|
||||
translatable_fields:
|
||||
type: object
|
||||
description: >-
|
||||
Key-value pairs of translatable fields for different entities. Each key is
|
||||
an entity type, and the value is an array of fields that can be translated
|
||||
for that entity.
|
||||
example:
|
||||
product:
|
||||
- title
|
||||
- description
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
type: object
|
||||
description: The translation statistics details.
|
||||
x-schemaName: AdminTranslationStatisticsResponse
|
||||
required:
|
||||
- statistics
|
||||
properties:
|
||||
statistics:
|
||||
type: object
|
||||
description: >-
|
||||
The translation statistics for different entity types. The key is the
|
||||
entity type, and the value is an object containing the statistics for that
|
||||
entity type.
|
||||
example:
|
||||
product:
|
||||
expected: 150
|
||||
translated: 120
|
||||
missing: 30
|
||||
by_locale:
|
||||
fr-FR:
|
||||
expected: 150
|
||||
translated: 120
|
||||
missing: 30
|
||||
required:
|
||||
- by_locale
|
||||
- expected
|
||||
- translated
|
||||
- missing
|
||||
additionalProperties:
|
||||
type: object
|
||||
properties:
|
||||
by_locale:
|
||||
type: object
|
||||
description: >-
|
||||
The translation statistics of an entity type broken down by locale.
|
||||
The key is the locale code in BCP 47 format, and the value is an
|
||||
object containing the statistics for that locale.
|
||||
example:
|
||||
fr-FR:
|
||||
expected: 150
|
||||
translated: 120
|
||||
missing: 30
|
||||
required:
|
||||
- expected
|
||||
- translated
|
||||
- missing
|
||||
additionalProperties:
|
||||
type: object
|
||||
properties:
|
||||
expected:
|
||||
type: number
|
||||
title: expected
|
||||
description: The total number of translatable fields.
|
||||
translated:
|
||||
type: number
|
||||
title: translated
|
||||
description: The number of translated fields.
|
||||
missing:
|
||||
type: number
|
||||
title: missing
|
||||
description: The number of fields that are yet to be translated.
|
||||
expected:
|
||||
type: number
|
||||
title: expected
|
||||
description: The total number of translatable fields across specified locales.
|
||||
translated:
|
||||
type: number
|
||||
title: translated
|
||||
description: The number of translated fields across specified locales.
|
||||
missing:
|
||||
type: number
|
||||
title: missing
|
||||
description: >-
|
||||
The number of fields that are yet to be translated across specified
|
||||
locales.
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
type: object
|
||||
description: The batch response for managing translations.
|
||||
x-schemaName: AdminTranslationsBatchResponse
|
||||
required:
|
||||
- created
|
||||
- updated
|
||||
- deleted
|
||||
properties:
|
||||
created:
|
||||
type: array
|
||||
description: The created translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
updated:
|
||||
type: array
|
||||
description: The updated translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: Summary of the deleted translations.
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
description: The IDs of the deleted translations.
|
||||
items:
|
||||
type: string
|
||||
title: ids
|
||||
description: A translation ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The type of object deleted.
|
||||
default: translation
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: Whether the translations were successfully deleted.
|
||||
@@ -17,3 +17,11 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
locale:
|
||||
type: string
|
||||
title: locale
|
||||
description: >-
|
||||
The order's locale in [BCP
|
||||
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
|
||||
format.
|
||||
example: en-US
|
||||
|
||||
@@ -29,3 +29,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
supported_locales:
|
||||
type: array
|
||||
description: The store's supported locales.
|
||||
items:
|
||||
$ref: ./AdminUpdateStoreSupportedLocale.yaml
|
||||
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: The payload to update a store's supported locale.
|
||||
x-schemaName: AdminUpdateStoreSupportedLocale
|
||||
required:
|
||||
- locale_code
|
||||
properties:
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: >-
|
||||
The locale's code in [BCP 47
|
||||
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
|
||||
example: fr-FR
|
||||
@@ -328,3 +328,11 @@ properties:
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
|
||||
locale:
|
||||
type: string
|
||||
title: locale
|
||||
description: >-
|
||||
The order's locale in [BCP
|
||||
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
|
||||
format.
|
||||
example: en-US
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
description: The store locale's details.
|
||||
x-schemaName: StoreLocale
|
||||
required:
|
||||
- code
|
||||
- name
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: >-
|
||||
The locale's code in [BCP 47
|
||||
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
|
||||
example: en-US
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The locale's display name.
|
||||
example: English (United States)
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: The list of supported locales in the store.
|
||||
x-schemaName: StoreLocaleListResponse
|
||||
required:
|
||||
- locales
|
||||
properties:
|
||||
locales:
|
||||
type: array
|
||||
description: The list of supported locales in the store.
|
||||
items:
|
||||
$ref: ./StoreLocale.yaml
|
||||
File diff suppressed because it is too large
Load Diff
@@ -231,6 +231,19 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/commerce-modules/user
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminInvite.yaml
|
||||
- name: Locales
|
||||
description: >
|
||||
A locale is a language that content is translated into for customers to
|
||||
view in a storefront.
|
||||
|
||||
Medusa installs locales by default. These API routes allow admin users to
|
||||
retrieve and view locales.
|
||||
externalDocs:
|
||||
description: Learn more about locales and translations.
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/translation/concepts
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminLocale.yaml
|
||||
- name: Notifications
|
||||
description: >
|
||||
A notification informs an admin user of store changes or status changes of
|
||||
@@ -708,6 +721,18 @@ tags:
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminTransactionGroup.yaml
|
||||
- name: Translations
|
||||
description: >
|
||||
A translation is a localized version of content in a specific locale. For
|
||||
example, a product description in French.
|
||||
|
||||
These API routes allow admin users to manage translations for different
|
||||
locales and resources.
|
||||
externalDocs:
|
||||
description: Learn more about the Translation Module.
|
||||
url: https://docs.medusajs.com/resources/commerce-modules/translation
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminTranslation.yaml
|
||||
- name: Uploads
|
||||
description: >
|
||||
Use these API routes to upload files to your Medusa application using the
|
||||
@@ -918,6 +943,10 @@ paths:
|
||||
$ref: paths/admin_invites_{id}.yaml
|
||||
/admin/invites/{id}/resend:
|
||||
$ref: paths/admin_invites_{id}_resend.yaml
|
||||
/admin/locales:
|
||||
$ref: paths/admin_locales.yaml
|
||||
/admin/locales/{code}:
|
||||
$ref: paths/admin_locales_{code}.yaml
|
||||
/admin/notifications:
|
||||
$ref: paths/admin_notifications.yaml
|
||||
/admin/notifications/{id}:
|
||||
@@ -944,6 +973,8 @@ paths:
|
||||
$ref: paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml
|
||||
/admin/orders:
|
||||
$ref: paths/admin_orders.yaml
|
||||
/admin/orders/export:
|
||||
$ref: paths/admin_orders_export.yaml
|
||||
/admin/orders/{id}:
|
||||
$ref: paths/admin_orders_{id}.yaml
|
||||
/admin/orders/{id}/archive:
|
||||
@@ -997,6 +1028,8 @@ paths:
|
||||
$ref: paths/admin_price-lists.yaml
|
||||
/admin/price-lists/{id}:
|
||||
$ref: paths/admin_price-lists_{id}.yaml
|
||||
/admin/price-lists/{id}/prices:
|
||||
$ref: paths/admin_price-lists_{id}_prices.yaml
|
||||
/admin/price-lists/{id}/prices/batch:
|
||||
$ref: paths/admin_price-lists_{id}_prices_batch.yaml
|
||||
/admin/price-lists/{id}/products:
|
||||
@@ -1175,6 +1208,14 @@ paths:
|
||||
$ref: paths/admin_tax-regions_{id}.yaml
|
||||
/admin/transaction-groups:
|
||||
$ref: paths/admin_transaction-groups.yaml
|
||||
/admin/translations:
|
||||
$ref: paths/admin_translations.yaml
|
||||
/admin/translations/batch:
|
||||
$ref: paths/admin_translations_batch.yaml
|
||||
/admin/translations/settings:
|
||||
$ref: paths/admin_translations_settings.yaml
|
||||
/admin/translations/statistics:
|
||||
$ref: paths/admin_translations_statistics.yaml
|
||||
/admin/uploads:
|
||||
$ref: paths/admin_uploads.yaml
|
||||
/admin/uploads/presigned-urls:
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
get:
|
||||
operationId: GetLocales
|
||||
summary: List Locales
|
||||
description: >-
|
||||
Retrieve a list of locales. The locales can be filtered by fields such as
|
||||
`code`. The locales can also be sorted or paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: q
|
||||
in: query
|
||||
description: Search query to filter locales by code or other fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: Search query to filter locales by code or other fields.
|
||||
- name: code
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: code
|
||||
description: Filter locales by a code.
|
||||
- type: array
|
||||
description: Filter locales by multiple codes.
|
||||
items:
|
||||
type: string
|
||||
title: code
|
||||
description: A locale code.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: with_deleted
|
||||
in: query
|
||||
description: The locale's with deleted.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: with_deleted
|
||||
description: The locale's with deleted.
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data. If
|
||||
a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields. Without prefix it will
|
||||
replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
- name: $and
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is the
|
||||
same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_locales/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_locales/get.sh
|
||||
tags:
|
||||
- Locales
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminLocaleListResponse.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
|
||||
@@ -0,0 +1,72 @@
|
||||
get:
|
||||
operationId: GetLocalesCode
|
||||
summary: Get a Locale
|
||||
x-sidebar-summary: Get Locale
|
||||
description: >-
|
||||
Retrieve a locale by its code. You can expand the locale's relations or
|
||||
select the fields that should be returned.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: code
|
||||
in: path
|
||||
description: >-
|
||||
The locale's code in [BCP 47
|
||||
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
|
||||
example: fr-FR
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data. If
|
||||
a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields. Without prefix it will
|
||||
replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_locales_{code}/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_locales_{code}/get.sh
|
||||
tags:
|
||||
- Locales
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminLocaleResponse.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
|
||||
@@ -0,0 +1,528 @@
|
||||
post:
|
||||
operationId: PostOrdersExport
|
||||
summary: Export Orders
|
||||
description: >
|
||||
Start an order export process to retrieve a CSV of exported orders.
|
||||
|
||||
|
||||
You'll receive in the response the transaction ID of the workflow generating
|
||||
the CSV file. To check the status of the execution, send a GET request to
|
||||
`/admin/workflows-executions/export-orders/:transaction-id`.
|
||||
|
||||
|
||||
Once the execution finishes successfully, a notification is created for the
|
||||
export. You can retrieve the notifications using the `/admin/notification`
|
||||
API route to retrieve the file's download URL.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The ID of the order to export.
|
||||
- type: array
|
||||
description: The IDs of the orders to export.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: An order ID.
|
||||
- name: sales_channel_id
|
||||
in: query
|
||||
description: The IDs of the sales channels to export their orders.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The IDs of the sales channels to export their orders.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: A sales channel ID.
|
||||
- name: region_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: region_id
|
||||
description: The ID of a region to export orders in it.
|
||||
- type: array
|
||||
description: The IDs of regions to export their orders.
|
||||
items:
|
||||
type: string
|
||||
title: region_id
|
||||
description: A region ID.
|
||||
- name: customer_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: customer_id
|
||||
description: The ID of a customer to export their orders.
|
||||
- type: array
|
||||
description: The IDs of customers to export their orders.
|
||||
items:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: A customer ID.
|
||||
- name: q
|
||||
in: query
|
||||
description: A search query to filter exported orders by.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: A search query to filter exported orders by.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: Filter by an order's creation date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: Filter by an order's creation date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content
|
||||
is the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
$or:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content
|
||||
is the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
$eq:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
- type: array
|
||||
description: Filter by an exact match.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not equal to this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: Filter by values in this array.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: Filter by values not in this array.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: object
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
$gt:
|
||||
type: string
|
||||
title: $gt
|
||||
description: >-
|
||||
Filter by values greater than this parameter. Useful for numbers
|
||||
and dates only.
|
||||
$gte:
|
||||
type: string
|
||||
title: $gte
|
||||
description: >-
|
||||
Filter by values greater than or equal to this parameter. Useful
|
||||
for numbers and dates only.
|
||||
$lt:
|
||||
type: string
|
||||
title: $lt
|
||||
description: >-
|
||||
Filter by values less than this parameter. Useful for numbers and
|
||||
dates only.
|
||||
$lte:
|
||||
type: string
|
||||
title: $lte
|
||||
description: >-
|
||||
Filter by values less than or equal to this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$like:
|
||||
type: string
|
||||
title: $like
|
||||
description: Apply a `like` filter. Useful for strings only.
|
||||
$re:
|
||||
type: string
|
||||
title: $re
|
||||
description: Apply a regex filter. Useful for strings only.
|
||||
$ilike:
|
||||
type: string
|
||||
title: $ilike
|
||||
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
$fulltext:
|
||||
type: string
|
||||
title: $fulltext
|
||||
description: Filter to apply on full-text properties.
|
||||
$overlap:
|
||||
type: array
|
||||
description: Filter arrays that have overlapping values with this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $overlap
|
||||
description: Filter arrays that have overlapping values with this parameter.
|
||||
$contains:
|
||||
type: array
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: Filter by an order's update date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: Filter by an order's update date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content
|
||||
is the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
$or:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content
|
||||
is the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
$eq:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
- type: array
|
||||
description: Filter by an exact match.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not equal to this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: Filter by values in this array.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: Filter by values not in this array.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: object
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
$gt:
|
||||
type: string
|
||||
title: $gt
|
||||
description: >-
|
||||
Filter by values greater than this parameter. Useful for numbers
|
||||
and dates only.
|
||||
$gte:
|
||||
type: string
|
||||
title: $gte
|
||||
description: >-
|
||||
Filter by values greater than or equal to this parameter. Useful
|
||||
for numbers and dates only.
|
||||
$lt:
|
||||
type: string
|
||||
title: $lt
|
||||
description: >-
|
||||
Filter by values less than this parameter. Useful for numbers and
|
||||
dates only.
|
||||
$lte:
|
||||
type: string
|
||||
title: $lte
|
||||
description: >-
|
||||
Filter by values less than or equal to this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$like:
|
||||
type: string
|
||||
title: $like
|
||||
description: Apply a `like` filter. Useful for strings only.
|
||||
$re:
|
||||
type: string
|
||||
title: $re
|
||||
description: Apply a regex filter. Useful for strings only.
|
||||
$ilike:
|
||||
type: string
|
||||
title: $ilike
|
||||
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
$fulltext:
|
||||
type: string
|
||||
title: $fulltext
|
||||
description: Filter to apply on full-text properties.
|
||||
$overlap:
|
||||
type: array
|
||||
description: Filter arrays that have overlapping values with this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $overlap
|
||||
description: Filter arrays that have overlapping values with this parameter.
|
||||
$contains:
|
||||
type: array
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contains
|
||||
description: Filter arrays that contain some of the values of this parameter.
|
||||
$contained:
|
||||
type: array
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $contained
|
||||
description: Filter arrays that contain all values of this parameter.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: with_deleted
|
||||
in: query
|
||||
description: Whether to include deleted orders in the export.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: with_deleted
|
||||
description: Whether to include deleted orders in the export.
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data. If
|
||||
a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields. Without prefix it will
|
||||
replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
- name: status
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: status
|
||||
description: The status of the orders to export.
|
||||
enum:
|
||||
- canceled
|
||||
- completed
|
||||
- pending
|
||||
- draft
|
||||
- archived
|
||||
- requires_action
|
||||
- type: array
|
||||
description: The statuses of the orders to export.
|
||||
items:
|
||||
type: string
|
||||
description: The order status.
|
||||
enum:
|
||||
- canceled
|
||||
- completed
|
||||
- pending
|
||||
- draft
|
||||
- archived
|
||||
- requires_action
|
||||
- type: object
|
||||
description: The order's status.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's
|
||||
content is the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
$or:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's
|
||||
content is the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
- name: $and
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is the
|
||||
same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_orders_export/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_orders_export/post.sh
|
||||
tags:
|
||||
- Orders
|
||||
responses:
|
||||
'202':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminExportOrderResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: exportOrdersWorkflow
|
||||
x-events: []
|
||||
x-since: 2.12.3
|
||||
@@ -0,0 +1,66 @@
|
||||
get:
|
||||
operationId: GetPriceListsIdPrices
|
||||
summary: List Prices in a Price List
|
||||
x-sidebar-summary: List Prices
|
||||
description: Retrieve a list of prices in a price list. The prices can also be paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The ID of the price list to retrieve prices from.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data. If
|
||||
a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields. Without prefix it will
|
||||
replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_price-lists_{id}_prices/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_price-lists_{id}_prices/get.sh
|
||||
tags:
|
||||
- Price Lists
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPriceListPriceListResponse.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
|
||||
@@ -0,0 +1,228 @@
|
||||
get:
|
||||
operationId: GetTranslations
|
||||
summary: List Translations
|
||||
description: >-
|
||||
Retrieve a list of translations. The translations can be filtered by fields
|
||||
such as `reference_id` (For example, the ID of a product). The translations
|
||||
can also be sorted or paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: q
|
||||
in: query
|
||||
description: Search query to filter translations by their fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: Search query to filter translations by their fields.
|
||||
- name: reference_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: reference_id
|
||||
description: >-
|
||||
Filter translations by a reference ID. For example, the ID of a
|
||||
product.
|
||||
example: prod_123
|
||||
- type: array
|
||||
description: >-
|
||||
Filter translations by multiple reference IDs. For example, the
|
||||
IDs of products.
|
||||
items:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: The reference ID's details. For example, the ID of a product.
|
||||
example: prod_123
|
||||
- name: reference
|
||||
in: query
|
||||
description: >-
|
||||
Filter translations by the resource they belong to. For example,
|
||||
`product` or `product_variant`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: reference
|
||||
description: >-
|
||||
Filter translations by the resource they belong to. For example,
|
||||
`product` or `product_variant`.
|
||||
- name: locale_code
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: locale_code
|
||||
description: Filter translations by a locale code in BCP 47 format.
|
||||
example: fr-FR
|
||||
- type: array
|
||||
description: Filter translations by multiple locale codes in BCP 47 format.
|
||||
items:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: A locale code in BCP 47 format.
|
||||
example: fr-FR
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
externalDocs:
|
||||
url: '#pagination'
|
||||
- name: with_deleted
|
||||
in: query
|
||||
description: The translation's with deleted.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: with_deleted
|
||||
description: The translation's with deleted.
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data. If
|
||||
a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields. Without prefix it will
|
||||
replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: >-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
If a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. Without
|
||||
prefix it will replace the entire default fields.
|
||||
externalDocs:
|
||||
url: '#select-fields-and-relations'
|
||||
- name: $and
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an AND condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is the
|
||||
same type as the expected query parameters.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: >-
|
||||
Join query parameters with an OR condition. Each object's content is
|
||||
the same type as the expected query parameters.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_translations/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_translations/get.sh
|
||||
tags:
|
||||
- Translations
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: The list of translations with pagination.
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The maximum number of translations returned.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: >-
|
||||
The number of translations skipped before retrieving the
|
||||
returned translations.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The total number of translations matching the query.
|
||||
estimate_count:
|
||||
type: number
|
||||
title: estimate_count
|
||||
description: >-
|
||||
The estimated count retrieved from the PostgreSQL query
|
||||
planner, which may be inaccurate.
|
||||
x-featureFlag: index_engine
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- translations
|
||||
properties:
|
||||
translations:
|
||||
type: array
|
||||
description: The list of translations.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminTranslation.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
|
||||
@@ -0,0 +1,165 @@
|
||||
post:
|
||||
operationId: PostTranslationsBatch
|
||||
summary: Manage Translations
|
||||
description: >-
|
||||
Manage translations in bulk by creating, updating, or deleting multiple
|
||||
translations in a single request. You can manage translations for various
|
||||
resources such as products, product variants, categories, and more.
|
||||
x-authenticated: true
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: The translations to be created, updated, or deleted in bulk.
|
||||
properties:
|
||||
create:
|
||||
type: array
|
||||
description: The translations to create.
|
||||
items:
|
||||
type: object
|
||||
description: The translation's details.
|
||||
required:
|
||||
- reference
|
||||
- reference_id
|
||||
- locale_code
|
||||
- translations
|
||||
properties:
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The resource that the translation belongs to.
|
||||
example: product
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: >-
|
||||
The ID of the resource that the translation belongs to.
|
||||
For example, the ID of a product.
|
||||
example: prod_123
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: The translation's locale code in BCP 47 format.
|
||||
example: fr-FR
|
||||
translations:
|
||||
type: object
|
||||
description: >-
|
||||
The translation key-value pairs. Each key is a field in
|
||||
the resource, and the value is the translated text.
|
||||
example:
|
||||
title: Chaussures
|
||||
description: Des chaussures élégantes.
|
||||
update:
|
||||
type: array
|
||||
description: The translations to update.
|
||||
items:
|
||||
type: object
|
||||
description: The data for updating a translation.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of the translation to update.
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The resource that the translation belongs to.
|
||||
example: product
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: >-
|
||||
The ID of the resource that the translation belongs to.
|
||||
For example, the ID of a product.
|
||||
example: prod_123
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: The translation's locale code in BCP 47 format.
|
||||
example: fr-FR
|
||||
translations:
|
||||
type: object
|
||||
description: >-
|
||||
The translation key-value pairs. Each key is a field in
|
||||
the resource, and the value is the translated text.
|
||||
example:
|
||||
title: Chaussures Modifiées
|
||||
description: Des chaussures élégantes et modifiées.
|
||||
delete:
|
||||
type: array
|
||||
description: The translations to delete.
|
||||
items:
|
||||
type: string
|
||||
title: delete
|
||||
description: The ID of a translation to delete.
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_translations_batch/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_translations_batch/post.sh
|
||||
tags:
|
||||
- Translations
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminTranslationsBatchResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: batchTranslationsWorkflow
|
||||
x-events:
|
||||
- name: translation.created
|
||||
payload: |-
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the translation
|
||||
}
|
||||
```
|
||||
description: Emitted when translations are created.
|
||||
deprecated: false
|
||||
since: 2.12.3
|
||||
- name: translation.updated
|
||||
payload: |-
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the translation
|
||||
}
|
||||
```
|
||||
description: Emitted when translations are updated.
|
||||
deprecated: false
|
||||
since: 2.12.3
|
||||
- name: translation.deleted
|
||||
payload: |-
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the translation
|
||||
}
|
||||
```
|
||||
description: Emitted when translations are deleted.
|
||||
deprecated: false
|
||||
since: 2.12.3
|
||||
x-since: 2.12.3
|
||||
x-featureFlag: translation
|
||||
@@ -0,0 +1,54 @@
|
||||
get:
|
||||
operationId: GetTranslationsSettings
|
||||
summary: List Translation Settings
|
||||
x-sidebar-summary: List Settings
|
||||
description: >-
|
||||
Retrieve the list of translatable fields for all entities, such as products
|
||||
and collections.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: entity_type
|
||||
in: query
|
||||
description: The entity to retrieve translation settings for.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: entity_type
|
||||
description: The entity to retrieve translation settings for.
|
||||
example: product
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_translations_settings/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_translations_settings/get.sh
|
||||
tags:
|
||||
- Translations
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminTranslationSettingsResponse.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
|
||||
@@ -0,0 +1,77 @@
|
||||
get:
|
||||
operationId: GetTranslationsStatistics
|
||||
summary: Retrieve Translation Statistics
|
||||
x-sidebar-summary: Get Statistics
|
||||
description: >-
|
||||
Get statistics on translations for specified locales and entity types. This
|
||||
includes overall translation progress for each entity type, and statistics
|
||||
for each locale within those entity types.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: locales
|
||||
in: query
|
||||
description: >-
|
||||
The locale codes to retrieve translation statistics for. Locale codes
|
||||
are in [BCP
|
||||
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
|
||||
format.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The locale codes to retrieve translation statistics for.
|
||||
items:
|
||||
type: string
|
||||
title: locales
|
||||
description: >-
|
||||
A locale code in [BCP
|
||||
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
|
||||
format.
|
||||
example: fr-FR
|
||||
- name: entity_types
|
||||
in: query
|
||||
description: The table names of entities to retrieve translation statistics for.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The table names of entities to retrieve translation statistics for.
|
||||
items:
|
||||
type: string
|
||||
title: entity_types
|
||||
description: The table name of an entity.
|
||||
example: products
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS SDK
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_translations_statistics/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_translations_statistics/get.sh
|
||||
tags:
|
||||
- Translations
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminTranslationStatisticsResponse.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
|
||||
@@ -0,0 +1,18 @@
|
||||
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)
|
||||
})
|
||||
@@ -0,0 +1,2 @@
|
||||
curl '{backend_url}/store/locales' \
|
||||
-H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||
@@ -48,3 +48,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
translations:
|
||||
type: array
|
||||
description: The collection's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: The details of the order export.
|
||||
x-schemaName: AdminExportOrderResponse
|
||||
required:
|
||||
- transaction_id
|
||||
properties:
|
||||
transaction_id:
|
||||
type: string
|
||||
title: transaction_id
|
||||
description: >-
|
||||
The ID of the workflow execution's transaction. Use it to check the status
|
||||
of the export by sending a GET request to
|
||||
`/admin/workflows-executions/export-orders/:transaction-id`
|
||||
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
description: The locale's details.
|
||||
x-schemaName: AdminLocale
|
||||
required:
|
||||
- code
|
||||
- name
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The locale's code in BCP 47 format.
|
||||
example: fr-FR
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The locale's display name.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date and time at which the locale was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date and time at which the locale was last updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date and time at which the locale was deleted.
|
||||
@@ -0,0 +1,33 @@
|
||||
type: object
|
||||
description: The list of locales with pagination details.
|
||||
x-schemaName: AdminLocaleListResponse
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
- locales
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The maximum number of locales returned.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of locales skipped before retrieving the returned locales.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The total number of locales matching the query.
|
||||
estimate_count:
|
||||
type: number
|
||||
title: estimate_count
|
||||
description: >-
|
||||
The estimated count retrieved from the PostgreSQL query planner, which may
|
||||
be inaccurate.
|
||||
x-featureFlag: index_engine
|
||||
locales:
|
||||
type: array
|
||||
description: The list of locales.
|
||||
items:
|
||||
$ref: ./AdminLocale.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: The locale's details.
|
||||
x-schemaName: AdminLocaleResponse
|
||||
required:
|
||||
- locale
|
||||
properties:
|
||||
locale:
|
||||
$ref: ./AdminLocale.yaml
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
type: object
|
||||
description: The list of prices.
|
||||
x-schemaName: AdminPriceListPriceListResponse
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
- prices
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The maximum number of prices returned.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items skipped before retrieving the prices.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The total number of prices.
|
||||
estimate_count:
|
||||
type: number
|
||||
title: estimate_count
|
||||
description: >-
|
||||
The estimated count retrieved from the PostgreSQL query planner, which may
|
||||
be inaccurate.
|
||||
x-featureFlag: index_engine
|
||||
prices:
|
||||
type: array
|
||||
description: The list of prices.
|
||||
items:
|
||||
$ref: ./AdminPrice.yaml
|
||||
@@ -171,3 +171,8 @@ properties:
|
||||
description: The date the product was deleted.
|
||||
shipping_profile:
|
||||
$ref: ./AdminShippingProfile.yaml
|
||||
translations:
|
||||
type: array
|
||||
description: The product's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -36,3 +36,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
translations:
|
||||
type: array
|
||||
description: The tag's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -36,3 +36,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
translations:
|
||||
type: array
|
||||
description: The type's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -155,3 +155,8 @@ properties:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The variant's thumbnail.
|
||||
translations:
|
||||
type: array
|
||||
description: The variant's translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
|
||||
@@ -5,6 +5,7 @@ required:
|
||||
- id
|
||||
- name
|
||||
- supported_currencies
|
||||
- supported_locales
|
||||
- default_sales_channel_id
|
||||
- default_region_id
|
||||
- default_location_id
|
||||
@@ -53,3 +54,8 @@ properties:
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the store was updated.
|
||||
supported_locales:
|
||||
type: array
|
||||
description: The store's supported locales.
|
||||
items:
|
||||
$ref: ./AdminStoreLocale.yaml
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
type: object
|
||||
description: The details of a store's locale.
|
||||
x-schemaName: AdminStoreLocale
|
||||
required:
|
||||
- id
|
||||
- locale_code
|
||||
- store_id
|
||||
- locale
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The locale's ID.
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: The locale's code in BCP 47 format.
|
||||
store_id:
|
||||
type: string
|
||||
title: store_id
|
||||
description: The ID of the store to which the locale belongs.
|
||||
locale:
|
||||
$ref: ./AdminLocale.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date the locale was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the locale was updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date the locale was deleted.
|
||||
@@ -0,0 +1,57 @@
|
||||
type: object
|
||||
description: The translation's details.
|
||||
x-schemaName: AdminTranslation
|
||||
required:
|
||||
- id
|
||||
- reference_id
|
||||
- reference
|
||||
- locale_code
|
||||
- translations
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The translation's ID.
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: >-
|
||||
The ID of the resource that the translation belongs to. For example, the
|
||||
ID of a product.
|
||||
example: prod_123
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The resource that the translation belongs to.
|
||||
example: product
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: The translation's locale code in BCP 47 format.
|
||||
example: fr-FR
|
||||
translations:
|
||||
type: object
|
||||
description: >-
|
||||
The translation key-value pairs. Each key is a field in the resource, and
|
||||
the value is the translated text.
|
||||
example:
|
||||
title: Chaussures
|
||||
description: Des chaussures élégantes.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The date that the translation was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date that the translation was updated.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The date that the translation was deleted.
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
type: object
|
||||
description: The translation settings' details.
|
||||
x-schemaName: AdminTranslationSettingsResponse
|
||||
required:
|
||||
- translatable_fields
|
||||
properties:
|
||||
translatable_fields:
|
||||
type: object
|
||||
description: >-
|
||||
Key-value pairs of translatable fields for different entities. Each key is
|
||||
an entity type, and the value is an array of fields that can be translated
|
||||
for that entity.
|
||||
example:
|
||||
product:
|
||||
- title
|
||||
- description
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
type: object
|
||||
description: The translation statistics details.
|
||||
x-schemaName: AdminTranslationStatisticsResponse
|
||||
required:
|
||||
- statistics
|
||||
properties:
|
||||
statistics:
|
||||
type: object
|
||||
description: >-
|
||||
The translation statistics for different entity types. The key is the
|
||||
entity type, and the value is an object containing the statistics for that
|
||||
entity type.
|
||||
example:
|
||||
product:
|
||||
expected: 150
|
||||
translated: 120
|
||||
missing: 30
|
||||
by_locale:
|
||||
fr-FR:
|
||||
expected: 150
|
||||
translated: 120
|
||||
missing: 30
|
||||
required:
|
||||
- by_locale
|
||||
- expected
|
||||
- translated
|
||||
- missing
|
||||
additionalProperties:
|
||||
type: object
|
||||
properties:
|
||||
by_locale:
|
||||
type: object
|
||||
description: >-
|
||||
The translation statistics of an entity type broken down by locale.
|
||||
The key is the locale code in BCP 47 format, and the value is an
|
||||
object containing the statistics for that locale.
|
||||
example:
|
||||
fr-FR:
|
||||
expected: 150
|
||||
translated: 120
|
||||
missing: 30
|
||||
required:
|
||||
- expected
|
||||
- translated
|
||||
- missing
|
||||
additionalProperties:
|
||||
type: object
|
||||
properties:
|
||||
expected:
|
||||
type: number
|
||||
title: expected
|
||||
description: The total number of translatable fields.
|
||||
translated:
|
||||
type: number
|
||||
title: translated
|
||||
description: The number of translated fields.
|
||||
missing:
|
||||
type: number
|
||||
title: missing
|
||||
description: The number of fields that are yet to be translated.
|
||||
expected:
|
||||
type: number
|
||||
title: expected
|
||||
description: The total number of translatable fields across specified locales.
|
||||
translated:
|
||||
type: number
|
||||
title: translated
|
||||
description: The number of translated fields across specified locales.
|
||||
missing:
|
||||
type: number
|
||||
title: missing
|
||||
description: >-
|
||||
The number of fields that are yet to be translated across specified
|
||||
locales.
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
type: object
|
||||
description: The batch response for managing translations.
|
||||
x-schemaName: AdminTranslationsBatchResponse
|
||||
required:
|
||||
- created
|
||||
- updated
|
||||
- deleted
|
||||
properties:
|
||||
created:
|
||||
type: array
|
||||
description: The created translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
updated:
|
||||
type: array
|
||||
description: The updated translations.
|
||||
items:
|
||||
$ref: ./AdminTranslation.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: Summary of the deleted translations.
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
description: The IDs of the deleted translations.
|
||||
items:
|
||||
type: string
|
||||
title: ids
|
||||
description: A translation ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The type of object deleted.
|
||||
default: translation
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: Whether the translations were successfully deleted.
|
||||
@@ -17,3 +17,11 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
locale:
|
||||
type: string
|
||||
title: locale
|
||||
description: >-
|
||||
The order's locale in [BCP
|
||||
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
|
||||
format.
|
||||
example: en-US
|
||||
|
||||
@@ -29,3 +29,8 @@ properties:
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
description: Learn how to manage metadata
|
||||
supported_locales:
|
||||
type: array
|
||||
description: The store's supported locales.
|
||||
items:
|
||||
$ref: ./AdminUpdateStoreSupportedLocale.yaml
|
||||
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: The payload to update a store's supported locale.
|
||||
x-schemaName: AdminUpdateStoreSupportedLocale
|
||||
required:
|
||||
- locale_code
|
||||
properties:
|
||||
locale_code:
|
||||
type: string
|
||||
title: locale_code
|
||||
description: >-
|
||||
The locale's code in [BCP 47
|
||||
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
|
||||
example: fr-FR
|
||||
@@ -328,3 +328,11 @@ properties:
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
|
||||
locale:
|
||||
type: string
|
||||
title: locale
|
||||
description: >-
|
||||
The order's locale in [BCP
|
||||
47](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)
|
||||
format.
|
||||
example: en-US
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
description: The store locale's details.
|
||||
x-schemaName: StoreLocale
|
||||
required:
|
||||
- code
|
||||
- name
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: >-
|
||||
The locale's code in [BCP 47
|
||||
format](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1).
|
||||
example: en-US
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The locale's display name.
|
||||
example: English (United States)
|
||||
@@ -0,0 +1,11 @@
|
||||
type: object
|
||||
description: The list of supported locales in the store.
|
||||
x-schemaName: StoreLocaleListResponse
|
||||
required:
|
||||
- locales
|
||||
properties:
|
||||
locales:
|
||||
type: array
|
||||
description: The list of supported locales in the store.
|
||||
items:
|
||||
$ref: ./StoreLocale.yaml
|
||||
File diff suppressed because it is too large
Load Diff
@@ -92,6 +92,19 @@ tags:
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/StoreGiftCard.yaml
|
||||
- name: Locales
|
||||
description: >
|
||||
A locale is a language that content is translated into for customers to
|
||||
view in a storefront.
|
||||
|
||||
Medusa installs locales by default. These API routes allow you to retrieve
|
||||
supported locales in the store.
|
||||
externalDocs:
|
||||
description: Learn more about locales and translations.
|
||||
url: >-
|
||||
https://docs.medusajs.com/resources/commerce-modules/translation/concepts
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/StoreLocale.yaml
|
||||
- name: Orders
|
||||
description: |
|
||||
Guest and registered customers can view orders they placed.
|
||||
@@ -286,6 +299,8 @@ paths:
|
||||
$ref: paths/store_gift-cards_{idOrCode}.yaml
|
||||
/store/gift-cards/{idOrCode}/redeem:
|
||||
$ref: paths/store_gift-cards_{idOrCode}_redeem.yaml
|
||||
/store/locales:
|
||||
$ref: paths/store_locales.yaml
|
||||
/store/orders:
|
||||
$ref: paths/store_orders.yaml
|
||||
/store/orders/{id}:
|
||||
|
||||
@@ -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: []
|
||||
|
||||
+66
@@ -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:
|
||||
|
||||
+22
@@ -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:
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user