1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Skus

listSkus

get

/ccadmin/v1/skus

List Skus. Gets a list of SKUs and its properties. Optionally, search for SKUs in the given catalog by performing a case-insensitive, partial-match on the display name or ID. Optionally, takes the x-ccasset-language header to get translated content in another language. To get the list of SKUs by SKU ids, use skuIds parameter.

Request

Supported Media Types
  • application/json
Query Parameters
catalogId
Type: string
ID of the catalog.
expand
Type: boolean
Boolean indicating whether to return a larger set of SKU properties. Default value is false.
includePrices
Type: boolean
Boolean flag to determine whether to include price maps for the skus in the response. Default value is true.
name
Type: string
Partial displayName or id of a SKU to use for search.
pageResults
Type: boolean
Return response with paginated pattern, to be used with query param skuIds. Default value is false.
priceListGroupId
Type: string
Price list group id for adding the prices to the SKU in the response.
showInactiveSkus
Type: boolean
Boolean flag to determine whether to include inactive SKUs as part of the result. Default value is true.
showSkuBundles
Type: boolean
Boolean flag to determine whether to include SKU bundles as part of the result. Default value is true.
showTranslations
Type: boolean
Boolean indicating if the translations property should be returned for each item in the response. Default value is false.
skuIds
Type: string
SKU IDs to list.
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 : 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":4,
    "totalResults":4,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/skus?name=sku1000&pageResults=true"
        }
    ],
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "productFamily":null,
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "listPrices":{
                "defaultPriceGroup":199.99
            },
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "model":null,
            "thumbnailImage":null,
            "barcode":"200000001995",
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "salePriceEndDate":null,
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "quantity":null,
            "unitOfMeasure":null,
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "repositoryId":"sku10005",
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":199.99,
            "configurable":false
        },
        {
            "productFamily":null,
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "listPrices":{
                "defaultPriceGroup":199.99
            },
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "model":null,
            "thumbnailImage":null,
            "barcode":"200000002008",
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "salePriceEndDate":null,
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "quantity":null,
            "unitOfMeasure":null,
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "repositoryId":"sku10007",
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":199.99,
            "configurable":false
        },
        {
            "productFamily":null,
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "listPrices":{
                "defaultPriceGroup":9.99
            },
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "model":null,
            "thumbnailImage":null,
            "barcode":"200000002015",
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "salePriceEndDate":null,
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "quantity":null,
            "unitOfMeasure":null,
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "repositoryId":"sku10008",
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":9.99,
            "configurable":false
        },
        {
            "productFamily":null,
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "listPrices":{
                "defaultPriceGroup":19.99
            },
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "model":null,
            "thumbnailImage":null,
            "barcode":"200000002022",
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "salePriceEndDate":null,
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "quantity":null,
            "unitOfMeasure":null,
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "repositoryId":"sku10009",
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":19.99,
            "configurable":false
        }
    ]
}
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| |------------------|------------------| |20038|Cannot build the query.| |20144|Cannot get catalog view.| |20055|The SKU view does not support queries containing parameters.| |25013|price List InternalError| |200105|Catalog not found in the repository| |200104|Catalog ID is invalid or not associated with current profile.|
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": 4,
  "totalResults": 4,
  "offset": 0,
  "limit": 250,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/skus?name=sku1000&pageResults=true"
  }],
  "sort": [{
    "property": "displayName",
    "order": "asc"
  }],
  "items": [
    {
      "productFamily": null,
      "dynamicPropertyMapLong": {},
      "primaryThumbImageURL": null,
      "bundleLinks": [],
      "largeImage": null,
      "smallImage": null,
      "listVolumePrice": null,
      "nonreturnable": false,
      "displayName": null,
      "salePrices": {"defaultPriceGroup": null},
      "primaryFullImageURL": null,
      "listPrices": {"defaultPriceGroup": 199.99},
      "productListingSku": null,
      "largeImageURLs": [],
      "productLine": null,
      "listVolumePrices": {"defaultPriceGroup": null},
      "primaryLargeImageURL": null,
      "smallImageURLs": [],
      "model": null,
      "thumbnailImage": null,
      "barcode": "200000001995",
      "saleVolumePrices": {"defaultPriceGroup": null},
      "salePriceEndDate": null,
      "saleVolumePrice": null,
      "salePriceStartDate": null,
      "images": [],
      "quantity": null,
      "unitOfMeasure": null,
      "salePrice": null,
      "primaryMediumImageURL": null,
      "fullImageURLs": [],
      "dynamicPropertyMapBigString": {},
      "active": true,
      "thumbImageURLs": [],
      "mediumImageURLs": [],
      "repositoryId": "sku10005",
      "primarySourceImageURL": null,
      "primarySmallImageURL": null,
      "sourceImageURLs": [],
      "listPrice": 199.99,
      "configurable": false
    },
    {
      "productFamily": null,
      "dynamicPropertyMapLong": {},
      "primaryThumbImageURL": null,
      "bundleLinks": [],
      "largeImage": null,
      "smallImage": null,
      "listVolumePrice": null,
      "nonreturnable": false,
      "displayName": null,
      "salePrices": {"defaultPriceGroup": null},
      "primaryFullImageURL": null,
      "listPrices": {"defaultPriceGroup": 199.99},
      "productListingSku": null,
      "largeImageURLs": [],
      "productLine": null,
      "listVolumePrices": {"defaultPriceGroup": null},
      "primaryLargeImageURL": null,
      "smallImageURLs": [],
      "model": null,
      "thumbnailImage": null,
      "barcode": "200000002008",
      "saleVolumePrices": {"defaultPriceGroup": null},
      "salePriceEndDate": null,
      "saleVolumePrice": null,
      "salePriceStartDate": null,
      "images": [],
      "quantity": null,
      "unitOfMeasure": null,
      "salePrice": null,
      "primaryMediumImageURL": null,
      "fullImageURLs": [],
      "dynamicPropertyMapBigString": {},
      "active": true,
      "thumbImageURLs": [],
      "mediumImageURLs": [],
      "repositoryId": "sku10007",
      "primarySourceImageURL": null,
      "primarySmallImageURL": null,
      "sourceImageURLs": [],
      "listPrice": 199.99,
      "configurable": false
    },
    {
      "productFamily": null,
      "dynamicPropertyMapLong": {},
      "primaryThumbImageURL": null,
      "bundleLinks": [],
      "largeImage": null,
      "smallImage": null,
      "listVolumePrice": null,
      "nonreturnable": false,
      "displayName": null,
      "salePrices": {"defaultPriceGroup": null},
      "primaryFullImageURL": null,
      "listPrices": {"defaultPriceGroup": 9.99},
      "productListingSku": null,
      "largeImageURLs": [],
      "productLine": null,
      "listVolumePrices": {"defaultPriceGroup": null},
      "primaryLargeImageURL": null,
      "smallImageURLs": [],
      "model": null,
      "thumbnailImage": null,
      "barcode": "200000002015",
      "saleVolumePrices": {"defaultPriceGroup": null},
      "salePriceEndDate": null,
      "saleVolumePrice": null,
      "salePriceStartDate": null,
      "images": [],
      "quantity": null,
      "unitOfMeasure": null,
      "salePrice": null,
      "primaryMediumImageURL": null,
      "fullImageURLs": [],
      "dynamicPropertyMapBigString": {},
      "active": true,
      "thumbImageURLs": [],
      "mediumImageURLs": [],
      "repositoryId": "sku10008",
      "primarySourceImageURL": null,
      "primarySmallImageURL": null,
      "sourceImageURLs": [],
      "listPrice": 9.99,
      "configurable": false
    },
    {
      "productFamily": null,
      "dynamicPropertyMapLong": {},
      "primaryThumbImageURL": null,
      "bundleLinks": [],
      "largeImage": null,
      "smallImage": null,
      "listVolumePrice": null,
      "nonreturnable": false,
      "displayName": null,
      "salePrices": {"defaultPriceGroup": null},
      "primaryFullImageURL": null,
      "listPrices": {"defaultPriceGroup": 19.99},
      "productListingSku": null,
      "largeImageURLs": [],
      "productLine": null,
      "listVolumePrices": {"defaultPriceGroup": null},
      "primaryLargeImageURL": null,
      "smallImageURLs": [],
      "model": null,
      "thumbnailImage": null,
      "barcode": "200000002022",
      "saleVolumePrices": {"defaultPriceGroup": null},
      "salePriceEndDate": null,
      "saleVolumePrice": null,
      "salePriceStartDate": null,
      "images": [],
      "quantity": null,
      "unitOfMeasure": null,
      "salePrice": null,
      "primaryMediumImageURL": null,
      "fullImageURLs": [],
      "dynamicPropertyMapBigString": {},
      "active": true,
      "thumbImageURLs": [],
      "mediumImageURLs": [],
      "repositoryId": "sku10009",
      "primarySourceImageURL": null,
      "primarySmallImageURL": null,
      "sourceImageURLs": [],
      "listPrice": 19.99,
      "configurable": false
    }
  ]
}