listSkus
get
/ccstore/v1/skus
List Skus. Gets the data and related selected options of a list of SKUs
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
the catalog ID for the site
-
skuIds: string
The comma separated list of skuIds.
-
storePriceListGroupId(optional): string
The price list group ID of the current Store.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listSkus_response
Type:
Show Source
object
-
items(optional):
array items
Array having various SKUs.
-
limit(optional):
integer
Limit of number of products.
-
offset(optional):
integer
Offset of product inventory.
-
sort(optional):
array sort
Array having the order and property of product.
-
total(optional):
integer
Total number of products. Deprecated.
-
totalResults(optional):
integer
Total number of products.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether SKU is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true.
-
barcode(optional):
string
Barcode property of the sku.
-
bundleLinks(optional):
array bundleLinks
Array of bundle links associated with the SKU
-
configurable(optional):
boolean
Indicates whether the SKU is configurable or not.
-
configurationMetadata(optional):
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
derivedListPriceFrom(optional):
string
Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
-
derivedSalePriceFrom(optional):
string
Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
-
discountable(optional):
boolean
Indicates whether the promotions should be applied to this SKU or not. If the value is true then promotion discounts can be applied to this SKU; else no promotions can be applied to this SKU. Default value is true
-
displayName(optional):
string
Display name of the SKU.
-
dynamicPropertyMapBigString(optional):
string
Dynamic Property MapBigString.
-
dynamicPropertyMapLong(optional):
integer
Dynamic property map long of the SKU.
-
fullImageURLs(optional):
string
Full image URL.
-
images(optional):
array images
Array of images for the SKU.
-
largeImage(optional):
integer
Large image of the SKU.
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
List price of the SKU.
-
listVolumePrice(optional):
object listVolumePrice
list volume price of the SKU
-
listVolumePrices(optional):
object listVolumePrices
Object with price group IDs as keys and list prices as values
-
mediumImageURLs(optional):
string
Medium image URL.
-
model(optional):
string
Model property of the SKU.
-
nonreturnable(optional):
boolean
Determines SKU product is returnable or not.
-
primaryFullImageURL(optional):
string
Primary full image URL.
-
primaryLargeImageURL(optional):
string
Primary large image URL.
-
primaryMediumImageURL(optional):
string
Primary medium image URL.
-
primarySmallImageURL(optional):
string
Primary small image URL.
-
primarySourceImageURL(optional):
string
Primary source image URL.
-
primaryThumbImageURL(optional):
string
Primary thumb image URL.
-
productFamily(optional):
string
Product Family property of the SKU.
-
productLine(optional):
string
Product line property of the SKU.
-
productListingSku(optional):
boolean
This is true if this sku is the listing sku for a particular variant
-
quantity(optional):
integer
Quantity of the SKU.
-
repositoryId(optional):
string
Repository ID of the SKU.
-
salePrice(optional):
string
Sale price of the SKU.
-
salePriceEndDate(optional):
integer
Sale price end date of the SKU.
-
salePriceStartDate(optional):
string
Sale price start date of the SKU.
-
saleVolumePrice(optional):
object saleVolumePrice
Sale volume price of the SKU
-
saleVolumePrices(optional):
object saleVolumePrices
Object with price group IDs as keys and sale prices as values
-
smallImage(optional):
integer
Small image of the SKU.
-
smallImageURLs(optional):
string
Small image URL.
-
soldAsPackage(optional):
boolean
Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
-
sourceImageURLs(optional):
string
Source image URL.
-
thumbImageURLs(optional):
string
Thumb image URL.
-
thumbnailImage(optional):
string
Thumbnail image of the SKU.
-
unitOfMeasure(optional):
string
unitOfMeasure
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : listVolumePrice
Type:
object
list volume price of the SKU
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
object
Object with price group IDs as keys and list prices as values
Show Source
-
PriceGroupID1(optional):
object PriceGroupID1
List price of the SKU in price group 1
-
PriceGroupID2(optional):
object PriceGroupID2
List price of the SKU in price group 2
Nested Schema : saleVolumePrice
Type:
object
Sale volume price of the SKU
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
Type:
object
Object with price group IDs as keys and sale prices as values
Show Source
-
PriceGroupID1(optional):
object PriceGroupID1
Sale price of the SKU in price group 1
-
PriceGroupID2(optional):
object PriceGroupID2
Sale price of the SKU in price group 1
Nested Schema : items
Type:
Show Source
object
-
item(optional):
object item
The SKU that will be included into this bundle link
-
quantity(optional):
integer
The quantity of the item
-
repositoryId(optional):
string
The id of the bundle link
Nested Schema : item
Type:
object
The SKU that will be included into this bundle link
Show Source
-
displayName(optional):
string
The name of the SKU included in the bundle link
-
repositoryId(optional):
string
The id of the SKU included in the bundle link
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
The name of the configuration attribute.
-
repositoryId(optional):
string
The repository id for existing configuration metadata items.
-
value(optional):
string
The value of the configuration attribute.
Nested Schema : items
Type:
Show Source
object
-
metadata(optional):
object metadata
Seo meta info.
-
name(optional):
string
Name of the image.
-
path(optional):
string
Path of the image.
-
repositoryId(optional):
string
Repository ID of the image.
-
tags(optional):
array tags
Tags for the image.
-
url(optional):
string
The complete url of the image.
Nested Schema : metadata
Type:
object
Seo meta info.
Show Source
-
altText(optional):
string
Alt text for the image.
-
titleText(optional):
string
Title text for the image.
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : PriceGroupID1
Type:
object
List price of the SKU in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
object
List price of the SKU in price group 2
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : PriceGroupID1
Type:
object
Sale price of the SKU in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
object
Sale price of the SKU in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Order of listing in product inventory.
-
property(optional):
string
Display name as a product property.
Example Response (application/json)
[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"listPrices":{
"defaultPriceGroup":19.99
},
"configurationMetadata":[
],
"productVariantOptions":[
[
]
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"thumbnailImage":null,
"barcode":"200000002022",
"saleVolumePrices":{
"defaultPriceGroup":null
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"parentProducts":[
{
"listVolumePrice":null,
"relatedProducts":null,
"orderLimit":null,
"CountryOfOrigin":"US",
"onlineOnly":false,
"listPrices":{
"defaultPriceGroup":19.99
},
"type":null,
"largeImageURLs":[
"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=940&width=940"
],
"listVolumePrices":{
"defaultPriceGroup":null
},
"derivedSalePriceFrom":"defaultPriceGroup",
"primaryImageAltText":"Coaxial Audio Cable",
"id":"prod10027",
"brand":null,
"parentCategories":[
{
"repositoryId":"cat60043",
"fixedParentCategories":[
{
"repositoryId":"cat60035",
"fixedParentCategories":[
{
"repositoryId":"cat60023"
}
]
}
]
},
{
"repositoryId":"AllProdPagination",
"fixedParentCategories":[
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
}
]
}
],
"height":null,
"defaultProductListingSku":null,
"unitOfMeasure":null,
"primaryMediumImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=475&width=475",
"seoUrlSlugDerived":"Coaxial Audio Cable",
"weight":null,
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=100&width=100"
],
"route":"/coaxial-audio-cable/product/prod10027",
"relatedArticles":[
],
"mediumImageURLs":[
"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=475&width=475"
],
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=300&width=300",
"parentCategory":null,
"sourceImageURLs":[
"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=300&width=300"
],
"primarySmallImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=300&width=300",
"avgCustRating":4.5,
"longDescription":null,
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=100&width=100",
"nonreturnable":false,
"displayName":"Coaxial Audio Cable",
"description":"A really great movie that you should not miss.",
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg",
"parentCategoriesAncestorCategories":[
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
},
{
"repositoryId":"cat60023",
"fixedParentCategories":[
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
}
]
},
{
"repositoryId":"cat60035",
"fixedParentCategories":[
{
"repositoryId":"cat60023",
"fixedParentCategories":[
{
"repositoryId":"rootCategory"
}
]
}
]
},
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
}
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=940&width=940",
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=300&width=300"
],
"shippingSurcharges":{
"defaultPriceGroup":null
},
"saleVolumePrices":{
"defaultPriceGroup":null
},
"primaryImageTitle":"Coaxial Audio Cable",
"saleVolumePrice":null,
"relatedMediaContent":[
],
"salePrice":null,
"fullImageURLs":[
"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg"
],
"length":null,
"notForIndividualSale":false,
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"prod10027",
"width":null,
"shippingSurcharge":null,
"fractionalQuantitiesAllowed":false,
"productImagesMetadata":[
{
}
],
"configurable":false,
"ancestorCategoriesForFullDeploy":[
],
"listPrice":19.99
}
],
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"sku10009",
"primarySourceImageURL":null,
"fractionalQuantitiesAllowed":false,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"listPrices":{
"defaultPriceGroup":19.99
},
"configurationMetadata":[
],
"productVariantOptions":[
[
]
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"thumbnailImage":null,
"barcode":"200000002039",
"saleVolumePrices":{
"defaultPriceGroup":null
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"parentProducts":[
{
"listVolumePrice":null,
"relatedProducts":null,
"orderLimit":null,
"CountryOfOrigin":"US",
"onlineOnly":false,
"listPrices":{
"defaultPriceGroup":19.99
},
"type":null,
"largeImageURLs":[
"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=940&width=940"
],
"listVolumePrices":{
"defaultPriceGroup":null
},
"derivedSalePriceFrom":"defaultPriceGroup",
"primaryImageAltText":"HDMI Cable",
"id":"prod10028",
"brand":null,
"parentCategories":[
{
"repositoryId":"cat60043",
"fixedParentCategories":[
{
"repositoryId":"cat60035",
"fixedParentCategories":[
{
"repositoryId":"cat60023"
}
]
}
]
},
{
"repositoryId":"AllProdPagination",
"fixedParentCategories":[
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
}
]
}
],
"height":null,
"defaultProductListingSku":null,
"unitOfMeasure":null,
"primaryMediumImageURL":"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=475&width=475",
"seoUrlSlugDerived":"HDMI Cable",
"weight":null,
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=100&width=100"
],
"route":"/hdmi-cable/product/prod10028",
"relatedArticles":[
],
"mediumImageURLs":[
"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=475&width=475"
],
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=300&width=300",
"parentCategory":null,
"sourceImageURLs":[
"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=300&width=300"
],
"primarySmallImageURL":"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=300&width=300",
"avgCustRating":4.5,
"longDescription":null,
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=100&width=100",
"nonreturnable":false,
"displayName":"HDMI Cable",
"description":"A really great movie that you should not miss.",
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg",
"parentCategoriesAncestorCategories":[
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
},
{
"repositoryId":"cat60023",
"fixedParentCategories":[
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
}
]
},
{
"repositoryId":"cat60035",
"fixedParentCategories":[
{
"repositoryId":"cat60023",
"fixedParentCategories":[
{
"repositoryId":"rootCategory"
}
]
}
]
},
{
"repositoryId":"rootCategory",
"fixedParentCategories":[
]
}
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=940&width=940",
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg&height=300&width=300"
],
"shippingSurcharges":{
"defaultPriceGroup":null
},
"saleVolumePrices":{
"defaultPriceGroup":null
},
"primaryImageTitle":"HDMI Cable",
"saleVolumePrice":null,
"relatedMediaContent":[
],
"salePrice":null,
"fullImageURLs":[
"/ccstore/v1/images/?source=/file/products/hdmicable_LARGE.jpg"
],
"length":null,
"notForIndividualSale":false,
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"prod10028",
"width":null,
"shippingSurcharge":null,
"fractionalQuantitiesAllowed":false,
"productImagesMetadata":[
{
}
],
"configurable":false,
"ancestorCategoriesForFullDeploy":[
],
"listPrice":19.99
}
],
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"sku10010",
"primarySourceImageURL":null,
"fractionalQuantitiesAllowed":false,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
]
Default Response
The error response
Root Schema : errorModel
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
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
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
-
type(optional):
string
The URI to the HTTP state code definition
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