1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Agent
  4. Sku

listSkus

get

/ccagent/v1/skus

List Skus. Returns a paginated list of SKUs, including variant options, prices, and inventory. Optionally filtered by 'q' parameter. 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.Additionally takes x-cssite header to return the skus pertaining to the site

Request

Supported Media Types
  • application/json
Query Parameters
catalogId
Type: string
Catalog Id
q
Type: string
Contains SCIM query language
skuIds
Type: string
Comma separated multiple SKU IDS
storePriceListGroupId
Type: string
Store PriceList Group 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 : listSkus_response
Nested Schema : items
Type: array
The data for the sku.
Nested Schema : items
Type: object
Nested Schema : fullImageURLs
Type: array
The array of full image URLs
Nested Schema : images
Type: array
Image URLs of SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Nested Schema : listVolumePrices
Type: object
list volume prices of the product in respective price list groups
Nested Schema : mediumImageURLs
Type: array
medium image urls path
Nested Schema : parentProducts
Type: array
The list of parent products for the SKU.
Nested Schema : productListingSku
Type: object
product listing SKU property of the SKU
Nested Schema : productVariantOptions
Type: array
The selected options for the SKU.
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Nested Schema : saleVolumePrices
Type: object
Sale volume prices of the product in respective price list groups
Nested Schema : smallImage
Type: array
The array of small image URLs
Nested Schema : smallImageURLs
Type: array
small image url paths
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU
Nested Schema : variantValuesOrder
Type: object
Object having various variant property as key and ordered values array as the value.
Nested Schema : items
Type: object
Nested Schema : defaultProductListingSku
Type: object
default SKU for the product
Nested Schema : fullImageURLs
Type: array
full image url paths
Nested Schema : largeImageURLs
Type: array
The array of large image URLs
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Nested Schema : listVolumePrices
Type: object
list volume prices of the product in respective price list groups
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Nested Schema : saleVolumePrices
Type: object
Sale volume prices of the product in respective price list groups
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Nested Schema : smallImageURLs
Type: array
The urls of the small image.
Nested Schema : sourceImageURLs
Type: array
source image urls of the product
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of product
Nested Schema : items
Type: object
Example application/json

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/skus?q=barcode%20eq%20%2212345%22"
        }
    ],
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "dynamicPropertyMapLong":{
                "sku-WomensApparel_color":13,
                "sku-WomensApparel_size":0
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "derivedCatalogs":[
                {
                    "repositoryId":"cloudCatalog"
                }
            ],
            "endDate":null,
            "onlineOnly":false,
            "listPrices":{
                "defaultPriceGroup":55
            },
            "type":"sku-WomensApparel",
            "largeImageURLs":[
            ],
            "variantOptions":[
                [
                    {
                        "optionValue":"Poppy",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Small",
                        "optionName":"Size"
                    }
                ]
            ],
            "translations":{
                "1":{
                    "repositoryId":"xsku2535_1_en_US"
                },
                "27":{
                    "repositoryId":"xsku2535_1_vi"
                }
            },
            "id":"xsku2535_1",
            "barcode":"12345",
            "wholesalePrice":null,
            "salePriceEndDate":null,
            "images":[
            ],
            "unitOfMeasure":null,
            "primaryMediumImageURL":null,
            "skuInfos":{
            },
            "thumbImageURLs":[
            ],
            "creationDate":"2016-05-09T14:54:09.000Z",
            "version":4,
            "parentProducts":[
                {
                    "longDescription":"Wear this skirt anywhere with anything. Flat front allows shirts to be tucked in or overlaid nicely, side zipper and snap rivet detailing around the waist.",
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
                    "largeImage":null,
                    "smallImage":null,
                    "displayName":"A-Line Skirt",
                    "orderLimit":null,
                    "description":"The simple perfect A line",
                    "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
                    "largeImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=940&width=940"
                    ],
                    "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
                    "smallImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
                    ],
                    "id":"xprod2535",
                    "childSKUs":[
                        {
                            "repositoryId":"xsku2535_1"
                        },
                        {
                            "repositoryId":"xsku2535_2"
                        },
                        {
                            "repositoryId":"xsku2535_3"
                        },
                        {
                            "repositoryId":"xsku2535_4"
                        },
                        {
                            "repositoryId":"xsku2535_5"
                        },
                        {
                            "repositoryId":"xsku2535_6"
                        }
                    ],
                    "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
                    "salePrice":null,
                    "fullImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg"
                    ],
                    "active":true,
                    "thumbImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=100&width=100"
                    ],
                    "productImages":[
                        {
                            "repositoryId":"img_xprod2535_0"
                        },
                        {
                            "repositoryId":"img_xprod2535_1"
                        }
                    ],
                    "route":"/product/xprod2535",
                    "mediumImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=475&width=475"
                    ],
                    "repositoryId":"xprod2535",
                    "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                    "shippingSurcharge":null,
                    "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                    "sourceImageURLs":[
                        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
                        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
                    ],
                    "avgCustRating":null,
                    "listPrice":null
                }
            ],
            "size":"Small",
            "manufacturer_part_number":null,
            "catalogs":[
            ],
            "mediumImageURLs":[
            ],
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "startDate":null,
            "template":null,
            "primaryThumbImageURL":null,
            "replacementProducts":null,
            "dynamicAttributes":{
            },
            "fixedReplacementProducts":[
            ],
            "color":"Poppy",
            "nonreturnable":false,
            "displayName":"A-Line Skirt",
            "description":null,
            "primaryFullImageURL":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "productListingSku":null,
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "itemAcl":null,
            "onSale":false,
            "unit_of_measure":null,
            "dynamicPropertyMapString":{
            },
            "siteIds":[
            ],
            "computedCatalogs":[
            ],
            "discountable":true,
            "thumbnailImage":null,
            "catalogsReplacementProducts":[
            ],
            "salePriceStartDate":null,
            "quantity":100,
            "salePrice":null,
            "fullImageURLs":[
            ],
            "variantValuesOrder":{
            },
            "auxiliaryMedia":{
            },
            "repositoryId":"xsku2535_1",
            "shippingSurcharge":0,
            "fractionalQuantitiesAllowed":false,
            "fulfiller":null,
            "dynamicPropertyMapDouble":{
            },
            "configurable":false,
            "listPrice":55
        }
    ]
}
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| |------------------|------------------| |200020|Invalid query in 'q' parameter.| |30015|SiteId passed in x-ccsite header is currently inactive| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted| |50001|Internal Error.| |26050|Variants Internal Error.|
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:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 250,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/skus?q=barcode%20eq%20%2212345%22"
  }],
  "sort": [{
    "property": "id",
    "order": "asc"
  }],
  "items": [{
    "dynamicPropertyMapLong": {
      "sku-WomensApparel_color": 13,
      "sku-WomensApparel_size": 0
    },
    "bundleLinks": [],
    "largeImage": null,
    "smallImage": null,
    "derivedCatalogs": [{"repositoryId": "cloudCatalog"}],
    "endDate": null,
    "onlineOnly": false,
    "listPrices": {"defaultPriceGroup": 55},
    "type": "sku-WomensApparel",
    "largeImageURLs": [],
    "variantOptions": [[
      {
        "optionValue": "Poppy",
        "optionName": "Color"
      },
      {
        "optionValue": "Small",
        "optionName": "Size"
      }
    ]],
    "translations": {
      "1": {"repositoryId": "xsku2535_1_en_US"},
      "27": {"repositoryId": "xsku2535_1_vi"}
    },
    "id": "xsku2535_1",
    "barcode": "12345",
    "wholesalePrice": null,
    "salePriceEndDate": null,
    "images": [],
    "unitOfMeasure": null,
    "primaryMediumImageURL": null,
    "skuInfos": {},
    "thumbImageURLs": [],
    "creationDate": "2016-05-09T14:54:09.000Z",
    "version": 4,
    "parentProducts": [{
      "longDescription": "Wear this skirt anywhere with anything. Flat front allows shirts to be tucked in or overlaid nicely, side zipper and snap rivet detailing around the waist.",
      "primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
      "largeImage": null,
      "smallImage": null,
      "displayName": "A-Line Skirt",
      "orderLimit": null,
      "description": "The simple perfect A line",
      "primaryFullImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
      "largeImageURLs": [
        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=940&width=940"
      ],
      "primaryLargeImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
      "smallImageURLs": [
        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
      ],
      "id": "xprod2535",
      "childSKUs": [
        {"repositoryId": "xsku2535_1"},
        {"repositoryId": "xsku2535_2"},
        {"repositoryId": "xsku2535_3"},
        {"repositoryId": "xsku2535_4"},
        {"repositoryId": "xsku2535_5"},
        {"repositoryId": "xsku2535_6"}
      ],
      "primaryMediumImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
      "salePrice": null,
      "fullImageURLs": [
        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg"
      ],
      "active": true,
      "thumbImageURLs": [
        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=100&width=100"
      ],
      "productImages": [
        {"repositoryId": "img_xprod2535_0"},
        {"repositoryId": "img_xprod2535_1"}
      ],
      "route": "/product/xprod2535",
      "mediumImageURLs": [
        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=475&width=475"
      ],
      "repositoryId": "xprod2535",
      "primarySourceImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
      "shippingSurcharge": null,
      "primarySmallImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
      "sourceImageURLs": [
        "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
        "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
      ],
      "avgCustRating": null,
      "listPrice": null
    }],
    "size": "Small",
    "manufacturer_part_number": null,
    "catalogs": [],
    "mediumImageURLs": [],
    "primarySourceImageURL": null,
    "primarySmallImageURL": null,
    "sourceImageURLs": [],
    "startDate": null,
    "template": null,
    "primaryThumbImageURL": null,
    "replacementProducts": null,
    "dynamicAttributes": {},
    "fixedReplacementProducts": [],
    "color": "Poppy",
    "nonreturnable": false,
    "displayName": "A-Line Skirt",
    "description": null,
    "primaryFullImageURL": null,
    "salePrices": {"defaultPriceGroup": null},
    "productListingSku": null,
    "primaryLargeImageURL": null,
    "smallImageURLs": [],
    "itemAcl": null,
    "onSale": false,
    "unit_of_measure": null,
    "dynamicPropertyMapString": {},
    "siteIds": [],
    "computedCatalogs": [],
    "discountable": true,
    "thumbnailImage": null,
    "catalogsReplacementProducts": [],
    "salePriceStartDate": null,
    "quantity": 100,
    "salePrice": null,
    "fullImageURLs": [],
    "variantValuesOrder": {},
    "auxiliaryMedia": {},
    "repositoryId": "xsku2535_1",
    "shippingSurcharge": 0,
    "fractionalQuantitiesAllowed": false,
    "fulfiller": null,
    "dynamicPropertyMapDouble": {},
    "configurable": false,
    "listPrice": 55
  }]
}