Oracle Commerce Cloud October 2017

getSku

get

/ccstore/v1/skus/{id}

Get Sku. Gets the data and related selected options of a SKU.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The skuId.

Query Parameters

storePriceListGroupId: Type: 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.

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


{
    "productFamily":null,
    "dynamicPropertyMapLong":{
    },
    "primaryThumbImageURL":null,
    "largeImage":null,
    "smallImage":null,
    "listVolumePrice":null,
    "salePrices":{
        "defaultPriceGroup":null
    },
    "primaryFullImageURL":null,
    "listPrices":{
        "defaultPriceGroup":19.99
    },
    "productVariantOptions":[
        [
        ]
    ],
    "productListingSku":null,
    "largeImageURLs":[
    ],
    "productLine":null,
    "listVolumePrices":{
        "defaultPriceGroup":null
    },
    "primaryLargeImageURL":null,
    "smallImageURLs":[
    ],
    "model":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/skus/sku10009"
        }
    ],
    "thumbnailImage":null,
    "barcode":"200000002022",
    "saleVolumePrices":{
        "defaultPriceGroup":null
    },
    "salePriceEndDate":null,
    "saleVolumePrice":null,
    "salePriceStartDate":null,
    "images":[
    ],
    "quantity":null,
    "unitOfMeasure":null,
    "salePrice":null,
    "primaryMediumImageURL":null,
    "fullImageURLs":[
    ],
    "thumbImageURLs":[
    ],
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiIvY2NzdG9yZS92MS9za3VzL3NrdTEwMDA5IiwiaGFzaCI6Im85L3laUzJyeHUwVHdHU0FyVzhpeERnUXFnQWtWREYwUzFUaEZoQ1pEWWc9In0=",
    "variantValuesOrder":{
    },
    "parentProducts":[
        {
            "listVolumePrice":null,
            "relatedProducts":null,
            "orderLimit":null,
            "CountryOfOrigin":"US",
            "listPrices":{
                "defaultPriceGroup":19.99
            },
            "type":null,
            "largeImageURLs":[
                "/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=940&width=940"
            ],
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "primaryImageAltText":"Coaxial Audio Cable",
            "id":"prod10027",
            "brand":null,
            "parentCategories":[
                {
                    "repositoryId":"cat60043"
                },
                {
                    "repositoryId":"AllProdPagination"
                }
            ],
            "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",
            "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"
                },
                {
                    "repositoryId":"cat60023"
                },
                {
                    "repositoryId":"cat60035"
                },
                {
                    "repositoryId":"rootCategory"
                }
            ],
            "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=940&width=940",
            "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,
            "repositoryId":"prod10027",
            "width":null,
            "shippingSurcharge":null,
            "fractionalQuantitiesAllowed":false,
            "productImagesMetadata":[
                {
                }
            ],
            "configurable":false,
            "ancestorCategoriesForFullDeploy":[
            ],
            "listPrice":19.99
        }
    ],
    "mediumImageURLs":[
    ],
    "repositoryId":"sku10009",
    "primarySourceImageURL":null,
    "fractionalQuantitiesAllowed":false,
    "primarySmallImageURL":null,
    "sourceImageURLs":[
    ],
    "listPrice":19.99,
    "configurable":false
}

Default Response

The error response

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:

{
  "productFamily": null,
  "dynamicPropertyMapLong": {},
  "primaryThumbImageURL": null,
  "largeImage": null,
  "smallImage": null,
  "listVolumePrice": null,
  "salePrices": {"defaultPriceGroup": null},
  "primaryFullImageURL": null,
  "listPrices": {"defaultPriceGroup": 19.99},
  "productVariantOptions": [[]],
  "productListingSku": null,
  "largeImageURLs": [],
  "productLine": null,
  "listVolumePrices": {"defaultPriceGroup": null},
  "primaryLargeImageURL": null,
  "smallImageURLs": [],
  "model": null,
  "links": [{
    "rel": "self",
    "href": "http://localhost:8080/ccstoreui/v1/skus/sku10009"
  }],
  "thumbnailImage": null,
  "barcode": "200000002022",
  "saleVolumePrices": {"defaultPriceGroup": null},
  "salePriceEndDate": null,
  "saleVolumePrice": null,
  "salePriceStartDate": null,
  "images": [],
  "quantity": null,
  "unitOfMeasure": null,
  "salePrice": null,
  "primaryMediumImageURL": null,
  "fullImageURLs": [],
  "thumbImageURLs": [],
  "___etag___": "eyJ2ZXJzaW9uIjowLCJ1cmkiOiIvY2NzdG9yZS92MS9za3VzL3NrdTEwMDA5IiwiaGFzaCI6Im85L3laUzJyeHUwVHdHU0FyVzhpeERnUXFnQWtWREYwUzFUaEZoQ1pEWWc9In0=",
  "variantValuesOrder": {},
  "parentProducts": [{
    "listVolumePrice": null,
    "relatedProducts": null,
    "orderLimit": null,
    "CountryOfOrigin": "US",
    "listPrices": {"defaultPriceGroup": 19.99},
    "type": null,
    "largeImageURLs": ["/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=940&width=940"],
    "listVolumePrices": {"defaultPriceGroup": null},
    "primaryImageAltText": "Coaxial Audio Cable",
    "id": "prod10027",
    "brand": null,
    "parentCategories": [
      {"repositoryId": "cat60043"},
      {"repositoryId": "AllProdPagination"}
    ],
    "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",
    "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"},
      {"repositoryId": "cat60023"},
      {"repositoryId": "cat60035"},
      {"repositoryId": "rootCategory"}
    ],
    "primaryLargeImageURL": "/ccstore/v1/images/?source=/file/products/coaxialcable_LARGE.jpg&height=940&width=940",
    "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,
    "repositoryId": "prod10027",
    "width": null,
    "shippingSurcharge": null,
    "fractionalQuantitiesAllowed": false,
    "productImagesMetadata": [{}],
    "configurable": false,
    "ancestorCategoriesForFullDeploy": [],
    "listPrice": 19.99
  }],
  "mediumImageURLs": [],
  "repositoryId": "sku10009",
  "primarySourceImageURL": null,
  "fractionalQuantitiesAllowed": false,
  "primarySmallImageURL": null,
  "sourceImageURLs": [],
  "listPrice": 19.99,
  "configurable": false
}