1. Oracle Commerce Cloud October 2017
  2. Tasks
  3. Store
  4. Products

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
Nested Schema : childSKUs
Type: array
Array having the properties of child SKU of the product.
Nested Schema : defaultProductListingSku
Type: object
Default Product Listing Sku product
Nested Schema : keywords
Type: array
Keywords of product.
Nested Schema : largeImage
Type: object
Has repository ID and URL of the product.
Nested Schema : listPrices
Type: object
Object with price group IDs as keys and list prices as values
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs.
Nested Schema : parentCategories
Type: array
Array having repository ID of the product.
Nested Schema : productImages
Type: array
Array of product images.
Nested Schema : productImagesMetaData
Type: array
Image Metadata
Nested Schema : relatedProducts
Type: array
Array of related products.
Nested Schema : salePrices
Type: object
Object with price group IDs as keys and sale prices as values
Nested Schema : seoMetaInfo
Type: object
Seo meta info for category.
Nested Schema : shippingSurcharges
Type: object
Object with price group IDs as keys and shipping surcharges as values
Nested Schema : smallImageURLs
Type: array
Small image URL of the product.
Nested Schema : sourceImageURLs
Type: array
Source image URL.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of the product.
Nested Schema : items
Type: object
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Seo meta info for product.
Nested Schema : tags
Type: array
The array of product image tags
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : childSKUs
Type: array
Array having the properties of child SKU of the product.
Nested Schema : defaultProductListingSku
Type: object
Default Product Listing Sku product
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : keywords
Type: array
Keywords of product.
Nested Schema : largeImage
Type: object
Has repository ID and URL of the product.
Nested Schema : largeImageURLs
Type: array
Large Image URLs.
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : parentCategories
Type: array
Array having repository ID of the product.
Nested Schema : productImages
Type: array
Array of product images.
Nested Schema : productImagesMetaData
Type: array
Image Metadata
Nested Schema : seoMetaInfo
Type: object
Seo meta info for category.
Nested Schema : smallImageURLs
Type: array
Small Image URLs.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of the product.
Nested Schema : items
Type: object
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Seo meta info for product.
Nested Schema : tags
Type: array
The array of product image tags
Nested Schema : items
Type: object
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",
    "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,
            "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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

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",
  "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,
    "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": []
}