Oracle Commerce Cloud October 2017 - listSkus

Previous Next JavaScript must be enabled to correctly display this content

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

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":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

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