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

docs: generate API reference for 2.12.0 (#14185)

Browse Source
This commit is contained in:
Shahed Nasser
2025-12-02 11:56:37 +02:00
committed by GitHub
parent 21f61ec160
commit 9372a17d1f
71 changed files with 6310 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/base/admin.oas.base.yaml
+15 -3
View File
@@ -183,10 +183,10 @@ tags:
$ref: "#/components/schemas/AdminGiftCard"
- name: Index
description: >
The Index Module is a tool to perform high-performance queries across modules, for example, to filter linked modules.
The Index Module is a tool to perform high-performance queries across
modules, for example, to filter linked modules.
The Index Module is currently experimental and is hidden behind a feature flag. Learn more about it and how
to enable it in the [Index Module guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).
The Index Module is currently experimental and is hidden behind a feature flag. Learn more about it and how to enable it in the [Index Module guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).
- name: Inventory Items
description: |
An inventory item is a stock-kept product whose inventory is managed.
@@ -218,6 +218,18 @@ tags:
These API routes allow admin users to view and manage notifications.
x-associatedSchema:
$ref: "#/components/schemas/AdminNotification"
- name: Order Changes
description: >
An order change is a proposed change to an order, such as adding or
removing items, changing shipping methods, and more. They can be associated
with order edits, claims, or exchanges.
These API routes allow admin users to manage order changes.
externalDocs:
description: Learn more about order changes.
url: https://docs.medusajs.com/resources/commerce-modules/order/order-change
x-associatedSchema:
$ref: "#/components/schemas/AdminOrderChange"
- name: Order Edits
description: >
An order edit is a change to an order's details, such as items, shipping
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts
+231
View File
@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts
+231
View File
@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts
+231
View File
@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts
+231
View File
@@ -475,6 +475,237 @@
* type: boolean
* title: with_deleted
* description: The return's with deleted.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts
+5 -1
View File
@@ -59,7 +59,11 @@
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/draft-orders/{id}' \
* -H 'Authorization: Bearer {jwt_token}'
* -H 'Authorization: Bearer {jwt_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "email": "test@test.com"
* }'
* tags:
* - Draft Orders
* responses:
www/utils/generated/oas-output/operations/admin/post_admin_order-changes_[id].ts
+894
View File
@@ -0,0 +1,894 @@
/**
* @oas [post] /admin/order-changes/{id}
* operationId: PostOrderChangesId
* summary: Update an Order Change
* x-sidebar-summary: Update Order Change
* description: Update an order change's details. An order change can be an exchange, claim, or edit. For example, you can edit whether an exchange carries over the parent order's promotion.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The order change's ID.
* required: true
* schema:
* type: string
* - name: created_at
* in: query
* description: Filter by the order change's creation date.
* required: false
* schema:
* type: object
* description: Filter by the order change's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: Filter by the order change's update date.
* required: false
* schema:
* type: object
* description: Filter by the order change's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: Filter by the order change's deletion date.
* required: false
* schema:
* type: object
* description: Filter by the order change's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by an order change's ID.
* - type: array
* description: Filter by order change IDs.
* items:
* type: string
* title: id
* description: An order change's ID.
* - type: object
* description: Filter by order change IDs.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: status
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: status
* description: Filter by an order change's status.
* - type: array
* description: Filter by order change statuses.
* items:
* type: string
* title: status
* description: An order change's status.
* - type: object
* description: Filter by order change statuses.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: change_type
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: change_type
* description: Filter by the order change's change type.
* - type: array
* description: Filter by order change types.
* items:
* type: string
* title: change_type
* description: The order change type.
* - type: object
* description: Filter by order change types.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. Without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminUpdateOrderChange"
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.order.updateOrderChange(
* "ordch_123",
* {
* carry_over_promotions: true
* }
* )
* .then(({ order_change }) => {
* console.log(order_change)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/order-changes/{id}' \
* -H 'Authorization: Bearer {access_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "carry_over_promotions": true
* }'
* tags:
* - Order Changes
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminOrderChangeResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: updateOrderChangeWorkflow
* x-events: []
* x-since: 2.12.0
*
*/
www/utils/generated/oas-output/schemas/AdminDraftOrder.ts
+6 -1
View File
@@ -268,6 +268,11 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the draft order's shipping.
*
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the draft order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*/
www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts
+6
View File
@@ -653,6 +653,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the draft order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the draft order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/
www/utils/generated/oas-output/schemas/AdminOrder.ts
+6
View File
@@ -267,6 +267,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/
www/utils/generated/oas-output/schemas/AdminOrderChange.ts
+4
View File
@@ -139,6 +139,10 @@
* format: date-time
* title: updated_at
* description: The date the order change was updated.
* carry_over_promotions:
* type: boolean
* title: carry_over_promotions
* description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
*
*/
www/utils/generated/oas-output/schemas/AdminOrderChangeResponse.ts
+13
View File
@@ -0,0 +1,13 @@
/**
* @schema AdminOrderChangeResponse
* type: object
* description: The details of the order change.
* x-schemaName: AdminOrderChangeResponse
* required:
* - order_change
* properties:
* order_change:
* $ref: "#/components/schemas/AdminOrderChange"
*
*/
www/utils/generated/oas-output/schemas/AdminOrderPreview.ts
+6
View File
@@ -653,6 +653,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/
www/utils/generated/oas-output/schemas/AdminProductVariant.ts
+2 -1
View File
@@ -13,6 +13,7 @@
* - ean
* - upc
* - thumbnail
* - images
* - allow_backorder
* - manage_inventory
* - hs_code
@@ -147,7 +148,7 @@
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/AdminProductImage"
* $ref: "#/components/schemas/BaseProductImage"
* thumbnail:
* type: string
* title: thumbnail
www/utils/generated/oas-output/schemas/AdminPromotion.ts
+8
View File
@@ -67,6 +67,14 @@
* type: boolean
* title: is_tax_inclusive
* description: Whether the promotion is tax inclusive. If enabled, the promotion is applied after tax is calculated.
* limit:
* type: number
* title: limit
* description: The limit of times the promotion can be used.
* used:
* type: number
* title: used
* description: The number of times the promotion has been used.
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateOrderChange.ts
+13
View File
@@ -0,0 +1,13 @@
/**
* @schema AdminUpdateOrderChange
* type: object
* description: The data to update in the order change.
* x-schemaName: AdminUpdateOrderChange
* properties:
* carry_over_promotions:
* type: boolean
* title: carry_over_promotions
* description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
*
*/
www/utils/generated/oas-output/schemas/BaseOrder.ts
+6
View File
@@ -255,6 +255,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/
www/utils/generated/oas-output/schemas/BaseProductImage.ts
+1 -1
View File
@@ -31,7 +31,7 @@
* type: object
* description: The image's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/store#manage-metadata
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* rank:
* type: number
www/utils/generated/oas-output/schemas/BaseProductVariant.ts
+6
View File
@@ -11,6 +11,7 @@
* - ean
* - upc
* - thumbnail
* - images
* - allow_backorder
* - manage_inventory
* - hs_code
@@ -136,6 +137,11 @@
* type: string
* title: thumbnail
* description: The variant's thumbnail.
* images:
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
*
*/
www/utils/generated/oas-output/schemas/Order.ts
+6
View File
@@ -319,6 +319,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/
www/utils/generated/oas-output/schemas/OrderChange.ts
+4
View File
@@ -139,6 +139,10 @@
* format: date-time
* title: updated_at
* description: The date the order change was updated.
* carry_over_promotions:
* type: boolean
* title: carry_over_promotions
* description: Whether promotions from the original order should be carried over to the order change (specifically, exchanges).
*
*/
www/utils/generated/oas-output/schemas/OrderChangeAction.ts
+5
View File
@@ -17,6 +17,7 @@
* - action
* - details
* - internal_note
* - ordering
* - created_at
* - updated_at
* properties:
@@ -100,6 +101,10 @@
* format: date-time
* title: updated_at
* description: The date the action was updated.
* ordering:
* type: number
* title: ordering
* description: The action's ordering among other actions in the same order change.
*
*/
www/utils/generated/oas-output/schemas/StoreOrder.ts
+6
View File
@@ -253,6 +253,12 @@
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
* custom_display_id:
* type: string
* title: custom_display_id
* description: The custom display ID of the order.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/order/custom-display-id
*
*/
www/utils/generated/oas-output/schemas/StoreProductVariant.ts
+6
View File
@@ -120,6 +120,11 @@
* type: string
* title: thumbnail
* description: The variant's thumbnail.
* images:
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
* required:
* - options
* - length
@@ -135,6 +140,7 @@
* - hs_code
* - mid_code
* - material
* - images
* - deleted_at
* - manage_inventory
* - allow_backorder
www/utils/generated/route-examples-output/route-examples.json
+3
View File
@@ -410,6 +410,9 @@
"POST /admin/orders/{orderid}/credit-lines": {
"js-sdk": "sdk.admin.order.createCreditLine(\n \"order_123\",\n {\n amount: 100,\n reference: \"order\",\n reference_id: \"order_123\",\n }\n)\n.then(({ order }) => {\n console.log(order)\n})"
},
"POST /admin/order-changes/{id}": {
"js-sdk": "sdk.admin.order.updateOrderChange(\n \"ordch_123\",\n {\n carry_over_promotions: true\n }\n)\n.then(({ order_change }) => {\n console.log(order_change)\n})"
},
"POST /admin/order-edits": {
"js-sdk": "sdk.admin.orderEdit.initiateRequest({\n order_id: \"order_123\"\n})\n.then(({ order_change }) => {\n console.log(order_change)\n})"
},
www/utils/packages/docs-generator/src/classes/generators/dml.ts
+2 -2
View File
@@ -61,7 +61,7 @@ class DmlGenerator extends AbstractGenerator {
)
this.generatorEventManager.emit(GeneratorEvent.FINISHED_GENERATE_EVENT)
console.log(`[DML] Finished generating OAS for ${file.fileName}.`)
console.log(`[DML] Finished generating DML for ${file.fileName}.`)
})
)
}
@@ -71,7 +71,7 @@ class DmlGenerator extends AbstractGenerator {
* and is an API file.
*
* @param fileName - The file path to check
* @returns Whether the OAS generator can run on this file.
* @returns Whether the DML generator can run on this file.
*/
isFileIncluded(fileName: string): boolean {
return (