Thanks for being patient while we implement your feedback to improve the developer experience.

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.

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.

  • 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

[
  {
    "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",
          "url": "https://store.example.com/options-test/",
          "quantity": 2,
          "brand": "BigCommerce",
          "isTaxable": true,
          "imageUrl": "https://cdn11.bigcommerce.com/r-3b68d717e18793df0b51c71e16bc24664ad18b7c/themes/ClassicNext/images/ProductDefault.gif",
          "discounts": [
            {
              "id": "string",
              "discountedAmount": 24.6
            }
          ],
          "discountAmount": 24.6,
          "couponAmount": 0,
          "originalPrice": 130,
          "listPrice": 123,
          "salePrice": 110.7,
          "extendedListPrice": 246,
          "extendedSalePrice": 221.4,
          "isShippingRequired": true,
          "type": "physical",
          "isMutable": true,
          "giftWrapping": null
        }
      ],
      "digitalItems": [],
      "giftCertificates": [],
      "customItems": []
    },
    "createdTime": "2021-03-04T14:17:50+00:00",
    "updatedTime": "2021-03-04T14:17:50+00:00",
    "locale": "en"
  }
]