Medusa
  1. Carts
Medusa
  • Back to home
  • Store API
  • Carts
    • Auth
      • Customer Login (JWT)
      • Customer Login (JWT)
      • Check if Email Exists
      • Get Current Customer
      • Customer Log out
      • Customer Login
    • Create Payment Sessions
      POST
    • Refresh a Payment Session
      POST
    • Create a Cart
      POST
    • Complete a Cart
      POST
    • Select a Payment Session
      POST
    • Delete a Payment Session
      DELETE
    • Update a Payment Session
      POST
    • Get a Cart
      GET
    • Update a Cart
      POST
    • Add Shipping Method
      POST
    • Update a Line Item
      POST
    • Delete a Line Item
      DELETE
    • Add a Line Item
      POST
    • Calculate Cart Taxes
      POST
    • Remove Discount
      DELETE
  • Customers
    • Request Password Reset
      POST
    • Get Saved Payment Methods
      GET
    • Add a Shipping Address
      POST
    • Update Customer
      POST
    • Get a Customer
      GET
    • Update a Shipping Address
      POST
    • Delete an Address
      DELETE
    • Create a Customer
      POST
    • Reset Password
      POST
    • List Orders
      GET
  • Gift Cards
    • Get Gift Card by Code
      GET
  • Orders
    • 77
      • Claim Order
    • Verify Order Claim
    • Get an Order
    • Look Up an Order
    • Get by Cart ID
  • Order Edits
    • Complete an Order Edit
    • Retrieve an Order Edit
    • Decline an Order Edit
  • Payment Collections
    • Authorize Payment Session
    • Authorize Payment Sessions
    • Refresh a Payment Session
    • Get a PaymentCollection
    • Manage Payment Sessions
    • Create a Payment Session
  • Products
    • Search Products
    • List Products
    • Get a Product
  • Product Variants
    • Get a Product Variant
    • Get Product Variants
  • Product Tags
    • List Product Tags
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Product Collections
    • Get a Collection
    • List Collections
  • Product Types
    • List Product Types
  • Regions
    • List Regions
    • Get a Region
  • Returns
    • Create Return
  • Return Reasons
    • List Return Reasons
    • Get a Return Reason
  • Shipping Options
    • List for Cart
    • Get Shipping Options
  • Swaps
    • Get by Cart ID
    • Create a Swap
  1. Carts

Update a Cart

POST
/store/carts/{id}
Store API/CartsCarts
Update a Cart's details. If the cart has payment sessions and the region was not changed, the payment sessions are updated. The cart's totals are also recalculated.

Request

Path Params
id
string 
required
The ID of the Cart.
Body Params application/json
region_id
string 
optional
The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency.
email
string <email>
optional
An email to be used on the Cart.
sales_channel_id
string 
optional
The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources.
customer_id
string 
optional
The ID of the Customer to associate the Cart with.
country_code
string 
optional
The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address.
context
object 
optional
An object to provide context to the Cart. The context field is automatically populated with ip and user_agent
Example:
{"ip":"::1","user_agent":"Chrome"}
gift_cards
array [object {1}] 
optional
An array of Gift Card codes to add to the Cart.
code
string 
required
The code of a gift card.
discounts
array [object {1}] 
optional
An array of Discount codes to add to the Cart.
code
string 
required
The code of the discount.
billing_address
optional
The Address to be used for billing purposes.
Any of
Address fields used when creating/updating an address.
first_name
string 
optional
First name
Example:
Arno
last_name
string 
optional
Last name
Example:
Willms
phone
string 
optional
Phone Number
Example:
16128234334802
company
string 
optional
Company
address_1
string 
optional
Address line 1
Example:
14433 Kemmer Court
address_2
string 
optional
Address line 2
Example:
Suite 369
city
string 
optional
City
Example:
South Geoffreyview
province
string 
optional
Province
Example:
Kentucky
postal_code
string 
optional
Postal Code
Example:
72093
country_code
string 
optional
The 2 character ISO code of the country in lower case
Example:
st
metadata
object 
optional
An optional key-value map with additional details
Example:
{"car":"white"}
shipping_address
optional
The Address to be used for shipping purposes.
Any of
Address fields used when creating/updating an address.
first_name
string 
optional
First name
Example:
Arno
last_name
string 
optional
Last name
Example:
Willms
phone
string 
optional
Phone Number
Example:
16128234334802
company
string 
optional
Company
address_1
string 
optional
Address line 1
Example:
14433 Kemmer Court
address_2
string 
optional
Address line 2
Example:
Suite 369
city
string 
optional
City
Example:
South Geoffreyview
province
string 
optional
Province
Example:
Kentucky
postal_code
string 
optional
Postal Code
Example:
72093
country_code
string 
optional
The 2 character ISO code of the country in lower case
Example:
st
metadata
object 
optional
An optional key-value map with additional details
Example:
{"car":"white"}
Example
{
  "region_id": "string",
  "email": "user@example.com",
  "sales_channel_id": "string",
  "customer_id": "string",
  "country_code": "string",
  "context": {
    "ip": "::1",
    "user_agent": "Chrome"
  },
  "gift_cards": [
    {
      "code": "string"
    }
  ],
  "discounts": [
    {
      "code": "string"
    }
  ],
  "billing_address": {
    "first_name": "Arno",
    "last_name": "Willms",
    "phone": 16128234334802,
    "company": "string",
    "address_1": "14433 Kemmer Court",
    "address_2": "Suite 369",
    "city": "South Geoffreyview",
    "province": "Kentucky",
    "postal_code": 72093,
    "country_code": "st",
    "metadata": {
      "car": "white"
    }
  },
  "shipping_address": {
    "first_name": "Arno",
    "last_name": "Willms",
    "phone": 16128234334802,
    "company": "string",
    "address_1": "14433 Kemmer Court",
    "address_2": "Suite 369",
    "city": "South Geoffreyview",
    "province": "Kentucky",
    "postal_code": 72093,
    "country_code": "st",
    "metadata": {
      "car": "white"
    }
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/store/carts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "region_id": "string",
    "email": "user@example.com",
    "sales_channel_id": "string",
    "customer_id": "string",
    "country_code": "string",
    "context": {
        "ip": "::1",
        "user_agent": "Chrome"
    },
    "gift_cards": [
        {
            "code": "string"
        }
    ],
    "discounts": [
        {
            "code": "string"
        }
    ],
    "billing_address": {
        "first_name": "Arno",
        "last_name": "Willms",
        "phone": 16128234334802,
        "company": "string",
        "address_1": "14433 Kemmer Court",
        "address_2": "Suite 369",
        "city": "South Geoffreyview",
        "province": "Kentucky",
        "postal_code": 72093,
        "country_code": "st",
        "metadata": {
            "car": "white"
        }
    },
    "shipping_address": {
        "first_name": "Arno",
        "last_name": "Willms",
        "phone": 16128234334802,
        "company": "string",
        "address_1": "14433 Kemmer Court",
        "address_2": "Suite 369",
        "city": "South Geoffreyview",
        "province": "Kentucky",
        "postal_code": 72093,
        "country_code": "st",
        "metadata": {
            "car": "white"
        }
    }
}'

Responses

🟢200OK
application/json
Body
The cart's details.
cart
object (Cart) 
required
A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.
id
string 
required
The cart's ID
Example:
cart_01G8ZH853Y6TFXWPG5EYE81X63
email
string <email> | null 
required
The email associated with the cart
billing_address_id
string  | null 
required
The billing address's ID
Example:
addr_01G8ZH853YPY9B94857DY91YGW
shipping_address_id
string  | null 
required
The shipping address's ID
Example:
addr_01G8ZH853YPY9B94857DY91YGW
region_id
string 
required
The region's ID
Example:
reg_01G1G5V26T9H8Y0M4JNE3YGA4G
customer_id
string  | null 
required
The customer's ID
Example:
cus_01G2SG30J8C85S4A5CHM2S1NS2
customer
object  | null 
optional
The details of the customer the cart belongs to.
payment_session
object  | null 
required
The details of the selected payment session in the cart.
payment_id
string  | null 
required
The payment's ID if available
Example:
pay_01G8ZCC5W42ZNY842124G7P5R9
payment
object  | null 
optional
The details of the payment associated with the cart.
completed_at
string <date-time> | null 
required
The date with timezone at which the cart was completed.
payment_authorized_at
string <date-time> | null 
required
The date with timezone at which the payment was authorized.
sales_channel_id
string  | null 
optional
The sales channel ID the cart is associated with.
Example:
null
created_at
string <date-time>
required
The date with timezone at which the resource was created.
updated_at
string <date-time>
required
The date with timezone at which the resource was updated.
deleted_at
string <date-time> | null 
required
The date with timezone at which the resource was deleted.
shipping_total
integer 
optional
The total of shipping
Example:
1000
discount_total
integer 
optional
The total of discount rounded
Example:
800
raw_discount_total
integer 
optional
The total of discount
Example:
800
item_tax_total
integer 
optional
The total of items with taxes
Example:
8000
shipping_tax_total
integer 
optional
The total of shipping with taxes
Example:
1000
tax_total
integer 
optional
The total of tax
Example:
0
refunded_total
integer 
optional
The total amount refunded if the order associated with this cart is returned.
Example:
0
total
integer 
optional
The total amount of the cart
Example:
8200
subtotal
integer 
optional
The subtotal of the cart
Example:
8000
refundable_amount
integer 
optional
The amount that can be refunded
Example:
8200
gift_card_total
integer 
optional
The total of gift cards
Example:
0
gift_card_tax_total
integer 
optional
The total of gift cards with taxes
Example:
0
payment_sessions
array [object] 
optional
The details of all payment sessions created on the cart.
type
enum<string> 
required
The cart's type.
Allowed values:
defaultswapdraft_orderpayment_linkclaim
Default:
default
idempotency_key
string  | null 
required
Randomly generated key used to continue the completion of a cart in case of failure.
context
object  | null 
required
The context of the cart which can include info like IP or user agent.
Example:
{"ip":"::1","user_agent":"PostmanRuntime/7.29.2"}
metadata
object  | null 
required
An optional key-value map with additional details
Example:
{"car":"white"}
billing_address
object (Address) 
optional
An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
sales_channel
object (Sales Channel) 
optional
A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
shipping_address
object (Address) 
optional
An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
shipping_methods
array[object (Shipping Method) {20}] 
optional
The details of the shipping methods added to the cart.
region
object (Region) 
optional
A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
gift_cards
array[object (Gift Card) {15}] 
optional
An array of details of all gift cards applied to the cart.
discounts
array[object (Discount) {18}] 
optional
An array of details of all discounts applied to the cart.
items
array[object (Line Item) {42}] 
optional
The line items added to the cart.
Example
🟠400Client Error or Multiple Errors
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2024-05-23 07:10:14
Previous
Get a Cart
Next
Add Shipping Method
Built with