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:
github-actions[bot]
2026-01-06 19:00:02 +02:00
committed by GitHub
co-authored by olivermrbl Shahed Nasser
parent 76ff8dcca8
commit 1af99f8d5c
219 changed files with 1509 additions and 236 deletions
@@ -437,6 +437,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
@@ -706,6 +707,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -437,6 +437,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
@@ -706,6 +707,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -437,6 +437,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
@@ -706,6 +707,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -437,6 +437,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
@@ -706,6 +707,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -60,7 +60,17 @@
* "500":
* $ref: "#/components/responses/500_error"
* 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
*
*/
@@ -337,6 +337,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the API key's update date.
@@ -568,6 +569,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the API key's deletion date.
@@ -799,6 +801,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: revoked_at
* in: query
* description: Filter by the API key's revoke date.
@@ -1030,6 +1033,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: revoked_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -276,6 +276,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: q
* in: query
* description: The claim's q.
@@ -557,6 +558,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the claim's update date.
@@ -788,6 +790,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -276,6 +276,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: q
* in: query
* description: Search term to filter the collection's searchable properties by.
@@ -557,6 +558,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the collection's update date.
@@ -788,6 +790,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -341,6 +341,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter the customer groups by their update date.
@@ -572,6 +573,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter the customer groups by their deletion date.
@@ -803,6 +805,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -2841,6 +2841,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a customer's update date.
@@ -3072,6 +3073,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter a customer by their deletion date.
@@ -3303,6 +3305,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -1176,6 +1176,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the draft order's update date.
@@ -1407,6 +1408,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: customer_id
* in: query
* required: false
@@ -276,6 +276,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: id
* in: query
* required: false
@@ -549,6 +550,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the exchange's update date.
@@ -780,6 +782,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
@@ -202,6 +202,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the invite's update date.
@@ -321,6 +322,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the invite's deletion date.
@@ -440,6 +442,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -358,6 +358,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the order's update date.
@@ -589,6 +590,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: customer_id
* in: query
* required: false
@@ -260,6 +260,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the order change's update date.
@@ -491,6 +492,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the order change's deletion date.
@@ -722,6 +724,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: id
* in: query
* required: false
@@ -200,6 +200,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the payment's update date.
@@ -319,6 +320,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the payment's deletion date.
@@ -438,6 +440,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -186,6 +186,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: starts_at
* - name: ends_at
* in: query
* description: Filter by the price list's end date.
@@ -305,6 +306,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: ends_at
* - name: status
* in: query
* description: Filter by the price list's status.
@@ -270,6 +270,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the category's update date.
@@ -389,6 +390,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the category's deletion date.
@@ -508,6 +510,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -372,6 +372,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the category's update date.
@@ -603,6 +604,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the category's deletion date.
@@ -834,6 +836,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
@@ -200,6 +200,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the tag's update date.
@@ -319,6 +320,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the tag's deletion date.
@@ -438,6 +440,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -200,6 +200,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the type's update date.
@@ -319,6 +320,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the type's deletion date.
@@ -438,6 +440,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -202,6 +202,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the product variant's update date.
@@ -321,6 +322,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the product variant's deletion date.
@@ -440,6 +442,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -307,6 +307,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a product's update date.
@@ -426,6 +427,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a product's deletion date.
@@ -545,6 +547,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -209,6 +209,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the product's update date.
@@ -328,6 +329,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the product's deletion date.
@@ -447,6 +449,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -219,6 +219,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a promotion's update date.
@@ -338,6 +339,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a promotion's deletion date.
@@ -457,6 +459,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -200,6 +200,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a region's update date.
@@ -319,6 +320,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a region's deletion date.
@@ -438,6 +440,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -273,6 +273,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a reservation's update date.
@@ -392,6 +393,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a reservation's deletion date.
@@ -511,6 +513,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
@@ -606,46 +609,44 @@
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* type: number
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* type: number
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* type: number
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* type: number
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* type: number
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* type: number
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* type: number
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: quantity
* security:
* - api_token: []
* - cookie_auth: []
@@ -242,6 +242,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a return reason's update date.
@@ -361,6 +362,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a return reason's deletion date.
@@ -480,6 +482,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -358,6 +358,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the return's update date.
@@ -589,6 +590,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: customer_id
* in: query
* required: false
@@ -216,6 +216,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a sales channel's update date.
@@ -335,6 +336,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a sales channel's deletion date.
@@ -454,6 +456,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: location_id
* in: query
* required: false
@@ -226,6 +226,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a shipping option type's update date.
@@ -345,6 +346,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a shipping option type's deletion date.
@@ -464,6 +466,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -242,6 +242,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a shipping option's update date.
@@ -361,6 +362,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a shipping option's deletion date.
@@ -480,6 +482,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: stock_location_id
* in: query
* required: false
@@ -202,6 +202,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a shipping profile's update date.
@@ -321,6 +322,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a shipping profile's deletion date.
@@ -440,6 +442,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -228,6 +228,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a stock location's update date.
@@ -347,6 +348,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a stock location's deletion date.
@@ -466,6 +468,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -240,6 +240,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a tax rate's update date.
@@ -359,6 +360,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a tax rate's deletion date.
@@ -478,6 +480,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -0,0 +1,135 @@
/**
* @oas [get] /admin/translations/entities
* 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: |-
* 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)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/translations/entities' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Translations
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminTranslationEntitiesResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-since: 2.12.4
* x-featureFlag: translation
*
*/
@@ -211,6 +211,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a user's update date.
@@ -330,6 +331,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a user's deletion date.
@@ -449,6 +451,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
@@ -233,6 +233,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a view configuration's update date.
@@ -352,6 +353,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - 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
@@ -164,6 +164,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -283,6 +284,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -402,6 +404,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -171,6 +171,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -290,6 +291,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -409,6 +411,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -179,6 +179,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -298,6 +299,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -417,6 +419,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -180,6 +180,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -299,6 +300,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -418,6 +420,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -172,6 +172,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -291,6 +292,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -410,6 +412,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -180,6 +180,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -299,6 +300,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -418,6 +420,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -172,6 +172,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -291,6 +292,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -410,6 +412,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -180,6 +180,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -299,6 +300,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -418,6 +420,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -171,6 +171,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a claim's update date.
@@ -290,6 +291,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by a claim's deletion date.
@@ -409,6 +411,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -243,6 +243,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by the order change's update date.
@@ -474,6 +475,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: deleted_at
* in: query
* description: Filter by the order change's deletion date.
@@ -705,6 +707,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - name: id
* in: query
* required: false
@@ -192,6 +192,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by an order's update date.
@@ -311,6 +312,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
@@ -158,6 +158,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: starts_at
* - name: ends_at
* in: query
* description: Filter by a price list's end date.
@@ -277,6 +278,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: ends_at
* - name: status
* in: query
* description: Filter by price list statuses.
@@ -245,6 +245,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: created_at
* - name: updated_at
* in: query
* description: Filter by a product's update date.
@@ -364,6 +365,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: updated_at
* - name: handle
* in: query
* required: false
@@ -533,6 +535,7 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* title: deleted_at
* - 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 `-`.
@@ -91,7 +91,17 @@
* "500":
* $ref: "#/components/responses/500_error"
* 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
*
*/
@@ -79,7 +79,17 @@
* "500":
* $ref: "#/components/responses/500_error"
* 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
*
*/
@@ -28,9 +28,17 @@
* application/json:
* schema:
* type: object
* title: identifier
* description: The user's identifier for the selected auth provider. For example, for the `emailpass` auth provider, the value is the user's email.
* example: "admin@medusa-test.com"
* description: The input data necessary to generate a reset password token.
* required:
* - identifier
* properties:
* identifier:
* type: string
* description: The identifier of the admin user. For example, their email address.
* example: "admin@medusa-test.com"
* metadata:
* type: object
* description: Optional metadata to include with the reset password token generation request.
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
@@ -89,6 +97,7 @@
* entity_id, // The identifier of the user or customer. For example, an email address.
* actor_type, // The type of actor. For example, "customer", "user", or custom.
* token, // The generated token.
* metadata, // Optional custom metadata passed from the request.
* }
* ```
* description: |-