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

getSku

get

/ccagent/v1/skus/{id}

Get Sku. Returns sku details with pricing and variant information. Unlike the getSku endpoint of Admin, this endpoint returns pricing and variants details of Sku. 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.Additonally takes x-ccsite header to return the sku's of that site'

Request

Supported Media Types
Path Parameters
Query Parameters
  • ID of catalog. If a catalogId is not passed, the catalog associated with the shopperProfileId passed in the X-CCAgentContext header is used. If no shopperProfileId is passed in the header, default catalog associated with the site is used.
  • To retrieve not for indivisal Sale items. If showNotForIndividualSale is not passed the sku will return if it exists
  • Sku Id.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getSku_response
Type: object
Show Source
Nested Schema : items
Type: object
sku details with pricing and variant information
Show Source
Nested Schema : configurationMetadata
Type: array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : largeImage
Type: object
large image
Show Source
Nested Schema : parentProducts
Type: object
Array having parent products.
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 of Sku
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : addOnProducts
Type: array
Array of AddOn products.
Show Source
Nested Schema : childSKUs
Type: object
Array having properties of child SKU.
Show Source
Nested Schema : fullImageURLs
Type: array
Full image URLs of the product.
Show Source
Nested Schema : largeImage
Type: object
Array having repository ID and URL of the large image of SKU.
Show Source
Nested Schema : largeImageURLs
Type: array
Large image URLs of the product.
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium image URLs of the product.
Show Source
Nested Schema : productImages
Type: array
Array of product images.
Show Source
Nested Schema : smallImage
Type: object
Array having repository ID and URL of small image of the SKU.
Show Source
Nested Schema : smallImageURLs
Type: array
Small image URLs of the product.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source image URLs of the product.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb image URLs of the product.
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 : metadata
Type: object
Seo meta info for product.
Show Source
Nested Schema : tags
Type: array
The array of product image tags
Show Source
Example Response (application/json)
{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagent/v1/variants/camcordersku_1_3"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "dynamicPropertyMapLong":{
                "sku-camcorder_zoom":0,
                "sku-camcorder_color":2
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "endDate":null,
            "derivedCatalogs":[
            ],
            "configurationMetadata":[
            ],
            "type":"sku-camcorder",
            "derivedSalePriceFrom":"defaultPriceGroup",
            "translations":{
            },
            "id":"camcordersku_1_3",
            "wholesalePrice":null,
            "salePriceEndDate":null,
            "skuInfos":{
            },
            "creationDate":"2015-03-30T06:53:04.000Z",
            "version":1,
            "parentProducts":[
                {
                    "longDescription":"Record footage in 720p resolution with this Samsung F980BN\n                HMX-F90BN/XAA flash memory camcorder, which features a CMOS sensor to help you capture high-definition\n                videos. The 2. LCD display provides a clear view for shooting or reviewing images.\n            ",
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=100&width=100",
                    "largeImage":null,
                    "smallImage":null,
                    "listVolumePrice":{
                        "bulkPrice":{
                            "numLevels":2,
                            "levels":[
                                {
                                    "price":21,
                                    "levelMinimum":1,
                                    "levelMaximum":10
                                },
                                {
                                    "price":10,
                                    "levelMinimum":11
                                }
                            ]
                        }
                    },
                    "displayName":"Samsung - F90BN HD Flash Memory Camcorder",
                    "orderLimit":null,
                    "onlineOnly":false,
                    "description":null,
                    "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg",
                    "largeImageURLs":[
                        "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=940&width=940"
                    ],
                    "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.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=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300"
                    ],
                    "derivedShippingSurchargeFrom":"defaultPriceGroup",
                    "derivedSalePriceFrom":"defaultPriceGroup",
                    "id":"camcorder_1",
                    "childSKUs":[
                        {
                            "repositoryId":"camcordersku_1_1"
                        },
                        {
                            "repositoryId":"camcordersku_1_2"
                        },
                        {
                            "repositoryId":"camcordersku_1_3"
                        },
                        {
                            "repositoryId":"camcordersku_1_4"
                        }
                    ],
                    "saleVolumePrice":{
                        "tieredPrice":{
                            "numLevels":2,
                            "levels":[
                                {
                                    "price":18,
                                    "levelMinimum":1,
                                    "levelMaximum":10
                                },
                                {
                                    "price":8,
                                    "levelMinimum":11
                                }
                            ]
                        }
                    },
                    "salePrice":null,
                    "primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=475&width=475",
                    "fullImageURLs":[
                        "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg"
                    ],
                    "active":true,
                    "thumbImageURLs":[
                        "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=100&width=100"
                    ],
                    "productImages":[
                        {
                            "repositoryId":"camcorderImg"
                        }
                    ],
                    "route":"/product/camcorder_1",
                    "mediumImageURLs":[
                        "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=475&width=475"
                    ],
                    "repositoryId":"camcorder_1",
                    "derivedListPriceFrom":"defaultPriceGroup",
                    "primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300",
                    "primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300",
                    "sourceImageURLs":[
                        "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300"
                    ],
                    "minOrderLimit":1,
                    "avgCustRating":null,
                    "listPrice":null
                }
            ],
            "manufacturer_part_number":null,
            "catalogs":[
            ],
            "startDate":null,
            "template":null,
            "replacementProducts":null,
            "dynamicAttributes":{
            },
            "fixedReplacementProducts":[
            ],
            "color":"Neon",
            "nonreturnable":false,
            "displayName":"Camcorder",
            "description":null,
            "derivedOnlineOnly":false,
            "derivedShippingSurchargeFrom":"defaultPriceGroup",
            "itemAcl":null,
            "shippingSurcharges":{
                "defaultPriceGroup":null
            },
            "unit_of_measure":null,
            "onSale":false,
            "dynamicPropertyMapString":{
            },
            "siteIds":[
            ],
            "thumbnailImage":null,
            "computedCatalogs":[
            ],
            "discountable":true,
            "catalogsReplacementProducts":[
            ],
            "salePriceStartDate":null,
            "quantity":null,
            "salePrice":597,
            "zoom":"2x optical/130x digital",
            "soldAsPackage":false,
            "auxiliaryMedia":{
            },
            "repositoryId":"camcordersku_1_3",
            "derivedListPriceFrom":"defaultPriceGroup",
            "shippingSurcharge":null,
            "fulfiller":null,
            "dynamicPropertyMapDouble":{
            },
            "listPrice":699.99
        },
        [
            {
                "optionValue":"Neon",
                "optionName":"color"
            },
            {
                "optionValue":"2x optical/130x digital",
                "optionName":"zoom"
            }
        ]
    ]
}

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| |------------------|------------------| |30015|SiteId passed in x-ccsite header is currently inactive| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted| |20033|Illegal to use catalog ID when custom catalogs are not in use.| |26069|Internal Error.| |26050|Variants Internal Error.| |26061|Cannot Find Null Sku.| |26060|Cannot Find Sku.|
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