1. REST API for Oracle Commerce Cloud
  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, filtered by 'q' parameter. 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
Query Parameters
  • ID of the catalog.
  • Boolean indicating whether to return a larger set of SKU properties. Default value is false.
  • Boolean flag to determine whether to include price maps for the skus in the response. Default value is true.
  • Type of sku list associated with the given promotion id -includedSkus or excludedSkus
  • Partial displayName or id of a SKU to use for search.
  • Return response with paginated pattern, to be used with query param skuIds or promotion group {promotionId, itemTypeList, templateValue}. Default value is false.
  • Price list group id for adding the prices to the SKU in the response.
  • The promotion id for the included/excluded SKUs list. If promotionId is included then include the itemTypeList and templateValue parameters to get the include/exclude sku list for the promotion
  • Contains SCIM query language
  • Boolean flag to determine whether to include inactive SKUs as part of the result. Default value is true.
  • Boolean flag to determine whether to include SKU bundles as part of the result. Default value is true.
  • Boolean indicating if the translations property should be returned for each item in the response. Default value is false.
  • SKU IDs to list.
  • UI Template value associated with the included/excluded SKUs list - e.g PSC_Value, optional_offer_psc_value etc
  • Boolean flag to determine whether prices will be returned or not; not returning prices will skip performing any price lookup for the SKUs. Default is true. Setting this to false will supersede 'includePrices'.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listSkus_response
Type: object
Show Source
Nested Schema : deletedSkus
Type: array
Contains the list of invalid skus when the state query parameter is true
Show Source
Nested Schema : items
Type: array
The data for the sku.
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : configurationMetadata
Type: array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : fullImageURLs
Type: array
The array of full image URLs
Show Source
Nested Schema : images
Type: array
Image URLs of SKU.
Show Source
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Show Source
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Show Source
Nested Schema : listVolumePrices
Type: object
list volume prices of the product in respective price list groups
Show Source
Nested Schema : mediumImageURLs
Type: array
medium image urls path
Show Source
Nested Schema : parentProducts
Type: array
The list of parent products for the SKU.
Show Source
Nested Schema : productListingSku
Type: object
product listing SKU property of the SKU
Nested Schema : productVariantOptions
Type: array
The selected options for the SKU.
Show Source
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Show Source
Nested Schema : saleVolumePrices
Type: object
Sale volume prices of the product in respective price list groups
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Show Source
  • Extra handling costs for shipping the product in plg1
  • Extra handling costs for shipping the product in plg2
Nested Schema : smallImage
Type: array
The array of small image URLs
Show Source
Nested Schema : smallImageURLs
Type: array
small image url paths
Show Source
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU
Show Source
Nested Schema : variantValuesOrder
Type: object
Object having various variant property as key and ordered values array as the value.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : defaultProductListingSku
Type: object
default SKU for the product
Nested Schema : fullImageURLs
Type: array
full image url paths
Show Source
Nested Schema : largeImageURLs
Type: array
The array of large image URLs
Show Source
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Show Source
Nested Schema : listVolumePrices
Type: object
list volume prices of the product in respective price list groups
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Show Source
Nested Schema : saleVolumePrices
Type: object
Sale volume prices of the product in respective price list groups
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Show Source
  • Extra handling costs for shipping the product in plg1
  • Extra handling costs for shipping the product in plg2
Nested Schema : smallImageURLs
Type: array
The urls of the small image.
Show Source
Nested Schema : sourceImageURLs
Type: array
source image urls of the product
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of product
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (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":[
        {
            "dynamicPropertyMapLong":{
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "listPrices":{
                "defaultPriceGroup":199.99
            },
            "configurationMetadata":[
            ],
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "derivedSalePriceFrom":"UsDollar",
            "model":null,
            "barcode":"200000001995",
            "salePriceEndDate":null,
            "images":[
            ],
            "unitOfMeasure":null,
            "primaryMediumImageURL":null,
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "productFamily":null,
            "primaryThumbImageURL":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "productListingSku":null,
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "derivedShippingSurchargeFrom":"UsDollar",
            "shippingSurcharges":{
                "defaultPriceGroup":null
            },
            "thumbnailImage":null,
            "discountable":true,
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "quantity":null,
            "salePrice":null,
            "fullImageURLs":[
            ],
            "soldAsPackage":false,
            "repositoryId":"sku10005",
            "derivedListPriceFrom":"UsDollar",
            "shippingSurcharge":null,
            "partNumber":null,
            "listPrice":199.99,
            "configurable":false
        },
        {
            "dynamicPropertyMapLong":{
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "listPrices":{
                "defaultPriceGroup":199.99
            },
            "configurationMetadata":[
            ],
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "derivedSalePriceFrom":"UsDollar",
            "model":null,
            "barcode":"200000002008",
            "salePriceEndDate":null,
            "images":[
            ],
            "unitOfMeasure":null,
            "primaryMediumImageURL":null,
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "productFamily":null,
            "primaryThumbImageURL":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "productListingSku":null,
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "derivedShippingSurchargeFrom":"UsDollar",
            "shippingSurcharges":{
                "defaultPriceGroup":null
            },
            "thumbnailImage":null,
            "discountable":true,
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "quantity":null,
            "salePrice":null,
            "fullImageURLs":[
            ],
            "soldAsPackage":false,
            "repositoryId":"sku10007",
            "derivedListPriceFrom":"UsDollar",
            "shippingSurcharge":null,
            "partNumber":null,
            "listPrice":199.99,
            "configurable":false
        },
        {
            "dynamicPropertyMapLong":{
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "listPrices":{
                "defaultPriceGroup":9.99
            },
            "configurationMetadata":[
            ],
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "derivedSalePriceFrom":"UsDollar",
            "model":null,
            "barcode":"200000002015",
            "salePriceEndDate":null,
            "images":[
            ],
            "unitOfMeasure":null,
            "primaryMediumImageURL":null,
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "productFamily":null,
            "primaryThumbImageURL":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "productListingSku":null,
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "derivedShippingSurchargeFrom":"UsDollar",
            "shippingSurcharges":{
                "defaultPriceGroup":null
            },
            "thumbnailImage":null,
            "discountable":true,
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "quantity":null,
            "salePrice":null,
            "fullImageURLs":[
            ],
            "soldAsPackage":false,
            "repositoryId":"sku10008",
            "derivedListPriceFrom":"UsDollar",
            "shippingSurcharge":null,
            "partNumber":null,
            "listPrice":9.99,
            "configurable":false
        },
        {
            "dynamicPropertyMapLong":{
            },
            "bundleLinks":[
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "listPrices":{
                "defaultPriceGroup":19.99
            },
            "configurationMetadata":[
            ],
            "largeImageURLs":[
            ],
            "productLine":null,
            "listVolumePrices":{
                "defaultPriceGroup":null
            },
            "derivedSalePriceFrom":"UsDollar",
            "model":null,
            "barcode":"200000002022",
            "salePriceEndDate":null,
            "images":[
            ],
            "unitOfMeasure":null,
            "primaryMediumImageURL":null,
            "dynamicPropertyMapBigString":{
            },
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "productFamily":null,
            "primaryThumbImageURL":null,
            "nonreturnable":false,
            "displayName":null,
            "salePrices":{
                "defaultPriceGroup":null
            },
            "primaryFullImageURL":null,
            "productListingSku":null,
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "derivedShippingSurchargeFrom":"UsDollar",
            "shippingSurcharges":{
                "defaultPriceGroup":null
            },
            "thumbnailImage":null,
            "discountable":true,
            "saleVolumePrices":{
                "defaultPriceGroup":null
            },
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "quantity":null,
            "salePrice":null,
            "fullImageURLs":[
            ],
            "soldAsPackage":false,
            "repositoryId":"sku10009",
            "derivedListPriceFrom":"UsDollar",
            "shippingSurcharge":null,
            "partNumber":null,
            "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
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top