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: []