REST API for Oracle Commerce Cloud December 2017

getProduct

get

/ccstore/v1/products/{id}

Get Product. Get a product. Optionally takes the x-ccasset-language headers to get translated content in another language.Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization id of logged in user.None of the image URLS are encoded.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

the id of the product to retrieve

Query Parameters

catalogId: Type: string

the catalog ID of the site
storePriceListGroupId: Type: string

the price list group id for which product prices are to be returned

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 : getProduct_response

Properties

active: Type: boolean

Product active property
arrivalDate: Type: string

arrival date of the product
auxiliaryMedia: Type: string

auxiliary media
avgCustRating: Type: number

average customer rating for the product
brand: Type: string

brand of the product
childSKUs: Type: array childSKUs

Additional Properties Allowed:

List of SKU's for the product
creationDate: Type: string

product creation date
custRatingCount: Type: integer

total count of the customer rating for the product
dateAvailable: Type: string

available date
daysAvailable: Type: integer

available number of days
description: Type: string

description of the product
discountable: Type: boolean

Product discountable property
displayName: Type: string

display name of the product
dynamicRelatedProducts: Type: string

dynamic related products
dynamicUpsellProducts: Type: string

dynamic upsell products
endDate: Type: string

end date
fullImageURLs: Type: array fullImageURLs

Additional Properties Allowed:

full image url paths.The urls are not encoded.
height: Type: number

height of the product
id: Type: string

id of the product
itemAcl: Type: string

item acl
largeImage: Type: string

large image url path of the product. The url is not encoded.
largeImageURLs: Type: string

large image urls. The url is not encoded.
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
longDescription: Type: string

long description of the product
mediumImageURLs: Type: array mediumImageURLs

Additional Properties Allowed:

medium image urls path. The urls are not encoded.
nonreturnable: Type: boolean

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

States whether not a product may be sold individually rather than, for example, as part of a configured product
onlineOnly: Type: boolean

online only property
orderable: Type: string

orderable property
orderLimit: Type: integer

order limit
parentCategory: Type: string

parent category of the product
primaryFullImageURL: Type: string

primary full image url path. The url is not encoded.
primaryLargeImageURL: Type: string

primary large image url path. The url is not encoded.
primaryMediumImageURL: Type: string

primary medium image url path. The url is not encoded.
primarySmallImageURL: Type: string

primary small image url path. The url is not encoded.
primarySourceImageURL: Type: string

primary source image url path. The url is not encoded.
primaryThumbImageURL: Type: string

primary thumb image url path. The url is not encoded.
productVariantOptions: Type: array productVariantOptions

Additional Properties Allowed:

Objects containing product's variant options details if available for the product.
relatedProductGroup: Type: string

related product group
relatedProducts: Type: string

related products
repositoryId: Type: string

repository id of the product
route: Type: string

route of the product
salePrice: Type: string

sale price of the product
salePriceEndDate: Type: string

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

Additional Properties Allowed:

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

start date of the product's sale price
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
skuOptionsInfo: Type: string

Sku options info
smallImage: Type: string

small image path of the product. The url is not encoded.
smallImageURLs: Type: array smallImageURLs

Additional Properties Allowed:

small image url paths. The urls are not encoded.
sourceImageURLs: Type: array sourceImageURLs

Additional Properties Allowed:

source image urls of the product. The urls are not encoded.
startDate: Type: string

start date
taxCode: Type: string

tax code of the product
template: Type: string

template
thumbImageURLs: Type: array thumbImageURLs

Additional Properties Allowed:

thumb image urls of the product. The urls are not encoded.
type: Type: string

type of the product
upsellProductGroup: Type: string

upsell product group
upsellProducts: Type: string

upsell products
variantValuesOrder: Type: object variantValuesOrder

Additional Properties Allowed:

Object having various variant property as key and ordered values array as the value.
version: Type: string

version of the product
weight: Type: number

weight
width: Type: number

width of the product

Nested Schema : childSKUs

Type: array

List of SKU's for the product

Items

Type: object items

Additional Properties Allowed:

Nested Schema : fullImageURLs

Type: array

full image url paths.The urls are not encoded.

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 : mediumImageURLs

Type: array

medium image urls path. The urls are not encoded.

Items

Type: string

Nested Schema : productVariantOptions

Type: array

Objects containing product's variant options details if available for the product.

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 : 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

small image url paths. The urls are not encoded.

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

source image urls of the product. The urls are not encoded.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

thumb image urls of the product. The urls are not encoded.

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

SKU active property
DynamicSKUProperty: Type: string

Dynamic Properties of SKU.
fullImageURLs: Type: array fullImageURLs

Additional Properties Allowed:

Full 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

list price of the SKU
listPrices: Type: object listPrices

Additional Properties Allowed:

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

Additional Properties Allowed:

Medium Image URLs SKU.
nonreturnable: Type: boolean

Indicates whether the SKU is returnable or not.
primaryLargeImageURL: Type: string

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

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

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

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

Primary Source Image URL of 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 SKU in respective price list groups
salePriceStartDate: Type: string

sale price start date of the SKU.
shippingSurcharge: Type: number

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

Additional Properties Allowed:

Extra handling costs for shipping the product in respective price list groups
smallImage: Type: string

small image path of the product
smallImageURLs: Type: array smallImageURLs

Additional Properties Allowed:

Small Image URLs of SKU.
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

thumbnail image path of the product

Nested Schema : fullImageURLs

Type: array

Full 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 SKU in respective price list groups

Properties

plg1: Type: number

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

list price of the SKU in plg2

Nested Schema : mediumImageURLs

Type: array

Medium Image URLs SKU.

Items

Type: string

Nested Schema : salePrices

Type: object

sale prices of the SKU in respective price list groups

Properties

plg1: Type: number

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

sale price of the SKU 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

Small Image URLs of SKU.

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 : items

Type: object

Properties

mapKeyPropertyAttribute: Type: string

map key property
optionId: Type: string

option Id
optionName: Type: string

option Name
optionValueMap: Type: object optionValueMap

Additional Properties Allowed: { "type":"string" }

mapping of all option values with corresponding option value ids

Nested Schema : optionValueMap

Type: object

Additional Properties Allowed

Type: string

mapping of all option values with corresponding option value ids

Properties

optionValue: Type: string

Option Value
optionValueId: Type: integer

Option Value Id

Example application/json


{
    "dynamicPropertyMapLong":{
    },
    "largeImage":null,
    "smallImage":null,
    "upsellProductGroup":null,
    "keywords":[
    ],
    "endDate":null,
    "derivedCatalogs":[
    ],
    "custRatingCount":null,
    "orderable":null,
    "relatedProducts":null,
    "orderLimit":null,
    "onlineOnly":false,
    "listPrices":null,
    "dynamicUpsellProducts":null,
    "type":null,
    "largeImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940"
    ],
    "ancestorCategoryIds":[
    ],
    "productInfos":{
    },
    "id":"xprod2119",
    "brand":"Fisher's Colony",
    "salePriceEndDate":null,
    "height":null,
    "defaultProductListingSku":null,
    "primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475",
    "skuOptionsInfo":null,
    "seoUrlSlugDerived":"vineyard-antique-arm-chair",
    "dynamicPropertyMapBigString":{
    },
    "active":true,
    "weight":null,
    "thumbImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100"
    ],
    "taxCode":"PC030100",
    "creationDate":"2014-10-27T05:11:57.034Z",
    "version":2,
    "arrivalDate":null,
    "route":"/vineyard-antique-arm-chair/product/xprod2119",
    "catalogs":[
    ],
    "mediumImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475"
    ],
    "primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
    "parentCategory":null,
    "primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
    "sourceImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"
    ],
    "avgCustRating":null,
    "startDate":null,
    "longDescription":"This 18th century antique reproduction arm chair features hand-carved walnut and spring cushion base. Upholstered in buttery soft print textile with a lovely vintage pattern.",
    "template":null,
    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100",
    "nonreturnable":false,
    "displayName":"Vineyard Antique Arm Chair",
    "description":"Hand-carved walnut",
    "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg",
    "salePrices":null,
    "productVariantOptions":[
        {
            "optionValueMap":{
                "Silver":1,
                "Neon":2,
                "Black":0
            },
            "optionId":"color",
            "mapKeyPropertyAttribute":"sku-camcorder_color",
            "optionName":"color"
        }
    ],
    "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940",
    "smallImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"
    ],
    "itemAcl":null,
    "shippingSurcharges":null,
    "displayableSkuAttributes":[
    ],
    "dynamicPropertyMapString":{
    },
    "siteIds":[
    ],
    "thumbnailImage":null,
    "discountable":true,
    "computedCatalogs":[
    ],
    "childSKUs":[
        {
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "largeImage":null,
            "smallImage":null,
            "nonreturnable":false,
            "listPrices":null,
            "salePrices":null,
            "primaryFullImageURL":null,
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "shippingSurcharges":null,
            "thumbnailImage":null,
            "salePriceEndDate":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "repositoryId":"xsku2119",
            "DynamicSkuProperty2":"value2",
            "shippingSurcharge":null,
            "DynamicSkuProperty1":"value1",
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":219
        }
    ],
    "salePriceStartDate":null,
    "catalogsRelatedProducts":[
    ],
    "fixedRelatedProducts":[
    ],
    "salePrice":null,
    "fullImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg"
    ],
    "length":null,
    "upsellProducts":null,
    "parentCategoriesForCatalog":{
    },
    "variantValuesOrder":{
        "color":[
            "Spring Green",
            "Cranberry",
            "Marigold"
        ],
        "size":[
            "Small",
            "Large",
            "Medium"
        ]
    },
    "relatedProductGroup":null,
    "auxiliaryMedia":{
    },
    "dateAvailable":"2014-10-27T05:11:57.034Z",
    "width":null,
    "repositoryId":"xprod2119",
    "shippingSurcharge":null,
    "ancestorCategories":[
    ],
    "daysAvailable":0,
    "dynamicPropertyMapDouble":{
    },
    "listPrice":219,
    "dynamicRelatedProducts":null,
    "fixedUpsellProducts":[
    ]
}

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:

{
  "dynamicPropertyMapLong": {},
  "largeImage": null,
  "smallImage": null,
  "upsellProductGroup": null,
  "keywords": [],
  "endDate": null,
  "derivedCatalogs": [],
  "custRatingCount": null,
  "orderable": null,
  "relatedProducts": null,
  "orderLimit": null,
  "onlineOnly": false,
  "listPrices": null,
  "dynamicUpsellProducts": null,
  "type": null,
  "largeImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940"],
  "ancestorCategoryIds": [],
  "productInfos": {},
  "id": "xprod2119",
  "brand": "Fisher's Colony",
  "salePriceEndDate": null,
  "height": null,
  "defaultProductListingSku": null,
  "primaryMediumImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475",
  "skuOptionsInfo": null,
  "seoUrlSlugDerived": "vineyard-antique-arm-chair",
  "dynamicPropertyMapBigString": {},
  "active": true,
  "weight": null,
  "thumbImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100"],
  "taxCode": "PC030100",
  "creationDate": "2014-10-27T05:11:57.034Z",
  "version": 2,
  "arrivalDate": null,
  "route": "/vineyard-antique-arm-chair/product/xprod2119",
  "catalogs": [],
  "mediumImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475"],
  "primarySourceImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
  "parentCategory": null,
  "primarySmallImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
  "sourceImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"],
  "avgCustRating": null,
  "startDate": null,
  "longDescription": "This 18th century antique reproduction arm chair features hand-carved walnut and spring cushion base. Upholstered in buttery soft print textile with a lovely vintage pattern.",
  "template": null,
  "primaryThumbImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100",
  "nonreturnable": false,
  "displayName": "Vineyard Antique Arm Chair",
  "description": "Hand-carved walnut",
  "primaryFullImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg",
  "salePrices": null,
  "productVariantOptions": [{
    "optionValueMap": {
      "Silver": 1,
      "Neon": 2,
      "Black": 0
    },
    "optionId": "color",
    "mapKeyPropertyAttribute": "sku-camcorder_color",
    "optionName": "color"
  }],
  "primaryLargeImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940",
  "smallImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"],
  "itemAcl": null,
  "shippingSurcharges": null,
  "displayableSkuAttributes": [],
  "dynamicPropertyMapString": {},
  "siteIds": [],
  "thumbnailImage": null,
  "discountable": true,
  "computedCatalogs": [],
  "childSKUs": [{
    "dynamicPropertyMapLong": {},
    "primaryThumbImageURL": null,
    "largeImage": null,
    "smallImage": null,
    "nonreturnable": false,
    "listPrices": null,
    "salePrices": null,
    "primaryFullImageURL": null,
    "productListingSku": null,
    "largeImageURLs": [],
    "primaryLargeImageURL": null,
    "smallImageURLs": [],
    "shippingSurcharges": null,
    "thumbnailImage": null,
    "salePriceEndDate": null,
    "salePriceStartDate": null,
    "images": [],
    "salePrice": null,
    "primaryMediumImageURL": null,
    "fullImageURLs": [],
    "active": true,
    "thumbImageURLs": [],
    "mediumImageURLs": [],
    "repositoryId": "xsku2119",
    "DynamicSkuProperty2": "value2",
    "shippingSurcharge": null,
    "DynamicSkuProperty1": "value1",
    "primarySourceImageURL": null,
    "primarySmallImageURL": null,
    "sourceImageURLs": [],
    "listPrice": 219
  }],
  "salePriceStartDate": null,
  "catalogsRelatedProducts": [],
  "fixedRelatedProducts": [],
  "salePrice": null,
  "fullImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg"],
  "length": null,
  "upsellProducts": null,
  "parentCategoriesForCatalog": {},
  "variantValuesOrder": {
    "color": [
      "Spring Green",
      "Cranberry",
      "Marigold"
    ],
    "size": [
      "Small",
      "Large",
      "Medium"
    ]
  },
  "relatedProductGroup": null,
  "auxiliaryMedia": {},
  "dateAvailable": "2014-10-27T05:11:57.034Z",
  "width": null,
  "repositoryId": "xprod2119",
  "shippingSurcharge": null,
  "ancestorCategories": [],
  "daysAvailable": 0,
  "dynamicPropertyMapDouble": {},
  "listPrice": 219,
  "dynamicRelatedProducts": null,
  "fixedUpsellProducts": []
}