Oracle Commerce Cloud October 2017 - listSkus

Previous Next JavaScript must be enabled to correctly display this content

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

items: Type: array items

items
limit: Type: integer

limit
links: Type: array links

links
offset: Type: integer

offset
sort: Type: array sort

sort
total: Type: integer

total
totalResults: Type: integer

totalResults

Nested Schema : items

Type: array

items

Type: object items

Nested Schema : links

Type: array

links

Type: object items

Nested Schema : sort

Type: array

sort

Type: object items

Nested Schema : items

Type: object

auxiliaryMedia: Type: object auxiliaryMedia

auxiliaryMedia
barcode: Type: string

barcode
catalogs: Type: array catalogs

catalogs
catalogsReplacementProducts: Type: array catalogsReplacementProducts

catalogs replacement products
color: Type: string

color
computedCatalogs: Type: array computedCatalogs

computed catalogs
configurable: Type: boolean

Indicates whether a sku is configurable
creationDate: Type: string

creationDate
derivedCatalogs: Type: array derivedCatalogs

Derived catalogs
description: Type: string

description
discountable: Type: boolean

discountable
displayName: Type: string

displayName
dynamicPropertyMapLong: Type: object dynamicPropertyMapLong

dynamicPropertyMapLong
endDate: Type: string

endDate
fractionalQuantitiesAllowed: Type: boolean

fractionalQuantitiesAllowed
fulfiller: Type: string

fulfiller
fullImageURLs: Type: array fullImageURLs

fullImageURLs
id: Type: string

id
itemAcl: Type: string

item Acl
largeImage: Type: object largeImage

large image
largeImageURLs: Type: array largeImageURLs

largeImageURLs
listPrice: Type: number

listPrice
listPrices: Type: object listPrices

listPrices
manufacturer_part_number: Type: string

manufacturer_part_number
mediumImageURLs: Type: array mediumImageURLs

mediumImageURLs
nonreturnable: Type: boolean

nonreturnable
onlineOnly: Type: boolean

onlineOnly
onSale: Type: boolean

onSale
parentProducts: Type: array parentProducts

array of parent products
primaryFullImageURL: Type: string

primaryFullImageURL
primaryLargeImageURL: Type: string

primaryLargeImageURL
primaryMediumImageURL: Type: string

primaryMediumImageURL
primarySmallImageURL: Type: string

primarySmallImageURL
primarySourceImageURL: Type: string

primarySourceImageURL
primaryThumbImageURL: Type: string

primaryThumbImageURL
productListingSku: Type: string

productListingSku
quantity: Type: integer

quantity
repositoryId: Type: string

repositoryId
salePrice: Type: number

salePrice
salePriceEndDate: Type: string

salePriceEndDate
salePrices: Type: object salePrices

salePrices
salePriceStartDate: Type: string

salePriceStartDate
shippingSurcharge: Type: number

shippingSurcharge
siteIds: Type: string

siteIds
size: Type: string

size
smallImage: Type: object smallImage

Small image
smallImageURLs: Type: array smallImageURLs

smallImageURLs
sourceImageURLs: Type: array sourceImageURLs

sourceImageURLs
startDate: Type: string

startDate
thumbImageURLs: Type: array thumbImageURLs

thumbImageURLs
thumbnailImage: Type: object thumbnailImage

thumbnailImage
translations: Type: object translations

translations
type: Type: string

type
unit_of_measure: Type: string

unit_of_measure
unitOfMeasure: Type: string

unitOfMeasure
variant: Type: array variant

Product Variant Information.
variantOptions: Type: string

variantOptions
version: Type: integer

version
wholesalePrice: Type: number

wholesalePrice

Nested Schema : auxiliaryMedia

Type: object

auxiliaryMedia

Nested Schema : catalogs

Type: array

catalogs

Type: object items

Nested Schema : catalogsReplacementProducts

Type: array

catalogs replacement products

Type: object items

Nested Schema : computedCatalogs

Type: array

computed catalogs

Type: object items

Nested Schema : derivedCatalogs

Type: array

Derived catalogs

Type: object items

Nested Schema : dynamicPropertyMapLong

Type: object

dynamicPropertyMapLong

sku-WomensApparel_color: Type: integer

sku-WomensApparel_color
sku-WomensApparel_size: Type: integer

sku-WomensApparel_size

Nested Schema : fullImageURLs

Type: array

fullImageURLs

Type: string

Nested Schema : largeImage

Type: object

large image

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : largeImageURLs

Type: array

largeImageURLs

Type: string

Nested Schema : listPrices

Type: object

listPrices

defaultPriceGroup: Type: number

defaultPriceGroup

Nested Schema : mediumImageURLs

Type: array

mediumImageURLs

Type: string

Nested Schema : parentProducts

Type: array

array of parent products

Type: object items

Nested Schema : salePrices

Type: object

salePrices

defaultPriceGroup: Type: string

defaultPriceGroup

Nested Schema : smallImage

Type: object

Small image

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : smallImageURLs

Type: array

smallImageURLs

Type: string

Nested Schema : sourceImageURLs

Type: array

sourceImageURLs

Type: string

Nested Schema : thumbImageURLs

Type: array

thumbImageURLs

Type: string

Nested Schema : thumbnailImage

Type: object

thumbnailImage

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : translations

Type: object

translations

1: Type: object 1

1
27: Type: object 27

27

Nested Schema : variant

Type: array

Product Variant Information.

Type: object items

Nested Schema : items

Type: object

repositoryId: Type: string

repository Id

Nested Schema : items

Type: object

repositoryId: Type: string

repository Id

Nested Schema : items

Type: object

repositoryId: Type: string

repository Id

Nested Schema : items

Type: object

repositoryId: Type: string

repository Id

Nested Schema : items

Type: object

active: Type: boolean

active
avgCustRating: Type: string

avgCustRating
childSKUs: Type: array childSKUs

childSKUs
description: Type: string

description
displayName: Type: string

displayName
fullImageURLs: Type: array fullImageURLs

fullImageURLs
id: Type: string

id
largeImage: Type: object largeImage

large image
largeImageURLs: Type: array largeImageURLs

largeImageURLs
listPrice: Type: number

listPrice
longDescription: Type: string

longDescription
mediumImageURLs: Type: array mediumImageURLs

mediumImageURLs
orderLimit: Type: integer

orderLimit
primaryFullImageURL: Type: string

primaryFullImageURL
primaryLargeImageURL: Type: string

primaryLargeImageURL
primaryMediumImageURL: Type: string

primaryMediumImageURL
primarySmallImageURL: Type: string

primarySmallImageURL
primarySourceImageURL: Type: string

primarySourceImageURL
primaryThumbImageURL: Type: string

primaryThumbImageURL
productImages: Type: array productImages

productImages
repositoryId: Type: string

repositoryId
route: Type: string

route
salePrice: Type: number

salePrice
shippingSurcharge: Type: number

shippingSurcharge
smallImage: Type: object smallImage

Small image
smallImageURLs: Type: array smallImageURLs

smallImageURLs
sourceImageURLs: Type: array sourceImageURLs

sourceImageURLs
thumbImageURLs: Type: array thumbImageURLs

thumbImageURLs

Nested Schema : childSKUs

Type: array

childSKUs

Type: object items

Nested Schema : fullImageURLs

Type: array

fullImageURLs

Type: string

Nested Schema : largeImage

Type: object

large image

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : largeImageURLs

Type: array

largeImageURLs

Type: string

Nested Schema : mediumImageURLs

Type: array

mediumImageURLs

Type: string

Nested Schema : productImages

Type: array

productImages

Type: object items

Nested Schema : smallImage

Type: object

Small image

repositoryId: Type: string

repository Id
url: Type: string

URL

Nested Schema : smallImageURLs

Type: array

smallImageURLs

Type: string

Nested Schema : sourceImageURLs

Type: array

sourceImageURLs

Type: string

Nested Schema : thumbImageURLs

Type: array

thumbImageURLs

Type: string

Nested Schema : items

Type: object

repositoryId: Type: string

repositoryId

Nested Schema : items

Type: object

repositoryId: Type: string

repositoryId

Nested Schema : 1

Type: object

1

repositoryId: Type: string

repositoryId

Nested Schema : 27

Type: object

27

repositoryId: Type: string

repositoryId

Nested Schema : items

Type: object

optionName: Type: string

Name of the Dynamic attribute.
optionValue: Type: string

Value of the Dynamic attribute.

Nested Schema : items

Type: object

href: Type: string

href
rel: Type: string

rel

Nested Schema : items

Type: object

order: Type: string

order
property: Type: string

property

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,
            "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,
            "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,
            "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,
            "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
        }
    ],
    "___etag___":"eyJ2ZXJzaW9uIjoxLCJ1cmkiOiJza3VzIiwiaGFzaCI6Imk2VFFPUT09In0="
}

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

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

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

Type: object items

Nested Schema : items

Type: object

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:

{
  "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,
      "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,
      "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,
      "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,
      "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
    }
  ],
  "___etag___": "eyJ2ZXJzaW9uIjoxLCJ1cmkiOiJza3VzIiwiaGFzaCI6Imk2VFFPUT09In0="
}