diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-changes_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-changes_{id}/post.js new file mode 100644 index 0000000000..17f262996d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-changes_{id}/post.js @@ -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) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/post.sh index 7e9ec3cfd6..680c9b7bb0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/draft-orders/{id}' \ --H 'Authorization: Bearer {jwt_token}' \ No newline at end of file +-H 'Authorization: Bearer {jwt_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "test@test.com" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-changes_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-changes_{id}/post.sh new file mode 100644 index 0000000000..af1d1f8f64 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-changes_{id}/post.sh @@ -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 +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml index cd53e5a4d8..8fb3e97426 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml index fc94f43fd6..5d93096784 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index d5ef04cbb6..6b0d35f608 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml index 4d3dfde938..73d3162a7c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml @@ -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). diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeResponse.yaml new file mode 100644 index 0000000000..1f58ee4620 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeResponse.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index 5f41690cc1..945a5891a8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml index 8656985d38..dbe5464485 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml index 1864b76ff4..328bda8125 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrderChange.yaml new file mode 100644 index 0000000000..24c05a8872 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrderChange.yaml @@ -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). diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml index 0fc1642862..bff1b8d05d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml index cb6694260c..5879af434b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml index e23119a7a4..6f4302c80f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index 10009c77de..b8dfdaab66 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml index 72b1f74a7b..efd22cce6b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml @@ -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). diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml index d21c904f16..5d21420cca 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml @@ -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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index 2b757df371..f503058e47 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml index a65d0c9496..25a0713ecc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 3ada23cab4..6ac4bd006a 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -180,6 +180,15 @@ 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 methods, and more. @@ -18403,7 +18412,11 @@ paths: 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: @@ -26194,6 +26207,895 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/order-changes/{id}: + post: + 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 /admin/order-edits: post: operationId: PostOrderEdits @@ -49210,6 +50112,237 @@ paths: 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: [] @@ -50081,6 +51214,237 @@ paths: 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: [] @@ -51040,6 +52404,237 @@ paths: 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: [] @@ -51739,6 +53334,237 @@ paths: 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: [] @@ -69335,6 +71161,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. @@ -70030,6 +71862,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. @@ -71845,6 +73683,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. @@ -72066,6 +73910,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. @@ -72172,6 +74020,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. @@ -73204,6 +75061,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. @@ -75123,6 +76986,7 @@ components: - ean - upc - thumbnail + - images - allow_backorder - manage_inventory - hs_code @@ -75257,7 +77121,7 @@ components: type: array description: The variant's images. items: - $ref: '#/components/schemas/AdminProductImage' + $ref: '#/components/schemas/BaseProductImage' thumbnail: type: string title: thumbnail @@ -75551,6 +77415,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. @@ -78284,6 +80156,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. @@ -81225,6 +83106,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. @@ -82693,7 +84580,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 @@ -82884,6 +84771,7 @@ components: - ean - upc - thumbnail + - images - allow_backorder - manage_inventory - hs_code @@ -83009,6 +84897,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. @@ -84291,6 +86184,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. @@ -84509,6 +86408,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. @@ -84527,6 +86430,7 @@ components: - action - details - internal_note + - ordering - created_at - updated_at properties: @@ -84610,6 +86514,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. @@ -87937,6 +89845,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 @@ -94848,6 +96762,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 @@ -94863,6 +96782,7 @@ components: - hs_code - mid_code - material + - images - deleted_at - manage_inventory - allow_backorder diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 9ef9350b86..81ca3a8c38 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -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}: diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-changes_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-changes_{id}.yaml new file mode 100644 index 0000000000..67f72e2d45 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-changes_{id}.yaml @@ -0,0 +1,1010 @@ +post: + 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.yaml + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: ../code_samples/JavaScript/admin_order-changes_{id}/post.js + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-changes_{id}/post.sh + tags: + - Order Changes + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderChangeResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateOrderChangeWorkflow + x-events: [] + x-since: 2.12.0 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml index 6751a48b6f..1cd0a36c61 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml index 549ca89152..971a3470f2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml index 25650282ca..d37310572b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml index bad63bcbe6..400e3fe78d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml index cd53e5a4d8..8fb3e97426 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml index fc94f43fd6..5d93096784 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index d5ef04cbb6..6b0d35f608 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml index 4d3dfde938..73d3162a7c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml @@ -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). diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeResponse.yaml new file mode 100644 index 0000000000..1f58ee4620 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeResponse.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index 5f41690cc1..945a5891a8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml index 8656985d38..dbe5464485 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml index 1864b76ff4..328bda8125 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrderChange.yaml new file mode 100644 index 0000000000..24c05a8872 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrderChange.yaml @@ -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). diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml index 0fc1642862..bff1b8d05d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml index cb6694260c..5879af434b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml index e23119a7a4..6f4302c80f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index 10009c77de..b8dfdaab66 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml index 72b1f74a7b..efd22cce6b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml @@ -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). diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml index d21c904f16..5d21420cca 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml @@ -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. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index 2b757df371..f503058e47 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml index a65d0c9496..25a0713ecc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml @@ -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 diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index e09541171f..2d88e157b1 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -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 diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index 4acb4c7fc9..6b5a0bff68 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts index cc728385a6..234ae64476 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts index f199a059a2..623e677887 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts index a1861cae0c..11d3e7e244 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts index 32e8973e18..2ec8dcbf68 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts index 0fbef01102..4e9538ece2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-changes_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-changes_[id].ts new file mode 100644 index 0000000000..d488458284 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-changes_[id].ts @@ -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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts index 1e94c3734d..8cb8534954 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts @@ -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 */ diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts index fb6906f3c6..9041abe54c 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts @@ -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 * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index 9d5a138bd5..485dabee93 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -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 * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts index 3edcf092b2..afac873a40 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts @@ -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). * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChangeResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderChangeResponse.ts new file mode 100644 index 0000000000..e38b2bd1eb --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderChangeResponse.ts @@ -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" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index 24190425f7..76ad51efb7 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -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 * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts index 23df19ae7b..9b3d0c1fa8 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -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 diff --git a/www/utils/generated/oas-output/schemas/AdminPromotion.ts b/www/utils/generated/oas-output/schemas/AdminPromotion.ts index 268bcfd425..f2b7ed8e31 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotion.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotion.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateOrderChange.ts b/www/utils/generated/oas-output/schemas/AdminUpdateOrderChange.ts new file mode 100644 index 0000000000..8f780ef935 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateOrderChange.ts @@ -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). + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrder.ts b/www/utils/generated/oas-output/schemas/BaseOrder.ts index 3addf668e3..d697a82a14 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrder.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrder.ts @@ -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 * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductImage.ts b/www/utils/generated/oas-output/schemas/BaseProductImage.ts index 430bee969a..f0ab631228 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductImage.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductImage.ts @@ -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 diff --git a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts index 2f0cdc2f58..48732fb739 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts @@ -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" * */ diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index d701398427..121fffe959 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -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 * */ diff --git a/www/utils/generated/oas-output/schemas/OrderChange.ts b/www/utils/generated/oas-output/schemas/OrderChange.ts index 7084d2a421..5854b8a0a7 100644 --- a/www/utils/generated/oas-output/schemas/OrderChange.ts +++ b/www/utils/generated/oas-output/schemas/OrderChange.ts @@ -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). * */ diff --git a/www/utils/generated/oas-output/schemas/OrderChangeAction.ts b/www/utils/generated/oas-output/schemas/OrderChangeAction.ts index 7f94b5fe54..2be8a6cfb8 100644 --- a/www/utils/generated/oas-output/schemas/OrderChangeAction.ts +++ b/www/utils/generated/oas-output/schemas/OrderChangeAction.ts @@ -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. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index a535b6f31f..61c8236b0d 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -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 * */ diff --git a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts index f44319cd56..f75542dcf2 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts @@ -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 diff --git a/www/utils/generated/route-examples-output/route-examples.json b/www/utils/generated/route-examples-output/route-examples.json index 9e4a5feba1..d2ba3d0811 100644 --- a/www/utils/generated/route-examples-output/route-examples.json +++ b/www/utils/generated/route-examples-output/route-examples.json @@ -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})" }, diff --git a/www/utils/packages/docs-generator/src/classes/generators/dml.ts b/www/utils/packages/docs-generator/src/classes/generators/dml.ts index 06c4f6a131..12d1359a01 100644 --- a/www/utils/packages/docs-generator/src/classes/generators/dml.ts +++ b/www/utils/packages/docs-generator/src/classes/generators/dml.ts @@ -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 (