Views for Cart modifying operations

Endpoints that modify a Cart ( e.g. Add Line Item to a Cart) can return one of the available views representing the updated Cart. By using views, you will not need to fetch the updated Cart in a subsequent API call.

The views can be requested by adding a views query parameter to your request with at least one of the following views:

Views

View	Description
miniCart	Returns a subset of Cart data.

Examples

Request

curl -D- -X POST <base_url>/api/v1/carts/<cartId>/lines?views=miniCart \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'
    -H 'Content-Type: application/json' \
    -d '{
        ...<the parameters for the request>...
    }'

MiniCart Response

{
    "miniCart": {
        "customProperties": [
            {
                "id": "{id}",
                "key": "{propKey}",
                "value": "{propValue}"
            }
        ],
        "createdDate": "{createdDate}",
        "cultureCode": "{cultureCode}",
        "discount": "{discountAmount}",
        "discountTotal": "{discountTotalAmount}",
        "id": "{id}",
        "note": "{note}",
        "orderLines": [
            {
                "discount": "{discountAmount}",
                "discounts": "{[discount1Amount, discount2Amount]}",
                "id": "{id}",
                "price": "{priceAmount}",
                "priceGroupId": "{priceGroupId}",
                "productCatalogId": "{productCatalogId}",
                "productName": "{productName}",
                "quantity": "{quantityNumber}",
                "sku": "{sku}",
                "total": "{totalAmount}",
                "unitDiscount": "{unitDiscountAmount}",
                "variantSku": "{variantSku}",
                "tax": "{taxAmount}",
                "taxRate": "{taxRateAmount}",
                "customProperties": [
                    {
                        "id": "{id}",
                        "key": "{propKey}",
                        "value": "{propValue}"
                    }
                ]
            }
        ],
        "orderTotal": "{orderTotalAmount}",
        "paymentTotal": "{paymentTotalAmount}",
        "shippingTotal": "{shippingTotalAmount}",
        "subTotal": "{subTotalAmount}",
        "tax": "{taxAmount}"
    }
}