- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
addOrderLineItemsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the addOrderLineItemsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow adds line items to an order. This is useful when making edits to an order. It's used by other workflows, such as orderEditAddNewItemWorkflow.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to an order.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
OrderAddLineItemWorkflowInputOrderAddLineItemWorkflowInput
OrderAddLineItemWorkflowInputOrderAddLineItemWorkflowInputorder_idstringThe ID of the order to add the line items to.
order_idstringitemsNewItem[]The items to add to the order.
itemsNewItem[]Output#
OrderAddLineItemWorkflowOutputOrderAddLineItemWorkflowOutputThe created order line items.
OrderAddLineItemWorkflowOutputOrderAddLineItemWorkflowOutputoriginal_totalBigNumberValueThe original total of the order line item.
original_totalBigNumberValueoriginal_subtotalBigNumberValueThe original subtotal of the order line item.
original_subtotalBigNumberValueoriginal_tax_totalBigNumberValueThe original tax total of the order line item.
original_tax_totalBigNumberValueitem_totalBigNumberValueThe item total of the order line item.
item_totalBigNumberValueitem_subtotalBigNumberValueThe item subtotal of the order line item.
item_subtotalBigNumberValueitem_tax_totalBigNumberValueThe item tax total of the order line item.
item_tax_totalBigNumberValuetotalBigNumberValueThe total of the order line item.
totalBigNumberValuesubtotalBigNumberValueThe subtotal of the order line item.
subtotalBigNumberValuetax_totalBigNumberValueThe tax total of the order line item.
tax_totalBigNumberValuediscount_totalBigNumberValueThe discount total of the order line item.
discount_totalBigNumberValuediscount_tax_totalBigNumberValueThe discount tax total of the order line item.
discount_tax_totalBigNumberValuerefundable_totalBigNumberValueThe refundable total of the order line item.
refundable_totalBigNumberValuerefundable_total_per_unitBigNumberValueThe refundable total per unit of the order line item.
refundable_total_per_unitBigNumberValueidstringThe ID of the line item.
idstringtitlestringThe title of the line item.
titlestringrequires_shippingbooleanIndicates whether the line item requires shipping.
requires_shippingbooleanis_discountablebooleanIndicates whether the line item is discountable.
is_discountablebooleanis_tax_inclusivebooleanIndicates whether the line item price is tax inclusive.
is_tax_inclusivebooleanunit_pricenumberThe unit price of the line item.
unit_pricenumberquantitynumberThe quantity of the line item.
quantitynumberdetailOrderItemDTOThe details of the item
detailOrderItemDTOcreated_atDateThe date when the line item was created.
created_atDateupdated_atDateThe date when the line item was last updated.
updated_atDatesubtitlenull | stringOptionalThe subtitle of the line item.
subtitlenull | stringOptionalthumbnailnull | stringOptionalThe thumbnail of the line item.
thumbnailnull | stringOptionalvariant_idnull | stringOptionalThe ID of the variant associated with the line item.
variant_idnull | stringOptionalproduct_idnull | stringOptionalThe ID of the product associated with the line item.
product_idnull | stringOptionalproduct_titlenull | stringOptionalThe title of the product associated with the line item.
product_titlenull | stringOptionalproduct_descriptionnull | stringOptionalThe description of the product associated with the line item.
product_descriptionnull | stringOptionalproduct_subtitlenull | stringOptionalThe subtitle of the product associated with the line item.
product_subtitlenull | stringOptionalproduct_type_idnull | stringOptionalThe ID of the type of the product associated with the line item.
product_type_idnull | stringOptionalproduct_typenull | stringOptionalThe type of the product associated with the line item.
product_typenull | stringOptionalproduct_collectionnull | stringOptionalThe collection of the product associated with the line item.
product_collectionnull | stringOptionalproduct_handlenull | stringOptionalThe handle of the product associated with the line item.
product_handlenull | stringOptionalvariant_skunull | stringOptionalThe SKU (stock keeping unit) of the variant associated with the line item.
variant_skunull | stringOptionalvariant_barcodenull | stringOptionalThe barcode of the variant associated with the line item.
variant_barcodenull | stringOptionalvariant_titlenull | stringOptionalThe title of the variant associated with the line item.
variant_titlenull | stringOptionalvariant_option_valuesnull | Record<string, unknown>OptionalThe option values of the variant associated with the line item.
variant_option_valuesnull | Record<string, unknown>Optionalcompare_at_unit_pricenumberOptionalThe compare at unit price of the line item.
compare_at_unit_pricenumberOptionalThe associated tax lines.
The associated adjustments.
metadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalWas this page helpful?