REST API for Oracle Commerce Cloud December 2017

getSku

get

/ccadmin/v1/skus/{id}

Get Sku. Gets a SKU and its properties. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The skuId.

Query Parameters

includePrices: Type: boolean

Boolean flag to determine whether to include price maps for the skus in the response.
priceListGroupId: Type: string

Price list group id for adding the prices to the SKU in the response.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getSku_response

Properties

barcode: Type: number

The barcode
configurable: Type: boolean

Whether the sku is configurable or not
fractionalQuantitiesAllowed: Type: boolean

Whether fractional quantities are allowed
fullImageURLs: Type: array fullImageURLs

Additional Properties Allowed:

The array of full image URLs
images: Type: array images

Additional Properties Allowed:

Image URLs of SKU.
largeImage: Type: string

large image path of the SKU
largeImageURLs: Type: array largeImageURLs

Additional Properties Allowed:

Large Image URLs of SKU.
listPrice: Type: number

The list price
listPrices: Type: object listPrices

Additional Properties Allowed:

list prices of the product in respective price list groups
listVolumePrice: Type: number

list volume price of the product
listVolumePrices: Type: object listVolumePrices

Additional Properties Allowed:

list volume prices of the product in respective price list groups
mediumImageURLs: Type: array mediumImageURLs

Additional Properties Allowed:

medium image urls path
model: Type: string

The model property of SKU.
nonreturnable: Type: string

Indicates whether the SKU is returnable or not.
parentProducts: Type: array parentProducts

Additional Properties Allowed:

The list of parent products for the SKU.
primaryFullImageURL: Type: string

Primary Full Image URL of SKU.
primaryLargeImageURL: Type: string

Primary Large Image URL of SKU.
primaryMediumImageURL: Type: string

primary medium image url path
primarySmallImageURL: Type: string

Primary Small Image URL of SKU.
primarySourceImageURL: Type: string

primary source image url path
primaryThumbImageURL: Type: string

Primary Source Image URL of SKU.
productFamily: Type: string

product family property of the SKU
productLine: Type: string

product line of the SKU
productListingSku: Type: object productListingSku

Additional Properties Allowed:

product listing SKU property of the SKU
productVariantOptions: Type: array productVariantOptions

Additional Properties Allowed:

The selected options for the SKU.
quantity: Type: integer

quantity of the SKU
repositoryId: Type: string

repository id of the child SKU
salePrice: Type: number

sale price of the SKU.
salePriceEndDate: Type: string

sale price end date of the SKU
salePrices: Type: object salePrices

Additional Properties Allowed:

sale prices of the product in respective price list groups
salePriceStartDate: Type: string

sale price start date of the SKU
saleVolumePrice: Type: number

The sale volume price
saleVolumePrices: Type: object saleVolumePrices

Additional Properties Allowed:

Sale volume prices of the product in respective price list groups
smallImage: Type: array smallImage

Additional Properties Allowed:

The array of small image URLs
smallImageURLs: Type: array smallImageURLs

Additional Properties Allowed:

small image url paths
sourceImageURLs: Type: array sourceImageURLs

Additional Properties Allowed:

Source Image URLs of SKU.
thumbImageURLs: Type: array thumbImageURLs

Additional Properties Allowed:

Thumb Image URLs of SKU
thumbnailImage: Type: string

The thumbanil image of the SKU
unitOfMeasure: Type: string

unit of measure of the SKU
variantValuesOrder: Type: object variantValuesOrder

Additional Properties Allowed:

Object having various variant property as key and ordered values array as the value.

Nested Schema : fullImageURLs

Type: array

The array of full image URLs

Items

Type: string

Nested Schema : images

Type: array

Image URLs of SKU.

Items

Type: string

Nested Schema : largeImageURLs

Type: array

Large Image URLs of SKU.

Items

Type: string

Nested Schema : listPrices

Type: object

list prices of the product in respective price list groups

Properties

plg1: Type: number

list price of the product in plg1
plg2: Type: number

list price of the product in plg2

Nested Schema : listVolumePrices

Type: object

list volume prices of the product in respective price list groups

Properties

plg1: Type: number

list volume price of the product in plg1
plg2: Type: number

list volume price of the product in plg2

Nested Schema : mediumImageURLs

Type: array

medium image urls path

Items

Type: string

Nested Schema : parentProducts

Type: array

The list of parent products for the SKU.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : productListingSku

Type: object

product listing SKU property of the SKU

Nested Schema : productVariantOptions

Type: array

The selected options for the SKU.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : salePrices

Type: object

sale prices of the product in respective price list groups

Properties

plg1: Type: number

sale price of the product in plg1
plg2: Type: number

sale price of the product in plg2

Nested Schema : saleVolumePrices

Type: object

Sale volume prices of the product in respective price list groups

Properties

plg1: Type: number

Sale volume price of the product in plg1
plg2: Type: number

Sale volume price of the product in plg2

Nested Schema : smallImage

Type: array

The array of small image URLs

Items

Type: string

Nested Schema : smallImageURLs

Type: array

small image url paths

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

Source Image URLs of SKU.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

Thumb Image URLs of SKU

Items

Type: string

Nested Schema : variantValuesOrder

Type: object

Object having various variant property as key and ordered values array as the value.

Properties

Nested Schema : items

Type: object

Properties

active: Type: boolean

The active property of the product
avgCustRating: Type: number

average customer rating for the product
brand: Type: string

brand of the product
configurable: Type: boolean

whether the product is configurable or not
CountryOfOrigin: Type: string

the country of origin of the product
defaultProductListingSku: Type: object defaultProductListingSku

Additional Properties Allowed:

default SKU for the product
description: Type: string

description of the product
displayName: Type: string

The display name of the product
fractionalQuantitiesAllowed: Type: boolean

Whether fractional quantities are allowed
fullImageURLs: Type: array fullImageURLs

Additional Properties Allowed:

full image url paths
height: Type: number

height of the product
id: Type: string

id of the product
largeImageURLs: Type: array largeImageURLs

Additional Properties Allowed:

The array of large image URLs
length: Type: number

length of the product
listPrice: Type: number

list price of the product
listPrices: Type: object listPrices

Additional Properties Allowed:

list prices of the product in respective price list groups
listVolumePrice: Type: number

list volume price of the product
listVolumePrices: Type: object listVolumePrices

Additional Properties Allowed:

list volume prices of the product in respective price list groups
longDescription: Type: string

long description of the product
mediumImageURLs: Type: array mediumImageURLs

Additional Properties Allowed:

Medium Image URLs SKU.
nonreturnable: Type: boolean

Indicates whether the product is returnable or not.
notForIndividualSale: Type: boolean

Whether the product is not for individual sale
orderLimit: Type: string

the order limit of the product
parentCategory: Type: string

parent category of the product
primaryFullImageURL: Type: string

primary full image url path
primaryImageAltText: Type: string

Alternate text for the primary image of the product
primaryImageTitle: Type: string

primary image title of the product
primaryLargeImageURL: Type: string

primary large image url path
primaryMediumImageURL: Type: string

Primary Medium Image URL ID of SKU.
primarySmallImageURL: Type: string

Primary Small Image URL of product
primarySourceImageURL: Type: string

primary source image url path
primaryThumbImageURL: Type: string

primary thumb image url path
relatedProducts: Type: string

related products
repositoryId: Type: string

repository id of the product
route: Type: string

route of the product
salePrice: Type: number

The sale price of the product
salePrices: Type: object salePrices

Additional Properties Allowed:

sale prices of the product in respective price list groups
saleVolumePrice: Type: number

The sale volume price
saleVolumePrices: Type: object saleVolumePrices

Additional Properties Allowed:

Sale volume prices of the product in respective price list groups
seoUrlSlugDerived: Type: string

Derived from seoUrlSlug of the product if available, else derived from display name of the product.
shippingSurcharge: Type: number

Extra handling costs for shipping the product.
shippingSurcharges: Type: object shippingSurcharges

Additional Properties Allowed:

Extra handling costs for shipping the product in respective price list groups
smallImageURLs: Type: array smallImageURLs

Additional Properties Allowed:

The urls of the small image.
sourceImageURLs: Type: array sourceImageURLs

Additional Properties Allowed:

source image urls of the product
thumbImageURLs: Type: array thumbImageURLs

Additional Properties Allowed:

Thumb Image URLs of product
type: Type: string

type of the product
unitOfMeasure: Type: string

unit of measure of the product
weight: Type: number

weight
width: Type: number

width of the product

Nested Schema : defaultProductListingSku

Type: object

default SKU for the product

Nested Schema : fullImageURLs

Type: array

full image url paths

Items

Type: string

Nested Schema : largeImageURLs

Type: array

The array of large image URLs

Items

Type: string

Nested Schema : listPrices

Type: object

list prices of the product in respective price list groups

Properties

plg1: Type: number

list price of the product in plg1
plg2: Type: number

list price of the product in plg2

Nested Schema : listVolumePrices

Type: object

list volume prices of the product in respective price list groups

Properties

plg1: Type: number

list volume price of the product in plg1
plg2: Type: number

list volume price of the product in plg2

Nested Schema : mediumImageURLs

Type: array

Medium Image URLs SKU.

Items

Type: string

Nested Schema : salePrices

Type: object

sale prices of the product in respective price list groups

Properties

plg1: Type: number

sale price of the product in plg1
plg2: Type: number

sale price of the product in plg2

Nested Schema : saleVolumePrices

Type: object

Sale volume prices of the product in respective price list groups

Properties

plg1: Type: number

Sale volume price of the product in plg1
plg2: Type: number

Sale volume price of the product in plg2

Nested Schema : shippingSurcharges

Type: object

Extra handling costs for shipping the product in respective price list groups

Properties

plg1: Type: number

Extra handling costs for shipping the product in plg1
plg2: Type: number

Extra handling costs for shipping the product in plg2

Nested Schema : smallImageURLs

Type: array

The urls of the small image.

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 product

Items

Type: string

Nested Schema : items

Type: object

Properties

optionName: Type: string

The name of the option.
optionValue: Type: string

The value of the option.

Example application/json


{
    "productFamily":null,
    "dynamicPropertyMapLong":{
        "sku-MensApparel_color":6,
        "sku-MensApparel_size":0
    },
    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=100&width=100",
    "bundleLinks":[
        {
            "item":{
                "displayName":"Blue T Shirt",
                "repositoryId":"sku30001"
            },
            "quantity":1,
            "repositoryId":"skul10001"
        },
        {
            "item":{
                "displayName":"Red T Shirt",
                "repositoryId":"sku30002"
            },
            "quantity":1,
            "repositoryId":"skul10002"
        }
    ],
    "largeImage":null,
    "smallImage":null,
    "color":"Gray",
    "listVolumePrice":null,
    "nonreturnable":false,
    "displayName":"sku30043",
    "salePrices":{
        "defaultPriceGroup":599
    },
    "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg",
    "listPrices":{
        "defaultPriceGroup":null
    },
    "productListingSku":true,
    "largeImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=940&width=940"
    ],
    "productLine":null,
    "listVolumePrices":{
        "defaultPriceGroup":null
    },
    "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=940&width=940",
    "smallImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300"
    ],
    "model":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/skus/sku30043"
        }
    ],
    "thumbnailImage":null,
    "barcode":null,
    "saleVolumePrices":{
        "defaultPriceGroup":null
    },
    "salePriceEndDate":null,
    "saleVolumePrice":null,
    "salePriceStartDate":null,
    "images":[
        {
            "path":"/products/ACC_TerryGloves_full.jpg",
            "metadata":{
            },
            "name":"/products/ACC_TerryGloves_full.jpg",
            "repositoryId":"m10002",
            "url":"http://localhost:9080/file/products/ACC_TerryGloves_full.jpg",
            "tags":[
            ]
        }
    ],
    "quantity":null,
    "unitOfMeasure":null,
    "salePrice":null,
    "primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=475&width=475",
    "fullImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg"
    ],
    "dynamicPropertyMapBigString":{
    },
    "active":true,
    "thumbImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=100&width=100"
    ],
    "size":"Small",
    "mediumImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=475&width=475"
    ],
    "repositoryId":"sku30043",
    "primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300",
    "primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300",
    "sourceImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300"
    ],
    "listPrice":null,
    "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

Additional Properties Allowed:

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

Additional Properties Allowed:

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": {
    "sku-MensApparel_color": 6,
    "sku-MensApparel_size": 0
  },
  "primaryThumbImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=100&width=100",
  "bundleLinks": [
    {
      "item": {
        "displayName": "Blue T Shirt",
        "repositoryId": "sku30001"
      },
      "quantity": 1,
      "repositoryId": "skul10001"
    },
    {
      "item": {
        "displayName": "Red T Shirt",
        "repositoryId": "sku30002"
      },
      "quantity": 1,
      "repositoryId": "skul10002"
    }
  ],
  "largeImage": null,
  "smallImage": null,
  "color": "Gray",
  "listVolumePrice": null,
  "nonreturnable": false,
  "displayName": "sku30043",
  "salePrices": {"defaultPriceGroup": 599},
  "primaryFullImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg",
  "listPrices": {"defaultPriceGroup": null},
  "productListingSku": true,
  "largeImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=940&width=940"],
  "productLine": null,
  "listVolumePrices": {"defaultPriceGroup": null},
  "primaryLargeImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=940&width=940",
  "smallImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300"],
  "model": null,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/skus/sku30043"
  }],
  "thumbnailImage": null,
  "barcode": null,
  "saleVolumePrices": {"defaultPriceGroup": null},
  "salePriceEndDate": null,
  "saleVolumePrice": null,
  "salePriceStartDate": null,
  "images": [{
    "path": "/products/ACC_TerryGloves_full.jpg",
    "metadata": {},
    "name": "/products/ACC_TerryGloves_full.jpg",
    "repositoryId": "m10002",
    "url": "http://localhost:9080/file/products/ACC_TerryGloves_full.jpg",
    "tags": []
  }],
  "quantity": null,
  "unitOfMeasure": null,
  "salePrice": null,
  "primaryMediumImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=475&width=475",
  "fullImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg"],
  "dynamicPropertyMapBigString": {},
  "active": true,
  "thumbImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=100&width=100"],
  "size": "Small",
  "mediumImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=475&width=475"],
  "repositoryId": "sku30043",
  "primarySourceImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300",
  "primarySmallImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300",
  "sourceImageURLs": ["/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300"],
  "listPrice": null,
  "configurable": "false"
}