Get a cart item by ID
get
/ccstore/v1/orders/current/items/{id}
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 the item in the cart for the given ID.
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
- application/json
Path Parameters
-
id: string
The ID of the item to retrieve.
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
-
X-CCVisitorId(optional): string
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.
Response
Supported Media Types
- application/json
200 Response
TODO
Root Schema : model_item
Match All
Show Source
Example:
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100",
"rawTotalPrice":2799.96,
"displayName":"Samsung - F90BN HD Flash Memory Camcorder",
"dynamicProperties":[
{
"id":"giftWrapMessage123",
"label":"Gift Wrap Message123",
"value":"newGSMessage456000"
}
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"externalPrice":129,
"commerceItemId":"ci980ddwww415",
"price":984,
"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":984,
"quantity":7,
"productId":"camcorder_1",
"pointOfNoRevision":false,
"salePrice":597,
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":129,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":129,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"externalPriceQuantity":3,
"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":"testShopInputMessd"
},
"asset":false,
"listPrice":699.99
}
Nested Schema : model_subItem
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetId(optional):
string
The asset ID corresponding to the current item.
-
assetKey(optional):
string
The assetKey ID associated to the current item.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku reference ID.
-
childItems(optional):
array childItems
The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.
-
childSkus(optional):
array childSkus
An array with single primary image url for this item's sku, or its default image.
-
commerceItemId(optional):
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
number
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity(optional):
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
externalRecurringCharge(optional):
number
The external recurring charge amount.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information.
-
id(optional):
string
Unique line item identifier.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
price(optional):
number
Price of the items.
-
primaryImageAltText(optional):
string
The product's primary image alternative text.
-
primaryImageTitle(optional):
string
The product's primary image title.Example:
Samsung - F90BN HD Flash Memory Camcorder
-
primaryThumbImageURL(optional):
string
The URL of the product's primary image.Example:
/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product in the cart.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
-
route(optional):
string
The UI route to display the product.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
variant(optional):
array variant
List of variants for the product.
Example:
{
"rawTotalPrice":2799.96,
"displayName":"Samsung - F90BN HD Flash Memory Camcorder",
"dynamicProperties":[
{
"id":"giftWrapMessage123",
"label":"Gift Wrap Message123",
"value":"newGSMessage456000"
}
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"externalPrice":129,
"commerceItemId":"ci980ddwww415",
"price":984,
"variant":[
{
"optionValue":"Neon",
"optionName":"color"
},
{
"optionValue":"2x optical/130x digital",
"optionName":"zoom"
}
],
"onSale":true,
"id":"ci98000415",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":597,
"amount":984,
"quantity":7,
"productId":"camcorder_1",
"pointOfNoRevision":false,
"salePrice":597,
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":129,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":129,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"externalPriceQuantity":3,
"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
}
],
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
"shopInputMessage":"testShopInputMessd"
},
"asset":false,
"listPrice":699.99
}
Nested Schema : model_item-allOf[1]
Type:
Show Source
object
-
configuratorId(optional):
string
Configuration ID for the configurable commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
Nested Schema : childItems
Type:
array
The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.
Show Source
-
Array of:
object items
A configurable item with properties that match the parent configuarable item
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
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
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 : items
Type:
object
A configurable item with properties that match the parent configuarable item
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
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:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data(optional):
integer
The gift hash code for this gift with purchase promotion.
-
key(optional):
string
atg.gwp
-
remainingQuantity(optional):
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value(optional):
string
The gift with purchase promotion ID.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
400 Response
The error response (which alternates to the default response depending on error reason).
Root Schema : errorModelSingleError
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
Default Response
The error response.
Root Schema : errorModelMultiErrors
Type:
Show Source
object
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
status(optional):
string
The HTTP status code
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code