Update a Cart Item

PUT 
https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID

You can easily update a cart item. A successful update returns the cart items.

Request

Path Parameters

cartID stringrequired

A unique identifier of the cart that you created.

cartitemID stringrequired

A unique identifier of the cart item.

application/json

Body

data object

typestring

The type of the cart item.

Possible values: [cart_item]

iduuid

The unique identifier of the cart item.

quantitynumber

The amount of products to add to cart.

custom_inputsobject

The custom text to be added to a product.

shipping_group_iduuid

The unique identifier of the shipping group to be added to the cart.

Responses

200

Response Headers

application/json

Schema

Schema

data object[]
Array [
anyOf
Cart Item Object
typestringrequired
The type of object being returned.
Possible values: [cart_item]
quantitynumberrequired
The number of items added to the cart.
iduuid
Specifies the ID of the product you want to add to cart. (use this OR sku)
skustring
Specifies the item SKU that you want to add to cart. (use this OR id)
custom_inputsobject
The custom text to be added to a product.
bundle_configuration object
Object used to describe the bundle options selected.
selected_optionsobject
Specifies selected options.
component_productsarray
Array of component products for the selected options.
shipping_group_idstring
Identifier for a created Cart Shipping Group
locationstring
The slug of a stock location.
product_iduuid
The unique ID of the product.
subscription_offering_iduuid
The unique ID of the subscription offering for subscription items.
namestring
The name of this item
descriptionstring
A description of the cart item.
catalog_iduuid
The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
catalog_sourcestring
The catalog source. Always pim or legacy.
image object
mime_typestring
The MIME type for the uploaded file.
file_namestring
The name of the image file that was uploaded.
hrefstring
The link to the image.
manage_stockboolean
Whether or not the quantity of the item will be checked against inventory.
unit_price object
amountnumber
The amount for this item as an integer.
currencystring
The currency this item was added to the cart as.
includes_taxboolean
Whether or not this price is tax inclusive.
value object
amountnumber
The amount for this item as an integer.
currencystring
The currency this item was added to the cart as.
includes_taxboolean
Whether or not this price is tax inclusive.
links object
productstring
A URL related to the resource.
meta object
display_price object
with_tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discount object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_discount object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
timestamps object
created_atstring
The date this was created.
Example: 2023-11-07T23:04:18.845Z
updated_at
The date this was last updated.
Example: 2023-11-07T23:04:18.845Z
Custom Item Object
data object
typestringrequired
The type of object being returned. Must be custom_item.
Possible values: [custom_item]
quantitynumberrequired
The number of custom items to add to cart.
price objectrequired
amountnumberrequired
The unit price of the custom item.
includes_taxboolean
Set totrue if relevant taxes have been included in the price, false if not. Defaults to true.
descriptionstring
A description of the custom item.
skustring
The SKU code to use for the custom item. See best practices to use the SKU code.
namestringrequired
The name of the custom item.
custom_inputsobject
The custom text to be added to a product.
shipping_group_idstring
Identifier for a created Cart Shipping Group
Subscription Item Object
data object
typestringrequired
The type of object being returned.
Possible values: [subscription_item]
quantitynumberrequired
The number of items added to the cart.
iduuidrequired
Specifies the ID of the subscription offering you want to add to cart.
subscription_configuration objectrequired
Specifies how the subscription offering should be configured.
oneOf
MOD1
MOD2
product_iduuid
The unique ID of the product.
subscription_offering_iduuid
The unique ID of the subscription offering for subscription items.
namestring
The name of this item
descriptionstring
A description of the cart item.
catalog_iduuid
The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
catalog_sourcestring
The catalog source. Always pim or legacy.
image object
mime_typestring
The MIME type for the uploaded file.
file_namestring
The name of the image file that was uploaded.
hrefstring
The link to the image.
manage_stockboolean
Whether or not the quantity of the item will be checked against inventory.
unit_price object
amountnumber
The amount for this item as an integer.
currencystring
The currency this item was added to the cart as.
includes_taxboolean
Whether or not this price is tax inclusive.
value object
amountnumber
The amount for this item as an integer.
currencystring
The currency this item was added to the cart as.
includes_taxboolean
Whether or not this price is tax inclusive.
links object
productstring
A URL related to the resource.
meta object
display_price object
with_tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
tax object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discount object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_discount object
unit object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
value object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
timestamps object
created_atstring
The date this was created.
Example: 2023-11-07T23:04:18.845Z
updated_at
The date this was last updated.
Example: 2023-11-07T23:04:18.845Z
Promotion Item Object
data object
typestringrequired
Specifies the type of resource, which is promotion_item.
Possible values: [promotion_item]
codestringrequired
Specifies the promotion code. For more information about codes[].user[], see the Create Promotion codes section.
]
meta object
display_price object
with_tax object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_tax object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
tax object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discount object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_discount object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discounts object
property name* object
amountnumber
currencystring
formattedstring
timestamps object
created_atstring
Example: 2023-11-07T23:04:18.845Z
updated_at
Example: 2023-11-07T23:04:18.845Z
expires_at
Example: 2023-11-12T23:04:18.845Z

Example (auto)

{
  "data": [
    {
      "type": "cart_item",
      "quantity": 0,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sku": "string",
      "custom_inputs": {},
      "bundle_configuration": {
        "selected_options": {},
        "component_products": [
          null
        ]
      },
      "shipping_group_id": "string",
      "location": "string",
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subscription_offering_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "catalog_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "catalog_source": "string",
      "image": {
        "mime_type": "string",
        "file_name": "string",
        "href": "string"
      },
      "manage_stock": true,
      "unit_price": {
        "amount": 0,
        "currency": "string",
        "includes_tax": true
      },
      "value": {
        "amount": 0,
        "currency": "string",
        "includes_tax": true
      },
      "links": {
        "product": "string"
      },
      "meta": {
        "display_price": {
          "with_tax": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "without_tax": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "tax": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "discount": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          },
          "without_discount": {
            "unit": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            },
            "value": {
              "amount": 0,
              "currency": "string",
              "formatted": "string"
            }
          }
        },
        "timestamps": {
          "created_at": "2023-11-07T23:04:18.845Z",
          "updated_at": "2023-11-07T23:04:18.845Z"
        }
      }
    },
    {
      "data": {
        "type": "custom_item",
        "quantity": 0,
        "price": {
          "amount": 0,
          "includes_tax": true
        },
        "description": "string",
        "sku": "string",
        "name": "string",
        "custom_inputs": {},
        "shipping_group_id": "string"
      }
    },
    {
      "data": {
        "type": "subscription_item",
        "quantity": 0,
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "subscription_offering_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "catalog_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "catalog_source": "string",
        "image": {
          "mime_type": "string",
          "file_name": "string",
          "href": "string"
        },
        "manage_stock": true,
        "unit_price": {
          "amount": 0,
          "currency": "string",
          "includes_tax": true
        },
        "value": {
          "amount": 0,
          "currency": "string",
          "includes_tax": true
        },
        "links": {
          "product": "string"
        },
        "meta": {
          "display_price": {
            "with_tax": {
              "unit": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              },
              "value": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              }
            },
            "without_tax": {
              "unit": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              },
              "value": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              }
            },
            "tax": {
              "unit": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              },
              "value": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              }
            },
            "discount": {
              "unit": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              },
              "value": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              }
            },
            "without_discount": {
              "unit": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              },
              "value": {
                "amount": 0,
                "currency": "string",
                "formatted": "string"
              }
            }
          },
          "timestamps": {
            "created_at": "2023-11-07T23:04:18.845Z",
            "updated_at": "2023-11-07T23:04:18.845Z"
          }
        }
      }
    },
    {
      "data": {
        "type": "promotion_item",
        "code": "string"
      }
    }
  ],
  "meta": {
    "display_price": {
      "with_tax": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "without_tax": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "tax": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "discount": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "without_discount": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "discounts": {}
    },
    "timestamps": {
      "created_at": "2023-11-07T23:04:18.845Z",
      "updated_at": "2023-11-07T23:04:18.845Z",
      "expires_at": "2023-11-12T23:04:18.845Z"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring | integerrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
meta object
idstring
The resource id associated with the error
idsstring[]
item_idsstring[]
shipping_group_idstring
The shipping group id associated with the error
shipping_group_idsstring[]
cart_idstring
The cart id associated with the error
codestring
The code associated with the error.
order_idstring
The order id associated with the error.
valuestring | integer | boolean | object | array
The value associated with the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "detail": "string",
      "meta": {
        "id": "string",
        "ids": [
          "string"
        ],
        "item_ids": [
          "string"
        ],
        "shipping_group_id": "string",
        "shipping_group_ids": [
          "string"
        ],
        "cart_id": "string",
        "code": "string",
        "order_id": "string"
      }
    }
  ]
}

default

Cart Currency Mismatch

{
  "errors": [
    {
      "detail": "The existing shipping group uses USD, cannot add this shipping group to a cart item with currency GBP",
      "meta": {
        "item_ids": [
          "51197fc0-e217-4f69-a769-b3887f58cfff"
        ],
        "shipping_group_id": "fcb87ec9-a7fb-48c2-bcd9-2151b64e1abc"
      },
      "status": 404,
      "title": "Cart Currency Mismatch"
    }
  ]
}

404

Not Found

application/json

Schema

Schema

errors object[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring | integerrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
meta object
idstring
The resource id associated with the error
idsstring[]
item_idsstring[]
shipping_group_idstring
The shipping group id associated with the error
shipping_group_idsstring[]
cart_idstring
The cart id associated with the error
codestring
The code associated with the error.
order_idstring
The order id associated with the error.
valuestring | integer | boolean | object | array
The value associated with the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "detail": "string",
      "meta": {
        "id": "string",
        "ids": [
          "string"
        ],
        "item_ids": [
          "string"
        ],
        "shipping_group_id": "string",
        "shipping_group_ids": [
          "string"
        ],
        "cart_id": "string",
        "code": "string",
        "order_id": "string"
      }
    }
  ]
}

default

Not Found

{
  "errors": [
    {
      "detail": "Shipping groups not found for this cart.  Please verify the shipping groups exists for this cart and are not already associated with orders.",
      "meta": {
        "cart_id": "a-cart-id",
        "shipping_group_ids": [
          "fcb87ec9-a7fb-48c2-bcd9-2151b64e1abc"
        ]
      },
      "status": 404,
      "title": "Shipping groups not found"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://useast.api.elasticpath.com/v2/carts/:cartID/items/:cartitemID");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"cart_item\",\n    \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"quantity\": 0,\n    \"custom_inputs\": {},\n    \"shipping_group_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

cartID — pathrequired

cartitemID — pathrequired

Body

• Example (from schema)
• Update Cart Item
• Add Item with Shipping Group ID

{
  "data": {
    "type": "cart_item",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "quantity": 0,
    "custom_inputs": {},
    "shipping_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!