Docs
Storefront API
Carts
Cart Currency

Cart Currency

Update Cart Currency

POST /carts/{cartId}/currency

Request

Update currency of the Cart. Promotions and gift certificates that don't apply to the new currency will be removed from your cart. You cannot update the cart currency if the draft order cart or the cart contains a manual discount.

Note

  • Substitute your storefront domain for yourstore.example.com.
  • The Send a Test Request feature is not currently supported for this endpoint.

Parameters

  • store_domain in path - string
  • cartId in path - string
    required
    This cartʼs unique ID.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • include in query - array

    To return product options add one of the following include:

    lineItems.physicalItems.options: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return.

    lineItems.digitalItems.options: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return.

    lineItems.digitalItems.options,lineItems.physicalItems.options: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return.

    Type: array[string]

    Allowed: lineItems.physicalItems.options | lineItems.digitalItems.options

Body

object | application/json

  • currencyCode    string
    required

    currency code

example

{
"currencyCode": "string"
}

Response

Body

array | application/json

  • id    string

    Cart ID, provided after creating a cart with a POST.

  • customerId    integer

    ID of the customer to which the cart belongs.

  • currency    object

    This will always be the same between cart and checkout.

  • isTaxIncluded    boolean

    Whether this item is taxable.

  • baseAmount    number

    Cost of cart’s contents, before applying discounts.

  • discountAmount    number

    Order based discounted amount only - Coupon discounts and product based discounts are excluded.

  • cartAmount    number

    Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).

  • coupons    array[object]

  • discounts    array[object]

  • lineItems    object

  • createdTime    string

    Time when the cart was created.

  • updatedTime    string

    Time when the cart was last updated.

  • locale    string

    Locale of the cart.

  • version    integer

    The current version of the cart increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.
    Example: 1

Example

[
{
"id": "770ded29-da45-4ee0-abc6-883e83c0e5ed",
"customerId": 0,
"email": "",
"currency": {
"name": "US Dollars",
"code": "USD",
"symbol": "$",
"decimalPlaces": 2
},
"isTaxIncluded": false,
"baseAmount": 246,
"discountAmount": 0,
"cartAmount": 221.4,
"coupons": [],
"discounts": [
{
"id": "a83dea21-d757-47a2-a06a-73cf6a983746",
"discountedAmount": 24.6
}
],
"lineItems": {
"physicalItems": [
{
"id": "a83dea21-d757-47a2-a06a-73cf6a983746",
"parentId": 6,
"variantId": 193,
"productId": 230,
"sku": "sku123-VA",
"name": "options test",
Did you find what you were looking for?
Delete a CartUpdate Cart Currency