1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Orders
  5. Current
  6. Items

Get all cart items

get

/ccstore/v1/orders/current/items

This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.

Get all the items in the cart.

This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).

Request

Supported Media Types
Query Parameters
  • Return a list of commerce item ids in the response output irresepctive of the pagination limit set.
  • Specifies the number of commerce items to be retrieved starting from offset. In case this is not present, all the commerce items in the current order is returned.
  • Starting index.
Header Parameters
  • Current organization context of the logged in user
  • ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : getItems_response
Type: object
Show Source
Nested Schema : itemIds
Type: array
A list of all the commerce item ids in the current order. This payload section will be included in the response only when the getForUpdate query parameter is set to true.
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childSkus
Type: array
An array with single primary image url for this item's sku, or its default image.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
giftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
  • The ID of the dynamic property.
  • The label of the dynamic property.
  • The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "totalResults":"2",
    "getForUpdate":"false",
    "offset":"0",
    "hasMore":"false",
    "limit":"250",
    "links":[
        {
            "method":"PATCH",
            "rel":"/rels/updateCommerceItems",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/items"
        },
        {
            "method":"GET",
            "rel":"last",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/items?offset=0&limit=2"
        },
        {
            "method":"GET",
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/items"
        },
        {
            "method":"GET",
            "rel":"canonical",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/items"
        },
        {
            "method":"GET",
            "rel":"first",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/items?offset=0&limit=250"
        }
    ],
    "items":[
        {
            "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100",
            "rawTotalPrice":6299.91,
            "displayName":"Samsung - F90BN HD Flash Memory Camcorder",
            "dynamicProperties":[
                {
                    "id":"giftWrapMessage123",
                    "label":"Gift Wrap Message123",
                    "value":"newGSMessage456"
                }
            ],
            "shippingSurchargeValue":0,
            "discountAmount":0,
            "externalData":[
            ],
            "externalPrice":139,
            "commerceItemId":"ci980ddff415",
            "price":3541,
            "variant":[
                {
                    "optionValue":"Neon",
                    "optionName":"color"
                },
                {
                    "optionValue":"2x optical/130x digital",
                    "optionName":"zoom"
                }
            ],
            "primaryImageAltText":"Samsung - F90BN HD Flash Memory Camcorder",
            "onSale":true,
            "id":"ci98000415",
            "state":"Added to order",
            "stateKey":"INITIAL",
            "unitPrice":597,
            "primaryImageTitle":"Samsung - F90BN HD Flash Memory Camcorder",
            "childSKUs":[
                {
                    "primaryThumbImageURL":null
                }
            ],
            "amount":3541,
            "quantity":9,
            "productId":"camcorder_1",
            "pointOfNoRevision":false,
            "salePrice":597,
            "detailedItemPriceInfo":[
                {
                    "discounted":false,
                    "secondaryCurrencyTaxAmount":0,
                    "amount":139,
                    "quantity":1,
                    "tax":0,
                    "orderDiscountShare":0,
                    "detailedUnitPrice":139,
                    "currencyCode":"USD"
                }
            ],
            "giftWithPurchaseCommerceItemMarkers":[
            ],
            "externalPriceQuantity":4,
            "catRefId":"camcordersku_1_3",
            "skuProperties":[
                {
                    "propertyType":"sku-base",
                    "name":"Not Returnable",
                    "id":"nonreturnable",
                    "value":false
                },
                {
                    "propertyType":"sku-base",
                    "name":"Name",
                    "id":"displayName",
                    "value":null
                },
                {
                    "propertyType":"sku-base",
                    "name":"Active",
                    "id":"active",
                    "value":true
                },
                {
                    "propertyType":"sku-base",
                    "name":"Id",
                    "id":"id",
                    "value":"camcordersku_1_3"
                },
                {
                    "propertyType":"sku-base",
                    "name":"Discountable",
                    "id":"discountable",
                    "value":true
                }
            ],
            "route":"/samsung-f90bn-hd-flash-memory-camcorder/product/camcorder_1",
            "discountInfo":[
            ],
            "siteId":"siteUS",
            "shopperInput":{
                "shopInputMessage":"testShopInputMessage4"
            },
            "asset":false,
            "listPrice":699.99
        },
        {
            "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100",
            "rawTotalPrice":21.99,
            "displayName":"The Girl with the Dragon Tattoo",
            "dynamicProperties":[
                {
                    "id":"giftWrapMessage123",
                    "label":"Gift Wrap Message123",
                    "value":null
                }
            ],
            "shippingSurchargeValue":0,
            "discountAmount":0,
            "externalData":[
            ],
            "commerceItemId":"ci98000416",
            "price":21.99,
            "variant":[
            ],
            "primaryImageAltText":"The Girl with the Dragon Tattoo",
            "onSale":false,
            "id":"ci98000416",
            "state":"Added to order",
            "stateKey":"INITIAL",
            "unitPrice":21.99,
            "primaryImageTitle":"The Girl with the Dragon Tattoo",
            "childSKUs":[
                {
                    "primaryThumbImageURL":null
                }
            ],
            "amount":21.99,
            "quantity":1,
            "productId":"Product_36Exy",
            "pointOfNoRevision":false,
            "relationshipType":"SHIPPINGQUANTITY",
            "salePrice":0,
            "detailedItemPriceInfo":[
                {
                    "discounted":false,
                    "secondaryCurrencyTaxAmount":0,
                    "amount":21.99,
                    "quantity":1,
                    "tax":0,
                    "orderDiscountShare":0,
                    "detailedUnitPrice":21.99,
                    "currencyCode":"USD"
                }
            ],
            "giftWithPurchaseCommerceItemMarkers":[
            ],
            "catRefId":"Sku_36Fxy",
            "skuProperties":[
                {
                    "propertyType":"sku-base",
                    "name":"Not Returnable",
                    "id":"nonreturnable",
                    "value":false
                },
                {
                    "propertyType":"sku-base",
                    "name":"Name",
                    "id":"displayName",
                    "value":null
                },
                {
                    "propertyType":"sku-base",
                    "name":"Active",
                    "id":"active",
                    "value":true
                },
                {
                    "propertyType":"sku-base",
                    "name":"Id",
                    "id":"id",
                    "value":"Sku_36Fxy"
                },
                {
                    "propertyType":"sku-base",
                    "name":"Discountable",
                    "id":"discountable",
                    "value":true
                }
            ],
            "route":"/the-girl-with-the-dragon-tattoo/product/Product_36Exy",
            "discountInfo":[
            ],
            "siteId":"siteUS",
            "shopperInput":{
            },
            "asset":false,
            "listPrice":21.99
        }
    ]
}

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top