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
The data for the sku.
Nested Schema : items
Type:
Show Source
object-
barcode(optional):
number
The barcode
-
configurable(optional):
boolean
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
-
derivedOnlineOnly(optional):
boolean
Indicates if the SKU is available online or not.
-
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
-
displayName(optional):
string
The display name of the SKU
-
fractionalQuantitiesAllowed(optional):
boolean
Whether fractional quantities are allowed
-
fullImageURLs(optional):
array fullImageURLs
The array of full image URLs
-
images(optional):
array images
Image URLs of SKU.
-
largeImage(optional):
string
large image path of the SKU
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
The list price
-
listPrices(optional):
object listPrices
list prices of the product in respective price list groups
-
listVolumePrice(optional):
number
list volume price of the product
-
listVolumePrices(optional):
object listVolumePrices
list volume prices of the product in respective price list groups
-
mediumImageURLs(optional):
array mediumImageURLs
medium image urls path
-
model(optional):
string
The model property of SKU.
-
nonreturnable(optional):
string
Indicates whether the SKU is returnable or not.
-
parentProducts(optional):
array parentProducts
The list of parent products for the SKU.
-
primaryFullImageURL(optional):
string
Primary Full Image URL of SKU.
-
primaryLargeImageURL(optional):
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL(optional):
string
primary medium image url path
-
primarySmallImageURL(optional):
string
Primary Small Image URL of SKU.
-
primarySourceImageURL(optional):
string
primary source image url path
-
primaryThumbImageURL(optional):
string
Primary Source Image URL of SKU.
-
productFamily(optional):
string
product family property of the SKU
-
productLine(optional):
string
product line of the SKU
-
productListingSku(optional):
object productListingSku
product listing SKU property of the SKU
-
productVariantOptions(optional):
array productVariantOptions
The selected options for the SKU.
-
quantity(optional):
integer
quantity of the SKU
-
repositoryId(optional):
string
repository id of the child SKU
-
salePrice(optional):
number
sale price of the SKU.
-
salePriceEndDate(optional):
string
sale price end date of the SKU
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
salePriceStartDate(optional):
string
sale price start date of the SKU
-
saleVolumePrice(optional):
number
The sale volume price
-
saleVolumePrices(optional):
object saleVolumePrices
Sale volume prices of the product in respective price list groups
-
smallImage(optional):
array smallImage
The array of small image URLs
-
smallImageURLs(optional):
array smallImageURLs
small image url paths
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of SKU
-
thumbnailImage(optional):
string
The thumbanil image of the SKU
-
unitOfMeasure(optional):
string
unit of measure of the SKU
-
variantValuesOrder(optional):
object variantValuesOrder
Object having various variant property as key and ordered values array as the value.
Nested Schema : configurationMetadata
Type:
arrayArray of configuration attributes associated with the SKU.
Show Source
Nested Schema : listPrices
Type:
objectlist prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list price of the product in plg1
-
plg2(optional):
number
list price of the product in plg2
Nested Schema : listVolumePrices
Type:
objectlist volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list volume price of the product in plg1
-
plg2(optional):
number
list volume price of the product in plg2
Nested Schema : productListingSku
Type:
objectproduct listing SKU property of the SKU
Nested Schema : salePrices
Type:
objectsale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : saleVolumePrices
Type:
objectSale volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
Sale volume price of the product in plg1
-
plg2(optional):
number
Sale volume price of the product in plg2
Nested Schema : variantValuesOrder
Type:
objectObject having various variant property as key and ordered values array as the value.
Show Source
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-
active(optional):
boolean
The active property of the product
-
avgCustRating(optional):
number
average customer rating for the product
-
brand(optional):
string
brand of the product
-
configurable(optional):
boolean
whether the product is configurable or not
-
CountryOfOrigin(optional):
string
the country of origin of the product
-
defaultProductListingSku(optional):
object defaultProductListingSku
default SKU for the product
-
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
-
derivedShippingSurchargeFrom(optional):
string
Determines from which price list group, shipping surcharge is derived. It can be either current price list group or one of it's ancestors
-
description(optional):
string
description of the product
-
displayName(optional):
string
The display name of the product
-
fractionalQuantitiesAllowed(optional):
boolean
Whether fractional quantities are allowed
-
fullImageURLs(optional):
array fullImageURLs
full image url paths
-
height(optional):
number
height of the product
-
id(optional):
string
id of the product
-
largeImageURLs(optional):
array largeImageURLs
The array of large image URLs
-
length(optional):
number
length of the product
-
listPrice(optional):
number
list price of the product
-
listPrices(optional):
object listPrices
list prices of the product in respective price list groups
-
listVolumePrice(optional):
number
list volume price of the product
-
listVolumePrices(optional):
object listVolumePrices
list volume prices of the product in respective price list groups
-
longDescription(optional):
string
long description of the product
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable(optional):
boolean
Indicates whether the product is returnable or not.
-
notForIndividualSale(optional):
boolean
Whether the product is not for individual sale
-
onlineOnly(optional):
boolean
online only property
-
orderLimit(optional):
string
the order limit of the product
-
parentCategory(optional):
string
parent category of the product
-
primaryFullImageURL(optional):
string
primary full image url path
-
primaryImageAltText(optional):
string
Alternate text for the primary image of the product
-
primaryImageTitle(optional):
string
primary image title of the product
-
primaryLargeImageURL(optional):
string
primary large image url path
-
primaryMediumImageURL(optional):
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL(optional):
string
Primary Small Image URL of product
-
primarySourceImageURL(optional):
string
primary source image url path
-
primaryThumbImageURL(optional):
string
primary thumb image url path
- relatedProducts(optional): string
-
repositoryId(optional):
string
repository id of the product
-
route(optional):
string
route of the product
-
salePrice(optional):
number
The sale price of the product
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
saleVolumePrice(optional):
number
The sale volume price
-
saleVolumePrices(optional):
object saleVolumePrices
Sale volume prices of the product in respective price list groups
-
seoUrlSlugDerived(optional):
string
Derived from seoUrlSlug of the product if available, else derived from display name of the product.
-
shippingSurcharge(optional):
number
Extra handling costs for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImageURLs(optional):
array smallImageURLs
The urls of the small image.
-
sourceImageURLs(optional):
array sourceImageURLs
source image urls of the product
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of product
-
type(optional):
string
type of the product
-
unitOfMeasure(optional):
string
unit of measure of the product
-
weight(optional):
number
weight
-
width(optional):
number
width of the product
Nested Schema : defaultProductListingSku
Type:
objectdefault SKU for the product
Nested Schema : listPrices
Type:
objectlist prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list price of the product in plg1
-
plg2(optional):
number
list price of the product in plg2
Nested Schema : listVolumePrices
Type:
objectlist volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list volume price of the product in plg1
-
plg2(optional):
number
list volume price of the product in plg2
Nested Schema : salePrices
Type:
objectsale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : saleVolumePrices
Type:
objectSale volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
Sale volume price of the product in plg1
-
plg2(optional):
number
Sale volume price of the product in plg2
Nested Schema : shippingSurcharges
Type:
objectExtra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object-
optionName(optional):
string
The name of the option.
-
optionValue(optional):
string
The value of the option.
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:
arrayAn 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