Menu

updateCartsStep - Medusa Core Workflows Reference

This documentation provides a reference to the updateCartsStep. It belongs to the @medusajs/medusa/core-flows package.

This step updates a cart.

Example#

Code
1const data = updateCartsStep([{2  id: "cart_123",3  email: "customer@gmail.com",4}])

Input#

UpdateCartsStepInputUpdateCartsStepInput
The details of the carts to update.
idstring
The ID of the cart to update.
promo_codesstring[]Optional
An array of promotional codes applied on the cart.
region_idstringOptional
The ID of the cart's region.
customer_idnull | stringOptional
The ID of the cart's customer.
sales_channel_idnull | stringOptional
The ID of the cart's sales channel.
emailnull | stringOptional
The email address of the cart's customer.
currency_codestringOptional
The currency code for the cart.
metadatanull | Record<string, unknown>Optional
Custom key-value pairs of data related to the cart.
shipping_addressnull | UpdateAddressDTO | CreateAddressDTOOptional
The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.
billing_addressnull | UpdateAddressDTO | CreateAddressDTOOptional
The cart's billing address. You can either update the cart's existing billing address, or create a new one.

Output#

CartDTO[]CartDTO[]
idstring
The ID of the cart.
currency_codestring
The currency of the cart
original_item_totalBigNumberValue
The original item total of the cart.
original_item_subtotalBigNumberValue
The original item subtotal of the cart.
original_item_tax_totalBigNumberValue
The original item tax total of the cart.
item_totalBigNumberValue
The item total of the cart.
item_subtotalBigNumberValue
The item subtotal of the cart.
item_tax_totalBigNumberValue
The item tax total of the cart.
original_totalBigNumberValue
The original total of the cart.
original_subtotalBigNumberValue
The original subtotal of the cart.
original_tax_totalBigNumberValue
The original tax total of the cart.
totalBigNumberValue
The total of the cart.
subtotalBigNumberValue
The subtotal of the cart. (Excluding taxes)
tax_totalBigNumberValue
The tax total of the cart.
discount_totalBigNumberValue
The discount total of the cart.
discount_tax_totalBigNumberValue
The discount tax total of the cart.
gift_card_totalBigNumberValue
The gift card total of the cart.
gift_card_tax_totalBigNumberValue
The gift card tax total of the cart.
shipping_totalBigNumberValue
The shipping total of the cart.
shipping_subtotalBigNumberValue
The shipping subtotal of the cart.
shipping_tax_totalBigNumberValue
The shipping tax total of the cart.
original_shipping_totalBigNumberValue
The original shipping total of the cart.
original_shipping_subtotalBigNumberValue
The original shipping subtotal of the cart.
original_shipping_tax_totalBigNumberValue
The original shipping tax total of the cart.
raw_original_item_totalBigNumberRawValue
The raw original item total of the cart.
raw_original_item_subtotalBigNumberRawValue
The raw original item subtotal of the cart.
raw_original_item_tax_totalBigNumberRawValue
The raw original item tax total of the cart.
raw_item_totalBigNumberRawValue
The raw item total of the cart.
raw_item_subtotalBigNumberRawValue
The raw item subtotal of the cart.
raw_item_tax_totalBigNumberRawValue
The raw item tax total of the cart.
raw_original_totalBigNumberRawValue
The raw original total of the cart.
raw_original_subtotalBigNumberRawValue
The raw original subtotal of the cart.
raw_original_tax_totalBigNumberRawValue
The raw original tax total of the cart.
raw_totalBigNumberRawValue
The raw total of the cart.
raw_subtotalBigNumberRawValue
The raw subtotal of the cart. (Excluding taxes)
raw_tax_totalBigNumberRawValue
The raw tax total of the cart.
raw_discount_totalBigNumberRawValue
The raw discount total of the cart.
raw_discount_tax_totalBigNumberRawValue
The raw discount tax total of the cart.
raw_gift_card_totalBigNumberRawValue
The raw gift card total of the cart.
raw_gift_card_tax_totalBigNumberRawValue
The raw gift card tax total of the cart.
raw_shipping_totalBigNumberRawValue
The raw shipping total of the cart.
raw_shipping_subtotalBigNumberRawValue
The raw shipping subtotal of the cart.
raw_shipping_tax_totalBigNumberRawValue
The raw shipping tax total of the cart.
raw_original_shipping_totalBigNumberRawValue
The raw original shipping total of the cart.
raw_original_shipping_subtotalBigNumberRawValue
The raw original shipping subtotal of the cart.
raw_original_shipping_tax_totalBigNumberRawValue
The raw original shipping tax total of the cart.
raw_credit_line_totalBigNumberRawValue
The raw credit lines total of the cart.
credit_line_totalBigNumberValue
The credit lines total of the cart.
region_idstringOptional
The ID of the region the cart belongs to.
customer_idstringOptional
The ID of the associated customer
sales_channel_idstringOptional
The ID of the sales channel the cart belongs to.
emailstringOptional
The email of the customer that owns the cart.
shipping_addressCartAddressDTOOptional
The associated shipping address.
billing_addressCartAddressDTOOptional
The associated billing address.
itemsCartLineItemDTO[]Optional
The associated line items.
credit_linesCartCreditLineDTO[]Optional
The credit lines for a cart
shipping_methodsCartShippingMethodDTO[]Optional
The associated shipping methods
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
completed_atstring | DateOptional
When the cart was completed.
created_atstring | DateOptional
When the cart was created.
updated_atstring | DateOptional
When the cart was updated.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵