Skip to content

chore: add to TSDocs note about removing item from order edit #12997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2025
Merged

chore: add to TSDocs note about removing item from order edit #12997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/core/core-flows/src/order/workflows/order-edit/order-edit-update-item-quantity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ export const orderEditUpdateItemQuantityWorkflowId =
* This workflow updates the quantity of an existing item in an order's edit. It's used by the
* [Update Order Item Quantity Admin API Route](https://docs.medusajs.com/api/admin#order-edits_postordereditsiditemsitemitem_id).
*
* You can also use this workflow to remove an item from an order by setting its quantity to `0`.
*
* You can use this workflow within your customizations or your own custom workflows, allowing you to update the quantity of an existing
* item in an order's edit in your custom flow.
*
Expand All @@ -98,7 +100,7 @@ export const orderEditUpdateItemQuantityWorkflowId =
*
* @summary
*
* Update the quantity of an existing order item in the order's edit.
* Update or remove an existing order item's quantity in the order's edit.
*/
export const orderEditUpdateItemQuantityWorkflow = createWorkflow(
orderEditUpdateItemQuantityWorkflowId,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/js-sdk/src/admin/order-edit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,8 @@ export class OrderEdit {
* [Update Item Quantity](https://docs.medusajs.com/api/admin#order-edits_postordereditsiditemsitemitem_id)
* API route.
*
* You can also use this method to remove an item from an order by setting the `quantity` to `0`.
*
* @param id - The order edit's ID.
* @param itemId - The item's ID in the order.
* @param body - The data to edit in the item.
Expand Down