asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate API reference for 2.12.0 (#14185)

Browse Source
This commit is contained in:
Shahed Nasser
2025-12-02 11:56:37 +02:00
committed by GitHub
parent 21f61ec160
commit 9372a17d1f
71 changed files with 6310 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-changes_{id}/post.js Normal file
View File

@@ -0,0 +1,19 @@
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.order.updateOrderChange(
"ordch_123",
{
carry_over_promotions: true
}
)
.then(({ order_change }) => {
console.log(order_change)
})

6
www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/post.sh
View File

@@ -1,2 +1,6 @@
curl -X POST '{backend_url}/admin/draft-orders/{id}' \
-H 'Authorization: Bearer {jwt_token}'
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"email": "test@test.com"
}'

6
www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-changes_{id}/post.sh Normal file
View File

@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/admin/order-changes/{id}' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"carry_over_promotions": true
}'

7
www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml
View File

@@ -272,3 +272,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

7
www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml
View File

@@ -677,3 +677,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

7
www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml
View File

@@ -265,3 +265,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

6
www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml
View File

@@ -139,3 +139,9 @@ properties:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).

8
www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeResponse.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
description: The details of the order change.
x-schemaName: AdminOrderChangeResponse
required:
- order_change
properties:
order_change:
$ref: ./AdminOrderChange.yaml

7
www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml
View File

@@ -679,3 +679,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

3
www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml
View File

@@ -11,6 +11,7 @@ required:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -149,7 +150,7 @@ properties:
type: array
description: The variant's images.
items:
$ref: ./AdminProductImage.yaml
$ref: ./BaseProductImage.yaml
thumbnail:
type: string
title: thumbnail

8
www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml
View File

@@ -69,3 +69,11 @@ properties:
description: >-
Whether the promotion is tax inclusive. If enabled, the promotion is
applied after tax is calculated.
limit:
type: number
title: limit
description: The limit of times the promotion can be used.
used:
type: number
title: used
description: The number of times the promotion has been used.

10
www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrderChange.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
description: The data to update in the order change.
x-schemaName: AdminUpdateOrderChange
properties:
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).

7
www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml
View File

@@ -253,3 +253,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

2
www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml
View File

@@ -29,7 +29,7 @@ properties:
type: object
description: The image's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
rank:
type: number

6
www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml
View File

@@ -9,6 +9,7 @@ required:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -138,3 +139,8 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: ./BaseProductImage.yaml

7
www/apps/api-reference/specs/admin/components/schemas/Order.yaml
View File

@@ -321,3 +321,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

6
www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml
View File

@@ -139,3 +139,9 @@ properties:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).

5
www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml
View File

@@ -15,6 +15,7 @@ required:
- action
- details
- internal_note
- ordering
- created_at
- updated_at
properties:
@@ -98,3 +99,7 @@ properties:
format: date-time
title: updated_at
description: The date the action was updated.
ordering:
type: number
title: ordering
description: The action's ordering among other actions in the same order change.

7
www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml
View File

@@ -251,3 +251,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

6
www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml
View File

@@ -124,6 +124,11 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: ./BaseProductImage.yaml
required:
- options
- length
@@ -139,6 +144,7 @@ required:
- hs_code
- mid_code
- material
- images
- deleted_at
- manage_inventory
- allow_backorder

1926
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

File diff suppressed because it is too large Load Diff

14
www/apps/api-reference/specs/admin/openapi.yaml
View File

@@ -240,6 +240,18 @@ tags:
These API routes allow admin users to view and manage notifications.
x-associatedSchema:
$ref: ./components/schemas/AdminNotification.yaml
- name: Order Changes
description: >
An order change is a proposed change to an order, such as adding or
removing items, changing shipping methods, and more. They can be
associated with order edits, claims, or exchanges.
These API routes allow admin users to manage order changes.
externalDocs:
description: Learn more about order changes.
url: https://docs.medusajs.com/resources/commerce-modules/order/order-change
x-associatedSchema:
$ref: ./components/schemas/AdminOrderChange.yaml
- name: Order Edits
description: >
An order edit is a change to an order's details, such as items, shipping
@@ -910,6 +922,8 @@ paths:
$ref: paths/admin_notifications.yaml
/admin/notifications/{id}:
$ref: paths/admin_notifications_{id}.yaml
/admin/order-changes/{id}:
$ref: paths/admin_order-changes_{id}.yaml
/admin/order-edits:
$ref: paths/admin_order-edits.yaml
/admin/order-edits/{id}:

1010
www/apps/api-reference/specs/admin/paths/admin_order-changes_{id}.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

269
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml
View File

@@ -665,6 +665,275 @@ delete:
type: boolean
title: with_deleted
description: The return's with deleted.
- name: created_at
in: query
description: Filter by the return's creation date.
required: false
schema:
type: object
description: Filter by the return's creation date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: An exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: The value to match.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
security:
- api_token: []
- cookie_auth: []

269
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml
View File

@@ -665,6 +665,275 @@ delete:
type: boolean
title: with_deleted
description: The return's with deleted.
- name: created_at
in: query
description: Filter by the return's creation date.
required: false
schema:
type: object
description: Filter by the return's creation date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: An exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: The value to match.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
security:
- api_token: []
- cookie_auth: []

269
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml
View File

@@ -664,6 +664,275 @@ delete:
type: boolean
title: with_deleted
description: The return's with deleted.
- name: created_at
in: query
description: Filter by the return's creation date.
required: false
schema:
type: object
description: Filter by the return's creation date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: An exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: The value to match.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
security:
- api_token: []
- cookie_auth: []

269
www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml
View File

@@ -664,6 +664,275 @@ delete:
type: boolean
title: with_deleted
description: The return's with deleted.
- name: created_at
in: query
description: Filter by the return's creation date.
required: false
schema:
type: object
description: Filter by the return's creation date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: An exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: The value to match.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: The values to not match.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
security:
- api_token: []
- cookie_auth: []

7
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml
View File

@@ -272,3 +272,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

7
www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml
View File

@@ -677,3 +677,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

7
www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml
View File

@@ -265,3 +265,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

6
www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml
View File

@@ -139,3 +139,9 @@ properties:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).

8
www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeResponse.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
description: The details of the order change.
x-schemaName: AdminOrderChangeResponse
required:
- order_change
properties:
order_change:
$ref: ./AdminOrderChange.yaml

7
www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml
View File

@@ -679,3 +679,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

3
www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml
View File

@@ -11,6 +11,7 @@ required:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -149,7 +150,7 @@ properties:
type: array
description: The variant's images.
items:
$ref: ./AdminProductImage.yaml
$ref: ./BaseProductImage.yaml
thumbnail:
type: string
title: thumbnail

8
www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml
View File

@@ -69,3 +69,11 @@ properties:
description: >-
Whether the promotion is tax inclusive. If enabled, the promotion is
applied after tax is calculated.
limit:
type: number
title: limit
description: The limit of times the promotion can be used.
used:
type: number
title: used
description: The number of times the promotion has been used.

10
www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrderChange.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
description: The data to update in the order change.
x-schemaName: AdminUpdateOrderChange
properties:
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).

7
www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml
View File

@@ -253,3 +253,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

2
www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml
View File

@@ -29,7 +29,7 @@ properties:
type: object
description: The image's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
rank:
type: number

6
www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml
View File

@@ -9,6 +9,7 @@ required:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -138,3 +139,8 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: ./BaseProductImage.yaml

7
www/apps/api-reference/specs/store/components/schemas/Order.yaml
View File

@@ -321,3 +321,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

6
www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml
View File

@@ -139,3 +139,9 @@ properties:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: >-
Whether promotions from the original order should be carried over to the
order change (specifically, exchanges).

5
www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml
View File

@@ -15,6 +15,7 @@ required:
- action
- details
- internal_note
- ordering
- created_at
- updated_at
properties:
@@ -98,3 +99,7 @@ properties:
format: date-time
title: updated_at
description: The date the action was updated.
ordering:
type: number
title: ordering
description: The action's ordering among other actions in the same order change.

7
www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml
View File

@@ -251,3 +251,10 @@ properties:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: >-
https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id

6
www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml
View File

@@ -124,6 +124,11 @@ properties:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: ./BaseProductImage.yaml
required:
- options
- length
@@ -139,6 +144,7 @@ required:
- hs_code
- mid_code
- material
- images
- deleted_at
- manage_inventory
- allow_backorder

98
www/apps/api-reference/specs/store/openapi.full.yaml
View File

@@ -14517,6 +14517,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminDraftOrderListResponse:
type: object
description: The list of draft orders with pagination fields.
@@ -15212,6 +15218,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the draft order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the draft order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminDraftOrderPreviewResponse:
type: object
description: The details of the preview on the draft order.
@@ -17027,6 +17039,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminOrderAddress:
type: object
description: An order address.
@@ -17248,6 +17266,10 @@ components:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
AdminOrderChangeAction:
type: object
description: The order change action's details.
@@ -17354,6 +17376,15 @@ components:
type: number
title: ordering
description: The action's order in the sequence of actions.
AdminOrderChangeResponse:
type: object
description: The details of the order change.
x-schemaName: AdminOrderChangeResponse
required:
- order_change
properties:
order_change:
$ref: '#/components/schemas/AdminOrderChange'
AdminOrderChangesResponse:
type: object
description: The details of an order's changes.
@@ -18386,6 +18417,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
AdminOrderPreviewResponse:
type: object
description: The preview of an order.
@@ -20305,6 +20342,7 @@ components:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -20439,7 +20477,7 @@ components:
type: array
description: The variant's images.
items:
$ref: '#/components/schemas/AdminProductImage'
$ref: '#/components/schemas/BaseProductImage'
thumbnail:
type: string
title: thumbnail
@@ -20733,6 +20771,14 @@ components:
type: boolean
title: is_tax_inclusive
description: Whether the promotion is tax inclusive. If enabled, the promotion is applied after tax is calculated.
limit:
type: number
title: limit
description: The limit of times the promotion can be used.
used:
type: number
title: used
description: The number of times the promotion has been used.
AdminPromotionResponse:
type: object
description: The promotion's details.
@@ -23466,6 +23512,15 @@ components:
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
AdminUpdateOrderChange:
type: object
description: The data to update in the order change.
x-schemaName: AdminUpdateOrderChange
properties:
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
AdminUpdatePriceList:
type: object
description: the details to update in a price list.
@@ -26407,6 +26462,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
BaseOrderAddress:
type: object
description: An order address.
@@ -27875,7 +27936,7 @@ components:
type: object
description: The image's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/store#manage-metadata
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
rank:
type: number
@@ -28066,6 +28127,7 @@ components:
- ean
- upc
- thumbnail
- images
- allow_backorder
- manage_inventory
- hs_code
@@ -28191,6 +28253,11 @@ components:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: '#/components/schemas/BaseProductImage'
BasePromotionRuleValue:
type: object
description: The rule value's details.
@@ -29473,6 +29540,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
OrderAddress:
type: object
description: The address's details.
@@ -29691,6 +29764,10 @@ components:
format: date-time
title: updated_at
description: The date the order change was updated.
carry_over_promotions:
type: boolean
title: carry_over_promotions
description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
OrderChangeAction:
type: object
description: The order change action's details.
@@ -29709,6 +29786,7 @@ components:
- action
- details
- internal_note
- ordering
- created_at
- updated_at
properties:
@@ -29792,6 +29870,10 @@ components:
format: date-time
title: updated_at
description: The date the action was updated.
ordering:
type: number
title: ordering
description: The action's ordering among other actions in the same order change.
OrderClaim:
type: object
description: The order change's claim.
@@ -33119,6 +33201,12 @@ components:
type: number
title: shipping_discount_total
description: The total discount amount applied on the order's shipping.
custom_display_id:
type: string
title: custom_display_id
description: The custom display ID of the order.
externalDocs:
url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
StoreOrderAddress:
type: object
description: An order address
@@ -40030,6 +40118,11 @@ components:
type: string
title: thumbnail
description: The variant's thumbnail.
images:
type: array
description: The variant's images.
items:
$ref: '#/components/schemas/BaseProductImage'
required:
- options
- length
@@ -40045,6 +40138,7 @@ components:
- hs_code
- mid_code
- material
- images
- deleted_at
- manage_inventory
- allow_backorder

18
www/utils/generated/oas-output/base/admin.oas.base.yaml
View File

@@ -183,10 +183,10 @@ tags:
$ref: "#/components/schemas/AdminGiftCard"
- name: Index
description: >
The Index Module is a tool to perform high-performance queries across modules, for example, to filter linked modules.
The Index Module is a tool to perform high-performance queries across
modules, for example, to filter linked modules.
The Index Module is currently experimental and is hidden behind a feature flag. Learn more about it and how
to enable it in the [Index Module guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).
The Index Module is currently experimental and is hidden behind a feature flag. Learn more about it and how to enable it in the [Index Module guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).
- name: Inventory Items
description: |
An inventory item is a stock-kept product whose inventory is managed.
@@ -218,6 +218,18 @@ tags:
These API routes allow admin users to view and manage notifications.
x-associatedSchema:
$ref: "#/components/schemas/AdminNotification"
- name: Order Changes
description: >
An order change is a proposed change to an order, such as adding or
removing items, changing shipping methods, and more. They can be associated
with order edits, claims, or exchanges.
These API routes allow admin users to manage order changes.
externalDocs:
description: Learn more about order changes.
url: https://docs.medusajs.com/resources/commerce-modules/order/order-change
x-associatedSchema:
$ref: "#/components/schemas/AdminOrderChange"
- name: Order Edits
description: >
An order edit is a change to an order's details, such as items, shipping

231
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts
View File

@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

231
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts
View File

@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

231
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts
View File

@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

231
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts
View File

@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

6
www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts
View File

@@ -59,7 +59,11 @@
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/draft-orders/{id}' \
* -H 'Authorization: Bearer {jwt_token}'
* -H 'Authorization: Bearer {jwt_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "email": "test@test.com"
* }'
* tags:
* - Draft Orders
* responses:

894
www/utils/generated/oas-output/operations/admin/post_admin_order-changes_[id].ts Normal file
View File

@@ -0,0 +1,894 @@
/**
* @oas [post] /admin/order-changes/{id}
* operationId: PostOrderChangesId
* summary: Update an Order Change
* x-sidebar-summary: Update Order Change
* description: Update an order change's details. An order change can be an exchange, claim, or edit. For example, you can edit whether an exchange carries over the parent order's promotion.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The order change's ID.
* required: true
* schema:
* type: string
* - name: created_at
* in: query
* description: Filter by the order change's creation date.
* required: false
* schema:
* type: object
* description: Filter by the order change's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: Filter by the order change's update date.
* required: false
* schema:
* type: object
* description: Filter by the order change's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: Filter by the order change's deletion date.
* required: false
* schema:
* type: object
* description: Filter by the order change's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by an order change's ID.
* - type: array
* description: Filter by order change IDs.
* items:
* type: string
* title: id
* description: An order change's ID.
* - type: object
* description: Filter by order change IDs.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: status
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: status
* description: Filter by an order change's status.
* - type: array
* description: Filter by order change statuses.
* items:
* type: string
* title: status
* description: An order change's status.
* - type: object
* description: Filter by order change statuses.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: change_type
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: change_type
* description: Filter by the order change's change type.
* - type: array
* description: Filter by order change types.
* items:
* type: string
* title: change_type
* description: The order change type.
* - type: object
* description: Filter by order change types.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - 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: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminUpdateOrderChange"
* 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.order.updateOrderChange(
* "ordch_123",
* {
* carry_over_promotions: true
* }
* )
* .then(({ order_change }) => {
* console.log(order_change)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/order-changes/{id}' \
* -H 'Authorization: Bearer {access_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "carry_over_promotions": true
* }'
* tags:
* - Order Changes
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminOrderChangeResponse"
* "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-workflow: updateOrderChangeWorkflow
* x-events: []
* x-since: 2.12.0
*
*/

7
www/utils/generated/oas-output/schemas/AdminDraftOrder.ts
View File

@@ -268,6 +268,11 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the draft order's shipping.
*
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the draft order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*/

6
www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts
View File

@@ -653,6 +653,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the draft order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the draft order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/

6
www/utils/generated/oas-output/schemas/AdminOrder.ts
View File

@@ -267,6 +267,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/

4
www/utils/generated/oas-output/schemas/AdminOrderChange.ts
View File

@@ -139,6 +139,10 @@
* format: date-time
* title: updated_at
* description: The date the order change was updated.
* carry_over_promotions:
* type: boolean
* title: carry_over_promotions
* description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
*
*/

13
www/utils/generated/oas-output/schemas/AdminOrderChangeResponse.ts Normal file
View File

@@ -0,0 +1,13 @@
/**
* @schema AdminOrderChangeResponse
* type: object
* description: The details of the order change.
* x-schemaName: AdminOrderChangeResponse
* required:
* - order_change
* properties:
* order_change:
* $ref: "#/components/schemas/AdminOrderChange"
*
*/

6
www/utils/generated/oas-output/schemas/AdminOrderPreview.ts
View File

@@ -653,6 +653,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/

3
www/utils/generated/oas-output/schemas/AdminProductVariant.ts
View File

@@ -13,6 +13,7 @@
* - ean
* - upc
* - thumbnail
* - images
* - allow_backorder
* - manage_inventory
* - hs_code
@@ -147,7 +148,7 @@
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/AdminProductImage"
* $ref: "#/components/schemas/BaseProductImage"
* thumbnail:
* type: string
* title: thumbnail

8
www/utils/generated/oas-output/schemas/AdminPromotion.ts
View File

@@ -67,6 +67,14 @@
* type: boolean
* title: is_tax_inclusive
* description: Whether the promotion is tax inclusive. If enabled, the promotion is applied after tax is calculated.
* limit:
* type: number
* title: limit
* description: The limit of times the promotion can be used.
* used:
* type: number
* title: used
* description: The number of times the promotion has been used.
*
*/

13
www/utils/generated/oas-output/schemas/AdminUpdateOrderChange.ts Normal file
View File

@@ -0,0 +1,13 @@
/**
* @schema AdminUpdateOrderChange
* type: object
* description: The data to update in the order change.
* x-schemaName: AdminUpdateOrderChange
* properties:
* carry_over_promotions:
* type: boolean
* title: carry_over_promotions
* description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
*
*/

6
www/utils/generated/oas-output/schemas/BaseOrder.ts
View File

@@ -255,6 +255,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/

2
www/utils/generated/oas-output/schemas/BaseProductImage.ts
View File

@@ -31,7 +31,7 @@
* type: object
* description: The image's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/store#manage-metadata
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* rank:
* type: number

6
www/utils/generated/oas-output/schemas/BaseProductVariant.ts
View File

@@ -11,6 +11,7 @@
* - ean
* - upc
* - thumbnail
* - images
* - allow_backorder
* - manage_inventory
* - hs_code
@@ -136,6 +137,11 @@
* type: string
* title: thumbnail
* description: The variant's thumbnail.
* images:
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
*
*/

6
www/utils/generated/oas-output/schemas/Order.ts
View File

@@ -319,6 +319,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/

4
www/utils/generated/oas-output/schemas/OrderChange.ts
View File

@@ -139,6 +139,10 @@
* format: date-time
* title: updated_at
* description: The date the order change was updated.
* carry_over_promotions:
* type: boolean
* title: carry_over_promotions
* description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
*
*/

5
www/utils/generated/oas-output/schemas/OrderChangeAction.ts
View File

@@ -17,6 +17,7 @@
* - action
* - details
* - internal_note
* - ordering
* - created_at
* - updated_at
* properties:
@@ -100,6 +101,10 @@
* format: date-time
* title: updated_at
* description: The date the action was updated.
* ordering:
* type: number
* title: ordering
* description: The action's ordering among other actions in the same order change.
*
*/

6
www/utils/generated/oas-output/schemas/StoreOrder.ts
View File

@@ -253,6 +253,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/

6
www/utils/generated/oas-output/schemas/StoreProductVariant.ts
View File

@@ -120,6 +120,11 @@
* type: string
* title: thumbnail
* description: The variant's thumbnail.
* images:
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
* required:
* - options
* - length
@@ -135,6 +140,7 @@
* - hs_code
* - mid_code
* - material
* - images
* - deleted_at
* - manage_inventory
* - allow_backorder

3
www/utils/generated/route-examples-output/route-examples.json
View File

@@ -410,6 +410,9 @@
"POST /admin/orders/{orderid}/credit-lines": {
"js-sdk": "sdk.admin.order.createCreditLine(\n \"order_123\",\n {\n amount: 100,\n reference: \"order\",\n reference_id: \"order_123\",\n }\n)\n.then(({ order }) => {\n console.log(order)\n})"
},
"POST /admin/order-changes/{id}": {
"js-sdk": "sdk.admin.order.updateOrderChange(\n \"ordch_123\",\n {\n carry_over_promotions: true\n }\n)\n.then(({ order_change }) => {\n console.log(order_change)\n})"
},
"POST /admin/order-edits": {
"js-sdk": "sdk.admin.orderEdit.initiateRequest({\n order_id: \"order_123\"\n})\n.then(({ order_change }) => {\n console.log(order_change)\n})"
},

4
www/utils/packages/docs-generator/src/classes/generators/dml.ts
View File

@@ -61,7 +61,7 @@ class DmlGenerator extends AbstractGenerator {
)
this.generatorEventManager.emit(GeneratorEvent.FINISHED_GENERATE_EVENT)
console.log(`[DML] Finished generating OAS for ${file.fileName}.`)
console.log(`[DML] Finished generating DML for ${file.fileName}.`)
})
)
}
@@ -71,7 +71,7 @@ class DmlGenerator extends AbstractGenerator {
* and is an API file.
*
* @param fileName - The file path to check
* @returns Whether the OAS generator can run on this file.
* @returns Whether the DML generator can run on this file.
*/
isFileIncluded(fileName: string): boolean {
return (