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: string
the catalog ID for the site
-
q: string
This field specifies the SCIM compliant query used to filter skus. The request requires either skuIds or 'q' param. When skuIds param is combined with q param, SkuIds will take the preceding and q param is ignored.
-
skuIds(required): string
The comma separated list of skuIds.
-
state: boolean
Flag to indicate if invalid skus has to be ignored. Default value is false.
-
storePriceListGroupId: 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:
array items
items
-
limit:
integer
limit
-
links:
array links
links
-
offset:
integer
offset
-
sort:
array sort
sort
-
total:
integer
total
-
totalResults:
integer
totalResults
Nested Schema : items
Type:
Show Source
object-
auxiliaryMedia:
object auxiliaryMedia
auxiliaryMedia
-
barcode:
string
barcode
-
catalogs:
array catalogs
catalogs
-
catalogsReplacementProducts:
array catalogsReplacementProducts
catalogs replacement products
-
color:
string
color
-
computedCatalogs:
array computedCatalogs
computed catalogs
-
configurable:
boolean
Indicates whether a sku is configurable
-
configurationMetadata:
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
creationDate:
string
creationDate
-
derivedCatalogs:
array derivedCatalogs
Derived catalogs
-
derivedListPriceFrom:
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:
boolean
Indicates if the SKU is available online or not.
-
derivedSalePriceFrom:
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:
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:
string
description
-
discountable:
boolean
discountable
-
displayName:
string
displayName
-
dynamicPropertyMapLong:
object dynamicPropertyMapLong
dynamicPropertyMapLong
-
endDate:
string
endDate
-
fractionalQuantitiesAllowed:
boolean
fractionalQuantitiesAllowed
-
fulfiller:
string
fulfiller
-
fullImageURLs:
array fullImageURLs
fullImageURLs
-
id:
string
id
-
itemAcl:
string
item Acl
-
largeImage:
object largeImage
large image
-
largeImageURLs:
array largeImageURLs
largeImageURLs
-
listPrice:
number
listPrice
-
listPrices:
object listPrices
listPrices
-
manufacturer_part_number:
string
manufacturer_part_number
-
mediumImageURLs:
array mediumImageURLs
mediumImageURLs
-
nonreturnable:
boolean
nonreturnable
-
onSale:
boolean
onSale
-
parentProducts:
array parentProducts
array of parent products
-
partNumber:
string
Unique identifier or code used for the part.
-
primaryFullImageURL:
string
primaryFullImageURL
-
primaryLargeImageURL:
string
primaryLargeImageURL
-
primaryMediumImageURL:
string
primaryMediumImageURL
-
primarySmallImageURL:
string
primarySmallImageURL
-
primarySourceImageURL:
string
primarySourceImageURL
-
primaryThumbImageURL:
string
primaryThumbImageURL
-
productListingSku:
string
productListingSku
-
quantity:
integer
quantity
-
repositoryId:
string
repositoryId
-
salePrice:
number
salePrice
-
salePriceEndDate:
string
salePriceEndDate
-
salePrices:
object salePrices
salePrices
-
salePriceStartDate:
string
salePriceStartDate
-
shippingSurcharge:
number
Extra handling costs while shipping the product, in the default price group.
-
shippingSurcharges:
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
siteIds:
string
siteIds
-
size:
string
size
-
smallImage:
object smallImage
Small image
-
smallImageURLs:
array smallImageURLs
smallImageURLs
-
soldAsPackage:
boolean
Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
-
sourceImageURLs:
array sourceImageURLs
sourceImageURLs
-
startDate:
string
startDate
-
thumbImageURLs:
array thumbImageURLs
thumbImageURLs
-
thumbnailImage:
object thumbnailImage
thumbnailImage
-
translations:
object translations
translations
-
type:
string
type
-
unit_of_measure:
string
unit_of_measure
-
unitOfMeasure:
string
unitOfMeasure
-
variant:
array variant
Product Variant Information.
-
variantOptions:
string
variantOptions
-
version:
integer
version
-
wholesalePrice:
number
wholesalePrice
Nested Schema : auxiliaryMedia
Type:
objectauxiliaryMedia
Nested Schema : configurationMetadata
Type:
arrayArray of configuration attributes associated with the SKU.
Show Source
Nested Schema : dynamicPropertyMapLong
Type:
objectdynamicPropertyMapLong
Show Source
-
sku-WomensApparel_color:
integer
sku-WomensApparel_color
-
sku-WomensApparel_size:
integer
sku-WomensApparel_size
Nested Schema : largeImage
Type:
objectlarge image
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : listPrices
Type:
objectlistPrices
Show Source
-
defaultPriceGroup:
number
defaultPriceGroup
Nested Schema : salePrices
Type:
objectsalePrices
Show Source
-
defaultPriceGroup:
string
defaultPriceGroup
Nested Schema : shippingSurcharges
Type:
objectExtra handling costs for shipping the product in respective price list groups
Show Source
-
plg1:
number
Extra handling costs for shipping the product in plg1
-
plg2:
number
Extra handling costs for shipping the product in plg2
Nested Schema : smallImage
Type:
objectSmall image
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : thumbnailImage
Type:
objectthumbnailImage
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : items
Type:
Show Source
object-
name:
string
The name of the configuration attribute.
-
repositoryId:
string
The repository id for existing configuration metadata items.
-
value:
string
The value of the configuration attribute.
Nested Schema : items
Type:
Show Source
object-
active:
boolean
active
-
addOnProducts:
array addOnProducts
Array of AddOn products.
-
avgCustRating:
string
avgCustRating
-
childSKUs:
array childSKUs
childSKUs
-
derivedListPriceFrom:
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:
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:
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:
string
description
-
displayName:
string
The display name of the SKU
-
fullImageURLs:
array fullImageURLs
fullImageURLs
-
id:
string
id
-
largeImage:
object largeImage
large image
-
largeImageURLs:
array largeImageURLs
largeImageURLs
-
listPrice:
number
listPrice
-
longDescription:
string
longDescription
-
mediumImageURLs:
array mediumImageURLs
mediumImageURLs
-
onlineOnly:
boolean
online only property
-
orderLimit:
integer
orderLimit
-
primaryFullImageURL:
string
primaryFullImageURL
-
primaryLargeImageURL:
string
primaryLargeImageURL
-
primaryMediumImageURL:
string
primaryMediumImageURL
-
primarySmallImageURL:
string
primarySmallImageURL
-
primarySourceImageURL:
string
primarySourceImageURL
-
primaryThumbImageURL:
string
primaryThumbImageURL
-
productImages:
array productImages
productImages
-
repositoryId:
string
repositoryId
-
route:
string
route
-
salePrice:
number
salePrice
-
shippingSurcharge:
number
shippingSurcharge
-
smallImage:
object smallImage
Small image
-
smallImageURLs:
array smallImageURLs
smallImageURLs
-
sourceImageURLs:
array sourceImageURLs
sourceImageURLs
-
thumbImageURLs:
array thumbImageURLs
thumbImageURLs
Nested Schema : addOnProducts
Type:
arrayArray of AddOn products.
Show Source
-
Array of:
object items
AddOn product.
Nested Schema : largeImage
Type:
objectlarge image
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : smallImage
Type:
objectSmall image
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : items
Type:
objectAddOn product.
Show Source
-
configurationOptions:
array configurationOptions
Array of configuration options.
-
id:
string
Repository ID
-
partNumber:
string
Unique identifier or code used for the part.
-
repositoryId:
string
Repository ID of configurable product.
Nested Schema : items
Type:
Show Source
object-
id:
string
Repository ID
-
product:
object product
Product Details
-
repositoryId:
string
Repository ID of configuration option.
-
sku:
object sku
Sku Details
Nested Schema : product
Type:
objectProduct Details
Show Source
-
displayName:
string
Display name of product.
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of product.
-
type:
string
Type of product.
Nested Schema : sku
Type:
objectSku Details
Show Source
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of sku.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Example Response (application/json)
{
"deletedSkus":[
],
"links":[
{
"rel":"self",
"href":"http://store.example.com/ccstoreui/v1/skus"
}
],
"items":[
{
"dynamicPropertyMapLong":{
},
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"listPrices":{
"defaultPriceGroup":19.99
},
"configurationMetadata":[
],
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"barcode":"200000002022",
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"thumbImageURLs":[
],
"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",
"minOrderLimit":1,
"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":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"productFamily":null,
"primaryThumbImageURL":null,
"nonreturnable":false,
"displayName":null,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"productVariantOptions":[
[
]
],
"productListingSku":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"thumbnailImage":null,
"saleVolumePrices":{
"defaultPriceGroup":null
},
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":null,
"salePrice":null,
"fullImageURLs":[
],
"variantValuesOrder":{
},
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"sku10009",
"shippingSurcharge":null,
"partNumber":"part-001",
"fractionalQuantitiesAllowed":false,
"listPrice":19.99,
"configurable":false
},
{
"dynamicPropertyMapLong":{
},
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"listPrices":{
"defaultPriceGroup":19.99
},
"configurationMetadata":[
],
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"barcode":"200000002039",
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"thumbImageURLs":[
],
"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",
"minOrderLimit":1,
"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":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"productFamily":null,
"primaryThumbImageURL":null,
"nonreturnable":false,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"productVariantOptions":[
[
]
],
"productListingSku":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"thumbnailImage":null,
"saleVolumePrices":{
"defaultPriceGroup":null
},
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":null,
"salePrice":null,
"fullImageURLs":[
],
"variantValuesOrder":{
},
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"sku10010",
"shippingSurcharge":null,
"partNumber":"part-001",
"fractionalQuantitiesAllowed":false,
"listPrice":19.99,
"configurable":false
}
]
}Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code