1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Agent
  4. Sku

listSkus

get

/ccagent/v1/skus

List Skus. Returns a paginated list of SKUs, including variant options, prices, and inventory. Optionally filtered by 'q' parameter. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additionally takes x-cssite header to return the skus pertaining to the site

Request

Supported Media Types
Query Parameters
  • Catalog Id
  • Enabling this flag would improve response time by applying filter. However for better performance results, include only required properties in filterKey, fields , incldude query parameter and avoid including fields like parentProducts which intern have huge number of fields. While using this property ensure that repositoryId,id,parentProducts.id are always included in the response.
  • Contains SCIM query language
  • Comma separated multiple SKU IDS
  • Store PriceList Group id
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listSkus_response
Type: object
Show Source
Nested Schema : items
Type: array
items
Show Source
Nested Schema : sort
Type: array
sort
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : auxiliaryMedia
Type: object
auxiliaryMedia
Nested Schema : catalogs
Type: array
catalogs
Show Source
Nested Schema : catalogsReplacementProducts
Type: array
catalogs replacement products
Show Source
Nested Schema : computedCatalogs
Type: array
computed catalogs
Show Source
Nested Schema : configurationMetadata
Type: array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : derivedCatalogs
Type: array
Derived catalogs
Show Source
Nested Schema : dynamicPropertyMapLong
Type: object
dynamicPropertyMapLong
Show Source
Nested Schema : fullImageURLs
Type: array
fullImageURLs
Show Source
Nested Schema : largeImage
Type: object
large image
Show Source
Nested Schema : largeImageURLs
Type: array
largeImageURLs
Show Source
Nested Schema : listPrices
Type: object
listPrices
Show Source
Nested Schema : mediumImageURLs
Type: array
mediumImageURLs
Show Source
Nested Schema : parentProducts
Type: array
array of parent products
Show Source
Nested Schema : salePrices
Type: object
salePrices
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Show Source
  • Extra handling costs for shipping the product in plg1
  • Extra handling costs for shipping the product in plg2
Nested Schema : smallImage
Type: object
Small image
Show Source
Nested Schema : smallImageURLs
Type: array
smallImageURLs
Show Source
Nested Schema : sourceImageURLs
Type: array
sourceImageURLs
Show Source
Nested Schema : thumbImageURLs
Type: array
thumbImageURLs
Show Source
Nested Schema : thumbnailImage
Type: object
thumbnailImage
Show Source
Nested Schema : translations
Type: object
translations
Show Source
Nested Schema : variant
Type: array
Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : addOnProducts
Type: array
Array of AddOn products.
Show Source
Nested Schema : childSKUs
Type: array
childSKUs
Show Source
Nested Schema : fullImageURLs
Type: array
fullImageURLs
Show Source
Nested Schema : largeImage
Type: object
large image
Show Source
Nested Schema : largeImageURLs
Type: array
largeImageURLs
Show Source
Nested Schema : mediumImageURLs
Type: array
mediumImageURLs
Show Source
Nested Schema : productImages
Type: array
productImages
Show Source
Nested Schema : smallImage
Type: object
Small image
Show Source
Nested Schema : smallImageURLs
Type: array
smallImageURLs
Show Source
Nested Schema : sourceImageURLs
Type: array
sourceImageURLs
Show Source
Nested Schema : thumbImageURLs
Type: array
thumbImageURLs
Show Source
Nested Schema : items
Type: object
AddOn product.
Show Source
Nested Schema : configurationOptions
Type: array
Array of configuration options.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : product
Type: object
Product Details
Show Source
Nested Schema : sku
Type: object
Sku Details
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : 1
Type: object
1
Show Source
Nested Schema : 27
Type: object
27
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/skus?q=barcode%20eq%20%2212345%22"
        }
    ],
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "dynamicPropertyMapLong":{
                "sku-WomensApparel_color":13,
                "sku-WomensApparel_size":0
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "derivedCatalogs":[
                {
                    "repositoryId":"cloudCatalog"
                }
            ],
            "endDate":null,
            "listPrices":{
                "defaultPriceGroup":55
            },
            "configurationMetadata":[
            ],
            "type":"sku-WomensApparel",
            "largeImageURLs":[
            ],
            "derivedSalePriceFrom":"defaultPriceGroup",
            "variantOptions":[
                [
                    {
                        "optionValue":"Poppy",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Small",
                        "optionName":"Size"
                    }
                ]
            ],
            "translations":{
                "1":{
                    "repositoryId":"xsku2535_1_en_US"
                },
                "27":{
                    "repositoryId":"xsku2535_1_vi"
                }
            },
            "id":"xsku2535_1",
            "barcode":"12345",
            "wholesalePrice":null,
            "salePriceEndDate":null,
            "images":[
            ],
            "unitOfMeasure":null,
            "primaryMediumImageURL":null,
            "skuInfos":{
            },
            "thumbImageURLs":[
            ],
            "creationDate":"2016-05-09T14:54:09.000Z",
            "version":4,
            "parentProducts":[
                {
                    "longDescription":"Wear this skirt anywhere with anything. Flat front allows shirts to be tucked in or overlaid nicely, side zipper and snap rivet detailing around the waist.",
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
                    "largeImage":null,
                    "smallImage":null,
                    "displayName":"A-Line Skirt",
                    "orderLimit":null,
                    "onlineOnly":false,
                    "description":"The simple perfect A line",
                    "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
                    "largeImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=940&width=940"
                    ],
                    "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
                    "addOnProducts":[
                        {
                            "repositoryId":"cp10004",
                            "configurationOptions":[
                                {
                                    "product":{
                                        "displayName":"OM-D E-M10 Digital Compact System Camera",
                                        "repositoryId":"camera_1",
                                        "id":"camera_1",
                                        "type":"camera"
                                    },
                                    "repositoryId":"co10009",
                                    "id":"co10009",
                                    "sku":{
                                        "repositoryId":"camerasku_1_1",
                                        "id":"camerasku_1_1"
                                    }
                                },
                                {
                                    "product":{
                                        "displayName":"OM-D E-M10 Digital Compact System Camera",
                                        "repositoryId":"camera_1",
                                        "id":"camera_1",
                                        "type":"camera"
                                    },
                                    "repositoryId":"co10010",
                                    "id":"co10010",
                                    "sku":{
                                        "repositoryId":"camerasku_1_2",
                                        "id":"camerasku_1_2"
                                    }
                                }
                            ],
                            "id":"cp10004"
                        },
                        {
                            "repositoryId":"cp10005",
                            "configurationOptions":[
                                {
                                    "product":{
                                        "displayName":"Movie Gift Card",
                                        "repositoryId":"giftCard_1",
                                        "id":"giftCard_1",
                                        "type":"giftCard"
                                    },
                                    "repositoryId":"co10011",
                                    "id":"co10011",
                                    "sku":{
                                        "repositoryId":"giftCardsku_1",
                                        "id":"giftCardsku_1"
                                    }
                                }
                            ],
                            "id":"cp10005"
                        }
                    ],
                    "smallImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
                    ],
                    "derivedShippingSurchargeFrom":"defaultPriceGroup",
                    "derivedSalePriceFrom":"defaultPriceGroup",
                    "id":"xprod2535",
                    "childSKUs":[
                        {
                            "repositoryId":"xsku2535_1"
                        },
                        {
                            "repositoryId":"xsku2535_2"
                        },
                        {
                            "repositoryId":"xsku2535_3"
                        },
                        {
                            "repositoryId":"xsku2535_4"
                        },
                        {
                            "repositoryId":"xsku2535_5"
                        },
                        {
                            "repositoryId":"xsku2535_6"
                        }
                    ],
                    "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
                    "salePrice":null,
                    "fullImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg"
                    ],
                    "active":true,
                    "thumbImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=100&width=100"
                    ],
                    "productImages":[
                        {
                            "repositoryId":"img_xprod2535_0"
                        },
                        {
                            "repositoryId":"img_xprod2535_1"
                        }
                    ],
                    "route":"/product/xprod2535",
                    "mediumImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=475&width=475"
                    ],
                    "repositoryId":"xprod2535",
                    "derivedListPriceFrom":"defaultPriceGroup",
                    "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                    "shippingSurcharge":null,
                    "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                    "sourceImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
                    ],
                    "minOrderLimit":1,
                    "avgCustRating":null,
                    "listPrice":null
                }
            ],
            "size":"Small",
            "manufacturer_part_number":null,
            "catalogs":[
            ],
            "mediumImageURLs":[
            ],
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "startDate":null,
            "template":null,
            "primaryThumbImageURL":null,
            "replacementProducts":null,
            "dynamicAttributes":{
            },
            "fixedReplacementProducts":[
            ],
            "color":"Poppy",
            "nonreturnable":false,
            "displayName":"A-Line Skirt",
            "description":null,
            "primaryFullImageURL":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "productListingSku":null,
            "primaryLargeImageURL":null,
            "derivedOnlineOnly":false,
            "smallImageURLs":[
            ],
            "derivedShippingSurchargeFrom":"defaultPriceGroup",
            "itemAcl":null,
            "shippingSurcharges":{
                "defaultPriceGroup":null
            },
            "onSale":false,
            "unit_of_measure":null,
            "dynamicPropertyMapString":{
            },
            "siteIds":[
            ],
            "computedCatalogs":[
            ],
            "discountable":true,
            "thumbnailImage":null,
            "catalogsReplacementProducts":[
            ],
            "salePriceStartDate":null,
            "quantity":100,
            "salePrice":null,
            "fullImageURLs":[
            ],
            "variantValuesOrder":{
            },
            "soldAsPackage":false,
            "auxiliaryMedia":{
            },
            "derivedListPriceFrom":"defaultPriceGroup",
            "repositoryId":"xsku2535_1",
            "shippingSurcharge":null,
            "fractionalQuantitiesAllowed":false,
            "fulfiller":null,
            "dynamicPropertyMapDouble":{
            },
            "configurable":false,
            "listPrice":55
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |200020|Invalid query in 'q' parameter.| |30015|SiteId passed in x-ccsite header is currently inactive| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted| |50001|Internal Error.| |26050|Variants Internal Error.|
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