Oracle Commerce Cloud October 2017

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

application/json

Path Parameters

id: Type: string

Required: true

Sku Id.

Query Parameters

catalogId: Type: string

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.
showNotForIndividualSale: Type: boolean

Required: true

To retrieve not for indivisal Sale items. If showNotForIndividualSale is not passed the sku will return if it exists
skuId: Type: string

Required: true

Sku Id.

Header Parameters

x-ccsite: Type: string

the site id on which the orders is laced

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getSku_response

Properties

items: Type: object items

sku details with pricing and variant information

Nested Schema : items

Type: object

sku details with pricing and variant information

Properties

configurable: Type: boolean

Indicates whether SKU is configurable
largeImage: Type: object largeImage

large image
listPrice: Type: integer

List price of the SKU.
parentProducts: Type: object parentProducts

Array having parent products.
quantity: Type: integer

Quantity of the SKU.
repositoryId: Type: string

Repository ID of the SKU.
salePrice: Type: string

Sale price of the SKU.
salePriceEndDate: Type: integer

Sale price end date of the SKU.
salePriceStartDate: Type: string

Sale price start date of the SKU.
smallImage: Type: object smallImage

Small image of Sku
thumbnailImage: Type: string

Thumbnail image of the SKU.

Nested Schema : largeImage

Type: object

large image

Properties

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : parentProducts

Type: object

Array having parent products.

Properties

active: Type: boolean

Flag indicating whether a product is active
avgCustRating: Type: string

Average customer rating of the product.
childSKUs: Type: object childSKUs

Array having properties of child SKU.
description: Type: string

Description of the product.
displayName: Type: string

Display name of the product.
fullImageURLs: Type: array fullImageURLs

Full image URLs of the product.
id: Type: string

ID of the product.
largeImage: Type: object largeImage

Array having repository ID and URL of the large image of SKU.
largeImageURLs: Type: array largeImageURLs

Large image URLs of the product.
listPrice: Type: number

List price of the product.
listVolumePrice: Type: number

List volume price of the product.
longDescription: Type: string

Long description of the product.
mediumImageURLs: Type: array mediumImageURLs

Medium image URLs of the product.
orderLimit: Type: string

Order limit of the product.
primaryFullImageURL: Type: string

Primary full image URL of the product.
primaryLargeImageURL: Type: string

Primary large image URL of the product.
primarySmallImageURL: Type: string

Primary small image URL of the product.
primarySourceImageURL: Type: string

Primary source image URL of the product.
primaryThumbImageURL: Type: string

Primary thumb image URL of the product.
productImages: Type: array productImages

Array of product images.
productNumber: Type: string

Product number of the product.
repositoryId: Type: string

Repository id of the product.
route: Type: string

Route of the product.
salePrice: Type: integer

Sale price of the product.
saleVolumePrice: Type: number

Sale volume price of the product.
smallImage: Type: object smallImage

Array having repository ID and URL of small image of the SKU.
smallImageURLs: Type: array smallImageURLs

Small image URLs of the product.
sourceImageURLs: Type: array sourceImageURLs

Source image URLs of the product.
thumbImageURLs: Type: array thumbImageURLs

Thumb image URLs of the product.

Nested Schema : smallImage

Type: object

Small image of Sku

Properties

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : childSKUs

Type: object

Array having properties of child SKU.

Properties

repositoryId: Type: string

Repository ID of the SKU.

Nested Schema : fullImageURLs

Type: array

Full image URLs of the product.

Items

Type: string

Nested Schema : largeImage

Type: object

Array having repository ID and URL of the large image of SKU.

Properties

repositoryId: Type: string

Repository ID of SKU.
url: Type: string

URL of SKU.

Nested Schema : largeImageURLs

Type: array

Large image URLs of the product.

Items

Type: string

Nested Schema : mediumImageURLs

Type: array

Medium image URLs of the product.

Items

Type: string

Nested Schema : productImages

Type: array

Array of product images.

Items

Type: object items

Nested Schema : smallImage

Type: object

Array having repository ID and URL of small image of the SKU.

Properties

repositoryId: Type: string

Repository ID of SKU.
url: Type: string

URL of SKU.

Nested Schema : smallImageURLs

Type: array

Small image URLs of the product.

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

Source image URLs of the product.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

Thumb image URLs of the product.

Items

Type: string

Nested Schema : items

Type: object

Properties

metadata: Type: object metadata

Seo meta info for product.
name: Type: string

The name of product image
path: Type: string

The path of the image
repositoryId: Type: string

The repository Id of the product image
tags: Type: array tags

The array of product image tags
url: Type: string

The url of the product image

Nested Schema : metadata

Type: object

Seo meta info for product.

Properties

altText: Type: string

The alt text of the image
titleText: Type: string

The title text of the image

Nested Schema : tags

Type: array

The array of product image tags

Items

Type: string

Example application/json


{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagent/v1/variants/camcordersku_1_3"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "template":null,
            "dynamicPropertyMapLong":{
                "sku-camcorder_zoom":0,
                "sku-camcorder_color":2
            },
            "replacementProducts":null,
            "bundleLinks":[
            ],
            "largeImage":null,
            "dynamicAttributes":{
            },
            "smallImage":null,
            "fixedReplacementProducts":[
            ],
            "color":"Neon",
            "endDate":null,
            "derivedCatalogs":[
            ],
            "nonreturnable":false,
            "displayName":null,
            "onlineOnly":false,
            "description":null,
            "type":"sku-camcorder",
            "itemAcl":null,
            "translations":{
            },
            "unit_of_measure":null,
            "onSale":false,
            "dynamicPropertyMapString":{
            },
            "siteIds":[
            ],
            "id":"camcordersku_1_3",
            "thumbnailImage":null,
            "computedCatalogs":[
            ],
            "discountable":true,
            "wholesalePrice":null,
            "salePriceEndDate":null,
            "catalogsReplacementProducts":[
            ],
            "salePriceStartDate":null,
            "quantity":null,
            "salePrice":597,
            "skuInfos":{
            },
            "zoom":"2x optical/130x digital",
            "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,
                    "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",
                    "smallImageURLs":[
                        "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300"
                    ],
                    "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",
                    "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"
                    ],
                    "avgCustRating":null,
                    "listPrice":null
                }
            ],
            "auxiliaryMedia":{
            },
            "manufacturer_part_number":null,
            "catalogs":[
            ],
            "repositoryId":"camcordersku_1_3",
            "fulfiller":null,
            "dynamicPropertyMapDouble":{
            },
            "startDate":null,
            "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagent/v1/variants/camcordersku_1_3"
  }],
  "autoWrap": true,
  "items": [
    {
      "template": null,
      "dynamicPropertyMapLong": {
        "sku-camcorder_zoom": 0,
        "sku-camcorder_color": 2
      },
      "replacementProducts": null,
      "bundleLinks": [],
      "largeImage": null,
      "dynamicAttributes": {},
      "smallImage": null,
      "fixedReplacementProducts": [],
      "color": "Neon",
      "endDate": null,
      "derivedCatalogs": [],
      "nonreturnable": false,
      "displayName": null,
      "onlineOnly": false,
      "description": null,
      "type": "sku-camcorder",
      "itemAcl": null,
      "translations": {},
      "unit_of_measure": null,
      "onSale": false,
      "dynamicPropertyMapString": {},
      "siteIds": [],
      "id": "camcordersku_1_3",
      "thumbnailImage": null,
      "computedCatalogs": [],
      "discountable": true,
      "wholesalePrice": null,
      "salePriceEndDate": null,
      "catalogsReplacementProducts": [],
      "salePriceStartDate": null,
      "quantity": null,
      "salePrice": 597,
      "skuInfos": {},
      "zoom": "2x optical/130x digital",
      "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,
        "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",
        "smallImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300"],
        "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",
        "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"],
        "avgCustRating": null,
        "listPrice": null
      }],
      "auxiliaryMedia": {},
      "manufacturer_part_number": null,
      "catalogs": [],
      "repositoryId": "camcordersku_1_3",
      "fulfiller": null,
      "dynamicPropertyMapDouble": {},
      "startDate": null,
      "listPrice": 699.99
    },
    [
      {
        "optionValue": "Neon",
        "optionName": "color"
      },
      {
        "optionValue": "2x optical/130x digital",
        "optionName": "zoom"
      }
    ]
  ]
}