Docs
Storefront API
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.

Body

object | application/json
  • currencyCode
    string
    required

    currency code

example

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.

  • email
    string

    The cart's email. This is the same email that is used in the billing address

  • 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.

Example

Did you find what you were looking for?