chore(docs): Updated API Reference (automated) (#14470)
* chore(docs): Generated API Reference (automated) * fixes * fix locale header --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
219 files changed
+1496
-223
No files matched your search
+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.entities({
|
||||||
|
type: "product"
|
||||||
|
})
|
||||||
|
.then(({ data, count, offset, limit }) => {
|
||||||
|
console.log(data)
|
||||||
|
})
|
||||||
+2
@@ -0,0 +1,2 @@
|
|||||||
|
curl '{backend_url}/admin/translations/entities' \
|
||||||
|
-H 'Authorization: Bearer {access_token}'
|
||||||
@@ -6,9 +6,9 @@ required:
|
|||||||
- type
|
- type
|
||||||
- options
|
- options
|
||||||
- images
|
- images
|
||||||
- length
|
|
||||||
- title
|
- title
|
||||||
- status
|
- status
|
||||||
|
- length
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
|||||||
+41
@@ -0,0 +1,41 @@
|
|||||||
|
type: object
|
||||||
|
description: The list of translatable entities.
|
||||||
|
x-schemaName: AdminTranslationEntitiesResponse
|
||||||
|
required:
|
||||||
|
- data
|
||||||
|
- count
|
||||||
|
- offset
|
||||||
|
- limit
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
description: The list of translatable entities.
|
||||||
|
items:
|
||||||
|
allOf:
|
||||||
|
- type: object
|
||||||
|
description: The entity's data.
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- translations
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The entity's ID.
|
||||||
|
translations:
|
||||||
|
type: array
|
||||||
|
description: The entity's translations.
|
||||||
|
items:
|
||||||
|
$ref: ./AdminTranslation.yaml
|
||||||
|
count:
|
||||||
|
type: number
|
||||||
|
title: count
|
||||||
|
description: The total number of translatable entities.
|
||||||
|
offset:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items skipped before retrieving the returned items.
|
||||||
|
limit:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: The maximum number of items returned in the response.
|
||||||
@@ -208,3 +208,8 @@ properties:
|
|||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
items:
|
items:
|
||||||
$ref: ./StoreCartPromotion.yaml
|
$ref: ./StoreCartPromotion.yaml
|
||||||
|
completed_at:
|
||||||
|
type: string
|
||||||
|
title: completed_at
|
||||||
|
description: The date the cart was completed.
|
||||||
|
format: date-time
|
||||||
@@ -131,8 +131,8 @@ properties:
|
|||||||
$ref: ./BaseProductImage.yaml
|
$ref: ./BaseProductImage.yaml
|
||||||
required:
|
required:
|
||||||
- options
|
- options
|
||||||
- length
|
|
||||||
- title
|
- title
|
||||||
|
- length
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -1212,6 +1212,8 @@ paths:
|
|||||||
$ref: paths/admin_translations.yaml
|
$ref: paths/admin_translations.yaml
|
||||||
/admin/translations/batch:
|
/admin/translations/batch:
|
||||||
$ref: paths/admin_translations_batch.yaml
|
$ref: paths/admin_translations_batch.yaml
|
||||||
|
/admin/translations/entities:
|
||||||
|
$ref: paths/admin_translations_entities.yaml
|
||||||
/admin/translations/settings:
|
/admin/translations/settings:
|
||||||
$ref: paths/admin_translations_settings.yaml
|
$ref: paths/admin_translations_settings.yaml
|
||||||
/admin/translations/statistics:
|
/admin/translations/statistics:
|
||||||
|
|||||||
@@ -387,6 +387,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the API key's update date.
|
description: Filter by the API key's update date.
|
||||||
@@ -656,6 +657,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the API key's deletion date.
|
description: Filter by the API key's deletion date.
|
||||||
@@ -925,6 +927,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: revoked_at
|
- name: revoked_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the API key's revoke date.
|
description: Filter by the API key's revoke date.
|
||||||
@@ -1194,6 +1197,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: revoked_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -340,6 +340,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: q
|
- name: q
|
||||||
in: query
|
in: query
|
||||||
description: The claim's q.
|
description: The claim's q.
|
||||||
@@ -673,6 +674,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the claim's update date.
|
description: Filter by the claim's update date.
|
||||||
@@ -956,6 +958,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
@@ -1219,6 +1222,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -1358,6 +1362,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -1497,6 +1502,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -198,6 +198,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -337,6 +338,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -476,6 +478,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+3
@@ -208,6 +208,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -347,6 +348,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -486,6 +488,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+3
@@ -209,6 +209,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -348,6 +349,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -487,6 +489,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -198,6 +198,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -337,6 +338,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -476,6 +478,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+3
@@ -209,6 +209,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -348,6 +349,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -487,6 +489,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+3
@@ -198,6 +198,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -337,6 +338,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -476,6 +478,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+3
@@ -209,6 +209,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -348,6 +349,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -487,6 +489,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -196,6 +196,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's update date.
|
description: Filter by a claim's update date.
|
||||||
@@ -335,6 +336,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a claim's deletion date.
|
description: Filter by a claim's deletion date.
|
||||||
@@ -474,6 +476,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -326,6 +326,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: q
|
- name: q
|
||||||
in: query
|
in: query
|
||||||
description: Search term to filter the collection's searchable properties by.
|
description: Search term to filter the collection's searchable properties by.
|
||||||
@@ -645,6 +646,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the collection's update date.
|
description: Filter by the collection's update date.
|
||||||
@@ -914,6 +916,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -395,6 +395,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter the customer groups by their update date.
|
description: Filter the customer groups by their update date.
|
||||||
@@ -664,6 +665,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter the customer groups by their deletion date.
|
description: Filter the customer groups by their deletion date.
|
||||||
@@ -933,6 +935,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -3585,6 +3585,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a customer's update date.
|
description: Filter by a customer's update date.
|
||||||
@@ -3854,6 +3855,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter a customer by their deletion date.
|
description: Filter a customer by their deletion date.
|
||||||
@@ -4123,6 +4125,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -1462,6 +1462,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the draft order's update date.
|
description: Filter by the draft order's update date.
|
||||||
@@ -1731,6 +1732,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: customer_id
|
- name: customer_id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -326,6 +326,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: id
|
- name: id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
@@ -637,6 +638,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the exchange's update date.
|
description: Filter by the exchange's update date.
|
||||||
@@ -906,6 +908,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
|
|||||||
@@ -234,6 +234,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the invite's update date.
|
description: Filter by the invite's update date.
|
||||||
@@ -373,6 +374,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the invite's deletion date.
|
description: Filter by the invite's deletion date.
|
||||||
@@ -512,6 +514,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -283,6 +283,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the order change's update date.
|
description: Filter by the order change's update date.
|
||||||
@@ -552,6 +553,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the order change's deletion date.
|
description: Filter by the order change's deletion date.
|
||||||
@@ -821,6 +823,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: id
|
- name: id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -418,6 +418,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the order's update date.
|
description: Filter by the order's update date.
|
||||||
@@ -687,6 +688,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: customer_id
|
- name: customer_id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -215,6 +215,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by an order's update date.
|
description: Filter by an order's update date.
|
||||||
@@ -354,6 +355,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: limit
|
- name: limit
|
||||||
in: query
|
in: query
|
||||||
description: Limit the number of items returned in the list.
|
description: Limit the number of items returned in the list.
|
||||||
|
|||||||
@@ -306,6 +306,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the order change's update date.
|
description: Filter by the order change's update date.
|
||||||
@@ -575,6 +576,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the order change's deletion date.
|
description: Filter by the order change's deletion date.
|
||||||
@@ -844,6 +846,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: id
|
- name: id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -236,6 +236,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the payment's update date.
|
description: Filter by the payment's update date.
|
||||||
@@ -375,6 +376,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the payment's deletion date.
|
description: Filter by the payment's deletion date.
|
||||||
@@ -514,6 +516,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -218,6 +218,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: starts_at
|
||||||
- name: ends_at
|
- name: ends_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the price list's end date.
|
description: Filter by the price list's end date.
|
||||||
@@ -357,6 +358,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: ends_at
|
||||||
- name: status
|
- name: status
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the price list's status.
|
description: Filter by the price list's status.
|
||||||
@@ -636,6 +638,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: starts_at
|
||||||
- name: ends_at
|
- name: ends_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a price list's end date.
|
description: Filter by a price list's end date.
|
||||||
@@ -775,6 +778,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: ends_at
|
||||||
- name: status
|
- name: status
|
||||||
in: query
|
in: query
|
||||||
description: Filter by price list statuses.
|
description: Filter by price list statuses.
|
||||||
|
|||||||
@@ -329,6 +329,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the category's update date.
|
description: Filter by the category's update date.
|
||||||
@@ -468,6 +469,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the category's deletion date.
|
description: Filter by the category's deletion date.
|
||||||
@@ -607,6 +609,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -441,6 +441,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the category's update date.
|
description: Filter by the category's update date.
|
||||||
@@ -710,6 +711,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the category's deletion date.
|
description: Filter by the category's deletion date.
|
||||||
@@ -979,6 +981,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: limit
|
- name: limit
|
||||||
in: query
|
in: query
|
||||||
description: Limit the number of items returned in the list.
|
description: Limit the number of items returned in the list.
|
||||||
|
|||||||
@@ -232,6 +232,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the tag's update date.
|
description: Filter by the tag's update date.
|
||||||
@@ -371,6 +372,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the tag's deletion date.
|
description: Filter by the tag's deletion date.
|
||||||
@@ -510,6 +512,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -232,6 +232,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the type's update date.
|
description: Filter by the type's update date.
|
||||||
@@ -371,6 +372,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the type's deletion date.
|
description: Filter by the type's deletion date.
|
||||||
@@ -510,6 +512,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -234,6 +234,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the product variant's update date.
|
description: Filter by the product variant's update date.
|
||||||
@@ -373,6 +374,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the product variant's deletion date.
|
description: Filter by the product variant's deletion date.
|
||||||
@@ -512,6 +514,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -347,6 +347,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a product's update date.
|
description: Filter by a product's update date.
|
||||||
@@ -486,6 +487,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a product's deletion date.
|
description: Filter by a product's deletion date.
|
||||||
@@ -625,6 +627,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -274,6 +274,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a product's update date.
|
description: Filter by a product's update date.
|
||||||
@@ -413,6 +414,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: handle
|
- name: handle
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
@@ -602,6 +604,7 @@ post:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: order
|
- name: order
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -241,6 +241,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the product's update date.
|
description: Filter by the product's update date.
|
||||||
@@ -380,6 +381,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the product's deletion date.
|
description: Filter by the product's deletion date.
|
||||||
@@ -519,6 +521,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -255,6 +255,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a promotion's update date.
|
description: Filter by a promotion's update date.
|
||||||
@@ -394,6 +395,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a promotion's deletion date.
|
description: Filter by a promotion's deletion date.
|
||||||
@@ -533,6 +535,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -232,6 +232,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a region's update date.
|
description: Filter by a region's update date.
|
||||||
@@ -371,6 +372,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a region's deletion date.
|
description: Filter by a region's deletion date.
|
||||||
@@ -510,6 +512,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -328,6 +328,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a reservation's update date.
|
description: Filter by a reservation's update date.
|
||||||
@@ -467,6 +468,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a reservation's deletion date.
|
description: Filter by a reservation's deletion date.
|
||||||
@@ -606,6 +608,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
@@ -721,46 +724,44 @@ get:
|
|||||||
Filter by values less than or equal to this parameter. Useful for
|
Filter by values less than or equal to this parameter. Useful for
|
||||||
numbers and dates only.
|
numbers and dates only.
|
||||||
$like:
|
$like:
|
||||||
type: string
|
type: number
|
||||||
title: $like
|
title: $like
|
||||||
description: Apply a `like` filter. Useful for strings only.
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
$re:
|
$re:
|
||||||
type: string
|
type: number
|
||||||
title: $re
|
title: $re
|
||||||
description: Apply a regex filter. Useful for strings only.
|
description: Apply a regex filter. Useful for strings only.
|
||||||
$ilike:
|
$ilike:
|
||||||
type: string
|
type: number
|
||||||
title: $ilike
|
title: $ilike
|
||||||
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
$fulltext:
|
$fulltext:
|
||||||
type: string
|
type: number
|
||||||
title: $fulltext
|
title: $fulltext
|
||||||
description: Filter to apply on full-text properties.
|
description: Filter to apply on full-text properties.
|
||||||
$overlap:
|
$overlap:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that have overlapping values with this parameter.
|
description: Filter arrays that have overlapping values with this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: number
|
||||||
title: $overlap
|
|
||||||
description: Filter arrays that have overlapping values with this parameter.
|
description: Filter arrays that have overlapping values with this parameter.
|
||||||
$contains:
|
$contains:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain some of the values of this parameter.
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: number
|
||||||
title: $contains
|
|
||||||
description: Filter arrays that contain some of the values of this parameter.
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
$contained:
|
$contained:
|
||||||
type: array
|
type: array
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: Filter arrays that contain all values of this parameter.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: number
|
||||||
title: $contained
|
|
||||||
description: Filter arrays that contain all values of this parameter.
|
description: Filter arrays that contain all values of this parameter.
|
||||||
$exists:
|
$exists:
|
||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: quantity
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -284,6 +284,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a return reason's update date.
|
description: Filter by a return reason's update date.
|
||||||
@@ -423,6 +424,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a return reason's deletion date.
|
description: Filter by a return reason's deletion date.
|
||||||
@@ -562,6 +564,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -416,6 +416,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the return's update date.
|
description: Filter by the return's update date.
|
||||||
@@ -685,6 +686,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: customer_id
|
- name: customer_id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
+2
@@ -622,6 +622,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: limit
|
- name: limit
|
||||||
in: query
|
in: query
|
||||||
description: Limit the number of items returned in the list.
|
description: Limit the number of items returned in the list.
|
||||||
@@ -934,6 +935,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+2
@@ -622,6 +622,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: limit
|
- name: limit
|
||||||
in: query
|
in: query
|
||||||
description: Limit the number of items returned in the list.
|
description: Limit the number of items returned in the list.
|
||||||
@@ -934,6 +935,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+2
@@ -621,6 +621,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: limit
|
- name: limit
|
||||||
in: query
|
in: query
|
||||||
description: Limit the number of items returned in the list.
|
description: Limit the number of items returned in the list.
|
||||||
@@ -933,6 +934,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
+2
@@ -621,6 +621,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: limit
|
- name: limit
|
||||||
in: query
|
in: query
|
||||||
description: Limit the number of items returned in the list.
|
description: Limit the number of items returned in the list.
|
||||||
@@ -933,6 +934,7 @@ delete:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
security:
|
security:
|
||||||
- api_token: []
|
- api_token: []
|
||||||
- cookie_auth: []
|
- cookie_auth: []
|
||||||
|
|||||||
@@ -250,6 +250,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a sales channel's update date.
|
description: Filter by a sales channel's update date.
|
||||||
@@ -389,6 +390,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a sales channel's deletion date.
|
description: Filter by a sales channel's deletion date.
|
||||||
@@ -528,6 +530,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: location_id
|
- name: location_id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -263,6 +263,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a shipping option type's update date.
|
description: Filter by a shipping option type's update date.
|
||||||
@@ -402,6 +403,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a shipping option type's deletion date.
|
description: Filter by a shipping option type's deletion date.
|
||||||
@@ -541,6 +543,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -290,6 +290,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a shipping option's update date.
|
description: Filter by a shipping option's update date.
|
||||||
@@ -429,6 +430,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a shipping option's deletion date.
|
description: Filter by a shipping option's deletion date.
|
||||||
@@ -568,6 +570,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: stock_location_id
|
- name: stock_location_id
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
@@ -742,4 +745,14 @@ post:
|
|||||||
'500':
|
'500':
|
||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
x-workflow: createShippingOptionsWorkflow
|
x-workflow: createShippingOptionsWorkflow
|
||||||
x-events: []
|
x-events:
|
||||||
|
- name: shipping-option.created
|
||||||
|
payload: |-
|
||||||
|
```ts
|
||||||
|
{
|
||||||
|
id, // The ID of the shipping option
|
||||||
|
}
|
||||||
|
```
|
||||||
|
description: Emitted when shipping options are created.
|
||||||
|
deprecated: false
|
||||||
|
since: 2.12.4
|
||||||
@@ -136,7 +136,17 @@ post:
|
|||||||
'500':
|
'500':
|
||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
x-workflow: updateShippingOptionsWorkflow
|
x-workflow: updateShippingOptionsWorkflow
|
||||||
x-events: []
|
x-events:
|
||||||
|
- name: shipping-option.updated
|
||||||
|
payload: |-
|
||||||
|
```ts
|
||||||
|
{
|
||||||
|
id, // The ID of the shipping option
|
||||||
|
}
|
||||||
|
```
|
||||||
|
description: Emitted when shipping options are updated.
|
||||||
|
deprecated: false
|
||||||
|
since: 2.12.4
|
||||||
delete:
|
delete:
|
||||||
operationId: DeleteShippingOptionsId
|
operationId: DeleteShippingOptionsId
|
||||||
summary: Delete a Shipping Option
|
summary: Delete a Shipping Option
|
||||||
@@ -184,4 +194,14 @@ delete:
|
|||||||
'500':
|
'500':
|
||||||
$ref: ../components/responses/500_error.yaml
|
$ref: ../components/responses/500_error.yaml
|
||||||
x-workflow: deleteShippingOptionsWorkflow
|
x-workflow: deleteShippingOptionsWorkflow
|
||||||
x-events: []
|
x-events:
|
||||||
|
- name: shipping-option.deleted
|
||||||
|
payload: |-
|
||||||
|
```ts
|
||||||
|
{
|
||||||
|
id, // The ID of the shipping option
|
||||||
|
}
|
||||||
|
```
|
||||||
|
description: Emitted when shipping options are deleted.
|
||||||
|
deprecated: false
|
||||||
|
since: 2.12.4
|
||||||
@@ -235,6 +235,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a shipping profile's update date.
|
description: Filter by a shipping profile's update date.
|
||||||
@@ -374,6 +375,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a shipping profile's deletion date.
|
description: Filter by a shipping profile's deletion date.
|
||||||
@@ -513,6 +515,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -262,6 +262,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a stock location's update date.
|
description: Filter by a stock location's update date.
|
||||||
@@ -401,6 +402,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a stock location's deletion date.
|
description: Filter by a stock location's deletion date.
|
||||||
@@ -540,6 +542,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -286,6 +286,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a tax rate's update date.
|
description: Filter by a tax rate's update date.
|
||||||
@@ -425,6 +426,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a tax rate's deletion date.
|
description: Filter by a tax rate's deletion date.
|
||||||
@@ -564,6 +566,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -0,0 +1,128 @@
|
|||||||
|
get:
|
||||||
|
operationId: GetTranslationsEntities
|
||||||
|
summary: List Translatable Entities
|
||||||
|
description: >-
|
||||||
|
Retrieve a list of translatable entities. The entities can be filtered by
|
||||||
|
fields such as `id`. The entities can also be sorted or paginated.
|
||||||
|
x-authenticated: true
|
||||||
|
parameters:
|
||||||
|
- name: type
|
||||||
|
in: query
|
||||||
|
description: Filter by a translatable entity type.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: type
|
||||||
|
description: Filter by a translatable entity type.
|
||||||
|
example: product
|
||||||
|
- name: id
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: id
|
||||||
|
description: Filter by an entity's ID.
|
||||||
|
- type: array
|
||||||
|
description: Filter by entity IDs.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: An entity's ID.
|
||||||
|
- name: limit
|
||||||
|
in: query
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: offset
|
||||||
|
in: query
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: order
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is ascending.
|
||||||
|
To change the order to descending, prefix the field name with `-`.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: order
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is
|
||||||
|
ascending. To change the order to descending, prefix the field name
|
||||||
|
with `-`.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: with_deleted
|
||||||
|
in: query
|
||||||
|
description: The translation's with deleted.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
title: with_deleted
|
||||||
|
description: The translation's with deleted.
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data. If
|
||||||
|
a field is prefixed with `+` it will be added to the default fields,
|
||||||
|
using `-` will remove it from the default fields. Without prefix it will
|
||||||
|
replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
If a field is prefixed with `+` it will be added to the default
|
||||||
|
fields, using `-` will remove it from the default fields. Without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
|
externalDocs:
|
||||||
|
url: '#select-fields-and-relations'
|
||||||
|
security:
|
||||||
|
- api_token: []
|
||||||
|
- cookie_auth: []
|
||||||
|
- jwt_token: []
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: JavaScript
|
||||||
|
label: JS SDK
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/JavaScript/admin_translations_entities/get.js
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/Shell/admin_translations_entities/get.sh
|
||||||
|
tags:
|
||||||
|
- Translations
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../components/schemas/AdminTranslationEntitiesResponse.yaml
|
||||||
|
'400':
|
||||||
|
$ref: ../components/responses/400_error.yaml
|
||||||
|
'401':
|
||||||
|
$ref: ../components/responses/unauthorized.yaml
|
||||||
|
'404':
|
||||||
|
$ref: ../components/responses/not_found_error.yaml
|
||||||
|
'409':
|
||||||
|
$ref: ../components/responses/invalid_state_error.yaml
|
||||||
|
'422':
|
||||||
|
$ref: ../components/responses/invalid_request_error.yaml
|
||||||
|
'500':
|
||||||
|
$ref: ../components/responses/500_error.yaml
|
||||||
|
x-since: 2.12.4
|
||||||
|
x-featureFlag: translation
|
||||||
@@ -243,6 +243,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a user's update date.
|
description: Filter by a user's update date.
|
||||||
@@ -382,6 +383,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: deleted_at
|
- name: deleted_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a user's deletion date.
|
description: Filter by a user's deletion date.
|
||||||
@@ -521,6 +523,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: deleted_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
|
|||||||
@@ -259,6 +259,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by a view configuration's update date.
|
description: Filter by a view configuration's update date.
|
||||||
@@ -398,6 +399,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: fields
|
- name: fields
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
+14
-3
@@ -38,11 +38,21 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
title: identifier
|
description: The input data necessary to generate a reset password token.
|
||||||
|
required:
|
||||||
|
- identifier
|
||||||
|
properties:
|
||||||
|
identifier:
|
||||||
|
type: string
|
||||||
description: >-
|
description: >-
|
||||||
The user's identifier for the selected auth provider. For example,
|
The identifier of the admin user. For example, their email
|
||||||
for the `emailpass` auth provider, the value is the user's email.
|
address.
|
||||||
example: admin@medusa-test.com
|
example: admin@medusa-test.com
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: >-
|
||||||
|
Optional metadata to include with the reset password token
|
||||||
|
generation request.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: JavaScript
|
- lang: JavaScript
|
||||||
label: JS SDK
|
label: JS SDK
|
||||||
@@ -79,6 +89,7 @@ post:
|
|||||||
entity_id, // The identifier of the user or customer. For example, an email address.
|
entity_id, // The identifier of the user or customer. For example, an email address.
|
||||||
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
||||||
token, // The generated token.
|
token, // The generated token.
|
||||||
|
metadata, // Optional custom metadata passed from the request.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -6,9 +6,9 @@ required:
|
|||||||
- type
|
- type
|
||||||
- options
|
- options
|
||||||
- images
|
- images
|
||||||
- length
|
|
||||||
- title
|
- title
|
||||||
- status
|
- status
|
||||||
|
- length
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
|||||||
+41
@@ -0,0 +1,41 @@
|
|||||||
|
type: object
|
||||||
|
description: The list of translatable entities.
|
||||||
|
x-schemaName: AdminTranslationEntitiesResponse
|
||||||
|
required:
|
||||||
|
- data
|
||||||
|
- count
|
||||||
|
- offset
|
||||||
|
- limit
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
description: The list of translatable entities.
|
||||||
|
items:
|
||||||
|
allOf:
|
||||||
|
- type: object
|
||||||
|
description: The entity's data.
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- translations
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The entity's ID.
|
||||||
|
translations:
|
||||||
|
type: array
|
||||||
|
description: The entity's translations.
|
||||||
|
items:
|
||||||
|
$ref: ./AdminTranslation.yaml
|
||||||
|
count:
|
||||||
|
type: number
|
||||||
|
title: count
|
||||||
|
description: The total number of translatable entities.
|
||||||
|
offset:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items skipped before retrieving the returned items.
|
||||||
|
limit:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: The maximum number of items returned in the response.
|
||||||
@@ -208,3 +208,8 @@ properties:
|
|||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
items:
|
items:
|
||||||
$ref: ./StoreCartPromotion.yaml
|
$ref: ./StoreCartPromotion.yaml
|
||||||
|
completed_at:
|
||||||
|
type: string
|
||||||
|
title: completed_at
|
||||||
|
description: The date the cart was completed.
|
||||||
|
format: date-time
|
||||||
@@ -131,8 +131,8 @@ properties:
|
|||||||
$ref: ./BaseProductImage.yaml
|
$ref: ./BaseProductImage.yaml
|
||||||
required:
|
required:
|
||||||
- options
|
- options
|
||||||
- length
|
|
||||||
- title
|
- title
|
||||||
|
- length
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
|||||||
@@ -520,9 +520,17 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
title: identifier
|
description: The input data necessary to generate a reset password token.
|
||||||
|
required:
|
||||||
|
- identifier
|
||||||
|
properties:
|
||||||
|
identifier:
|
||||||
|
type: string
|
||||||
description: The customer's identifier for the selected auth provider. For example, for the `emailpass` auth provider, the value is the customer's email.
|
description: The customer's identifier for the selected auth provider. For example, for the `emailpass` auth provider, the value is the customer's email.
|
||||||
example: customer@gmail.com
|
example: customer@gmail.com
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: Optional metadata to include with the reset password token generation request.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: JavaScript
|
- lang: JavaScript
|
||||||
label: JS SDK
|
label: JS SDK
|
||||||
@@ -585,6 +593,7 @@ paths:
|
|||||||
entity_id, // The identifier of the user or customer. For example, an email address.
|
entity_id, // The identifier of the user or customer. For example, an email address.
|
||||||
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
||||||
token, // The generated token.
|
token, // The generated token.
|
||||||
|
metadata, // Optional custom metadata passed from the request.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
description: |-
|
description: |-
|
||||||
@@ -858,7 +867,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -987,7 +996,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -1085,7 +1094,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -1230,7 +1239,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -1400,7 +1409,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -1685,7 +1694,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -1843,7 +1852,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -1997,7 +2006,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -2132,7 +2141,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -2225,7 +2234,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -2324,7 +2333,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -2547,7 +2556,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -2624,7 +2633,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -2917,6 +2926,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the collection's update date.
|
description: Filter by the collection's update date.
|
||||||
@@ -3148,6 +3158,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: handle
|
- name: handle
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
@@ -3323,7 +3334,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -3416,7 +3427,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -3572,7 +3583,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -3647,7 +3658,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -3785,7 +3796,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -3885,7 +3896,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4012,7 +4023,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4204,7 +4215,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4333,7 +4344,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4442,7 +4453,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4565,7 +4576,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4830,7 +4841,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -4916,7 +4927,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5154,7 +5165,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5256,7 +5267,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5378,7 +5389,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5494,7 +5505,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5616,7 +5627,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5736,7 +5747,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5862,7 +5873,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -5948,7 +5959,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -6119,7 +6130,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -6478,6 +6489,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the category's update date.
|
description: Filter by the category's update date.
|
||||||
@@ -6709,6 +6721,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
@@ -6831,7 +6844,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -6940,7 +6953,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -7280,6 +7293,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the tag's update date.
|
description: Filter by the tag's update date.
|
||||||
@@ -7511,6 +7525,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
@@ -7577,7 +7592,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -7652,7 +7667,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -7992,6 +8007,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the type's update date.
|
description: Filter by the type's update date.
|
||||||
@@ -8223,6 +8239,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
@@ -8289,7 +8306,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -8356,7 +8373,7 @@ paths:
|
|||||||
description: |
|
description: |
|
||||||
Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
|
Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
|
||||||
|
|
||||||
You can retrieve the content of the products translated to a specific locale either by passing the `locale` query parameter or by setting the `Content-Language` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
|
You can retrieve the content of the products translated to a specific locale either by passing the `locale` query parameter or by setting the `x-medusa-locale` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
|
||||||
|
|
||||||
With localization, the products' content like title and description will be in the specified locale if a translation is available, and fallback to the original content otherwise. Learn more in the [Localization](#localization) section.
|
With localization, the products' content like title and description will be in the specified locale if a translation is available, and fallback to the original content otherwise. Learn more in the [Localization](#localization) section.
|
||||||
x-authenticated: false
|
x-authenticated: false
|
||||||
@@ -8372,7 +8389,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -8774,6 +8791,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the product's update date.
|
description: Filter by the product's update date.
|
||||||
@@ -9005,6 +9023,7 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: region_id
|
- name: region_id
|
||||||
in: query
|
in: query
|
||||||
description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
|
description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
|
||||||
@@ -9190,7 +9209,7 @@ paths:
|
|||||||
description: |
|
description: |
|
||||||
Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
|
Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
|
||||||
|
|
||||||
You can retrieve the content of the product translated to a specific locale either by passing the `locale` query parameter or by setting the `Content-Language` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
|
You can retrieve the content of the product translated to a specific locale either by passing the `locale` query parameter or by setting the `x-medusa-locale` header to the desired locale code in BCP 47 format. If you don't pass a locale, and your store has a default locale, the default locale will be used.
|
||||||
|
|
||||||
With localization, the product's content like title and description will be in the specified locale if a translation is available, and fallback to the original content otherwise. Learn more in the [Localization](#localization) section.
|
With localization, the product's content like title and description will be in the specified locale if a translation is available, and fallback to the original content otherwise. Learn more in the [Localization](#localization) section.
|
||||||
x-authenticated: false
|
x-authenticated: false
|
||||||
@@ -9212,7 +9231,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -9347,7 +9366,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -9581,7 +9600,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -9678,7 +9697,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -9821,7 +9840,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -9893,7 +9912,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -10007,7 +10026,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -10174,7 +10193,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -20799,9 +20818,9 @@ components:
|
|||||||
- type
|
- type
|
||||||
- options
|
- options
|
||||||
- images
|
- images
|
||||||
- length
|
|
||||||
- title
|
- title
|
||||||
- status
|
- status
|
||||||
|
- length
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
@@ -24362,6 +24381,48 @@ components:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: deleted_at
|
title: deleted_at
|
||||||
description: The date that the translation was deleted.
|
description: The date that the translation was deleted.
|
||||||
|
AdminTranslationEntitiesResponse:
|
||||||
|
type: object
|
||||||
|
description: The list of translatable entities.
|
||||||
|
x-schemaName: AdminTranslationEntitiesResponse
|
||||||
|
required:
|
||||||
|
- data
|
||||||
|
- count
|
||||||
|
- offset
|
||||||
|
- limit
|
||||||
|
properties:
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
description: The list of translatable entities.
|
||||||
|
items:
|
||||||
|
allOf:
|
||||||
|
- type: object
|
||||||
|
description: The entity's data.
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- translations
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: The entity's ID.
|
||||||
|
translations:
|
||||||
|
type: array
|
||||||
|
description: The entity's translations.
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/AdminTranslation'
|
||||||
|
count:
|
||||||
|
type: number
|
||||||
|
title: count
|
||||||
|
description: The total number of translatable entities.
|
||||||
|
offset:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items skipped before retrieving the returned items.
|
||||||
|
limit:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: The maximum number of items returned in the response.
|
||||||
AdminTranslationSettingsResponse:
|
AdminTranslationSettingsResponse:
|
||||||
type: object
|
type: object
|
||||||
description: The translation settings' details.
|
description: The translation settings' details.
|
||||||
@@ -32859,6 +32920,11 @@ components:
|
|||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/StoreCartPromotion'
|
$ref: '#/components/schemas/StoreCartPromotion'
|
||||||
|
completed_at:
|
||||||
|
type: string
|
||||||
|
title: completed_at
|
||||||
|
description: The date the cart was completed.
|
||||||
|
format: date-time
|
||||||
StoreCartAddPromotion:
|
StoreCartAddPromotion:
|
||||||
type: object
|
type: object
|
||||||
description: The promotion's details.
|
description: The promotion's details.
|
||||||
@@ -41619,8 +41685,8 @@ components:
|
|||||||
$ref: '#/components/schemas/BaseProductImage'
|
$ref: '#/components/schemas/BaseProductImage'
|
||||||
required:
|
required:
|
||||||
- options
|
- options
|
||||||
- length
|
|
||||||
- title
|
- title
|
||||||
|
- length
|
||||||
- id
|
- id
|
||||||
- created_at
|
- created_at
|
||||||
- updated_at
|
- updated_at
|
||||||
|
|||||||
+12
-1
@@ -37,12 +37,22 @@ post:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
title: identifier
|
description: The input data necessary to generate a reset password token.
|
||||||
|
required:
|
||||||
|
- identifier
|
||||||
|
properties:
|
||||||
|
identifier:
|
||||||
|
type: string
|
||||||
description: >-
|
description: >-
|
||||||
The customer's identifier for the selected auth provider. For
|
The customer's identifier for the selected auth provider. For
|
||||||
example, for the `emailpass` auth provider, the value is the
|
example, for the `emailpass` auth provider, the value is the
|
||||||
customer's email.
|
customer's email.
|
||||||
example: customer@gmail.com
|
example: customer@gmail.com
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
description: >-
|
||||||
|
Optional metadata to include with the reset password token
|
||||||
|
generation request.
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: JavaScript
|
- lang: JavaScript
|
||||||
label: JS SDK
|
label: JS SDK
|
||||||
@@ -80,6 +90,7 @@ post:
|
|||||||
entity_id, // The identifier of the user or customer. For example, an email address.
|
entity_id, // The identifier of the user or customer. For example, an email address.
|
||||||
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
actor_type, // The type of actor. For example, "customer", "user", or custom.
|
||||||
token, // The generated token.
|
token, // The generated token.
|
||||||
|
metadata, // Optional custom metadata passed from the request.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -116,7 +116,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -169,7 +169,7 @@ delete:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -120,7 +120,7 @@ delete:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -363,6 +363,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the collection's update date.
|
description: Filter by the collection's update date.
|
||||||
@@ -632,6 +633,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: handle
|
- name: handle
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -118,7 +118,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -203,7 +203,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
+3
-3
@@ -21,7 +21,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -128,7 +128,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -243,7 +243,7 @@ delete:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
+1
-1
@@ -43,7 +43,7 @@ post:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -460,6 +460,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the category's update date.
|
description: Filter by the category's update date.
|
||||||
@@ -729,6 +730,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: $and
|
- name: $and
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -413,6 +413,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the tag's update date.
|
description: Filter by the tag's update date.
|
||||||
@@ -682,6 +683,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -410,6 +410,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the type's update date.
|
description: Filter by the type's update date.
|
||||||
@@ -679,6 +680,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: with_deleted
|
- name: with_deleted
|
||||||
in: query
|
in: query
|
||||||
description: Whether to include deleted records in the result.
|
description: Whether to include deleted records in the result.
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -8,9 +8,9 @@ get:
|
|||||||
|
|
||||||
You can retrieve the content of the products translated to a specific locale
|
You can retrieve the content of the products translated to a specific locale
|
||||||
either by passing the `locale` query parameter or by setting the
|
either by passing the `locale` query parameter or by setting the
|
||||||
`Content-Language` header to the desired locale code in BCP 47 format. If
|
`x-medusa-locale` header to the desired locale code in BCP 47 format. If you
|
||||||
you don't pass a locale, and your store has a default locale, the default
|
don't pass a locale, and your store has a default locale, the default locale
|
||||||
locale will be used.
|
will be used.
|
||||||
|
|
||||||
|
|
||||||
With localization, the products' content like title and description will be
|
With localization, the products' content like title and description will be
|
||||||
@@ -30,7 +30,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
@@ -493,6 +493,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: created_at
|
||||||
- name: updated_at
|
- name: updated_at
|
||||||
in: query
|
in: query
|
||||||
description: Filter by the product's update date.
|
description: Filter by the product's update date.
|
||||||
@@ -762,6 +763,7 @@ get:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: $exists
|
title: $exists
|
||||||
description: Filter by whether a value for this parameter exists (not `null`).
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
title: updated_at
|
||||||
- name: region_id
|
- name: region_id
|
||||||
in: query
|
in: query
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -8,9 +8,9 @@ get:
|
|||||||
|
|
||||||
You can retrieve the content of the product translated to a specific locale
|
You can retrieve the content of the product translated to a specific locale
|
||||||
either by passing the `locale` query parameter or by setting the
|
either by passing the `locale` query parameter or by setting the
|
||||||
`Content-Language` header to the desired locale code in BCP 47 format. If
|
`x-medusa-locale` header to the desired locale code in BCP 47 format. If you
|
||||||
you don't pass a locale, and your store has a default locale, the default
|
don't pass a locale, and your store has a default locale, the default locale
|
||||||
locale will be used.
|
will be used.
|
||||||
|
|
||||||
|
|
||||||
With localization, the product's content like title and description will be
|
With localization, the product's content like title and description will be
|
||||||
@@ -36,7 +36,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
externalDocs:
|
externalDocs:
|
||||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
- name: Content-Language
|
- name: x-medusa-locale
|
||||||
in: header
|
in: header
|
||||||
description: The locale in BCP 47 format to retrieve localized content.
|
description: The locale in BCP 47 format to retrieve localized content.
|
||||||
required: false
|
required: false
|
||||||
|
|||||||
Loaded 100 of 219 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user