REST API for Oracle Commerce Cloud December 2017

listProducts

get

/ccadmin/v1/products

List Products. Gets a list of products. Optionally search for products in the given catalog and collection 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 included/excluded Products in a promotion, use a group of {promotionId, itemTypeList and templateValue} parameters together.

Request

Supported Media Types

application/json

Query Parameters

catalogId: Type: string

ID of the catalog.
categoryId: Type: string

Restrict the response to just products in the given category id.
continueOnMissingProduct: Type: boolean

boolean flag to determine whether to continue if a product is missing.
expand: Type: boolean

Boolean indicating if the expanded product information should be returned.
includePrices: Type: boolean

Boolean flag to determine whether to include price maps for the products in the response.
itemTypeList: Type: string

Type of product list to be fetched from the given promotion id -includedProducts or excludedProducts
limit: Type: string

This is the field to determine number of records to be fetched per REST call.
minimalList: Type: boolean

Returns a minimal set of properties. Adds two properties, onSale and priceRange, so that those two values do not need to be computed by the client. This can be combined with any other query parameters that do not depend on properties not returned. This cannot be combined with 'expand' as they are mutually exclusive.
name: Type: string

Partial displayName of a product to use for search.
offset: Type: string

This field determines the offset/starting index from which data to be fetched.
pageResults: Type: boolean

Return response with paginated pattern, to be used with query params - name/productIds/promotion group {promotionId, itemTypeList, templateValue}
priceListGroupId: Type: string

Price list group id for adding the prices to the product in the response.
productIds: Type: string

Product IDs to list.
promotionId: Type: string

Promotion id to fetch the included/excluded product list from. if promotionId is included then include the itemTypeList and templateValue parameters to get the include/exclude product list for the promotion
q: Type: string

A SCIM filter string for selecting a subset of all products. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Examples: Get all products whose displayName contains shirt: q=displayName co "shirt" Get all products with an orderLimit between 5 and 10: q=orderLimit gt 5 and orderLimit lt 10 Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted. The following base product properties can be used in a q query: * avgCustRating * brand * childSKUs * description * displayName * id * largeImage * longDescription * notForIndividualSale * orderLimit * productImages * smallImage Additionally, custom product properties may also be used in a q query.
showInactiveProducts: Type: boolean

Boolean flag to determine whether to include inactive products as part of the result.
showQuantity: Type: string

Show inventory quantity.
showTranslations: Type: boolean

Boolean indicating if the translations property should be returned for each item in the response.
templateValue: Type: string

UI Template value to fetch the included/excluded product list from - e.g PSC_Value, optional_offer_psc_value etc
unassigned: Type: string

Restrict response to unassigned products (ignore categoryId).

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request
X-CCProfileType: Type: string

Profile type of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listProducts_response

Properties

items: Type: object items

Additional Properties Allowed:

Images and urls of the product. Image Urls are not encoded.
limit: Type: integer

the total number of products that can be returned
sort: Type: object sort

Additional Properties Allowed:

Sorting criteria of the products.
total: Type: integer

The total number of products returned. Deprecated.
totalExpandedResults: Type: integer

The total number of expanded products is returned only if value for category Id is set in the request.
totalResults: Type: integer

The total number of products returned.

Nested Schema : items

Type: object

Images and urls of the product. Image Urls are not encoded.

Properties

active: Type: boolean

The active property of the product
avgCustRating: Type: string

the average customer rating of the product
childSKUs: Type: array childSKUs

Additional Properties Allowed:

List of SKU's for the product.
creationDate: Type: string

product creation date
description: Type: string

The product description
displayName: Type: string

The display name of the product
fullImageURLs: Type: array fullImageURLs

Additional Properties Allowed:

The array of full image URLs. Urls are not encoded.
id: Type: string

The product ID
largeImage: Type: string

the large image of the product. Url is not encoded.
largeImageURLs: Type: array largeImageURLs

Additional Properties Allowed:

The array of large image URLs. Urls are not encoded.
listPrice: Type: number

The list price
listPrices: Type: object listPrices

Additional Properties Allowed:

list prices of the SKU in respective price list groups
longDescription: Type: string

The long description of the product
mediumImageURLs: Type: array mediumImageURLs

Additional Properties Allowed:

The url of the medium image. Url is not encoded.
nonreturnable: Type: boolean

Indicates whether the product is returnable or not.
notForIndividualSale: Type: boolean

States whether not a product may be sold individually rather than, for example, as part of a configured product
orderLimit: Type: string

the order limit of the product
primaryFullImageURL: Type: string

The url of the primary full image. Url is not encoded.
primaryLargeImageURLs: Type: string

The url of the primary large image. Url is not encoded.
primaryMediumImageURL: Type: string

The primary medium image URL of the product. Url is not encoded.
primarySmallImageURL: Type: string

The primary small image URL of the product. Url is not encoded.
primarySourceImageURL: Type: string

the primary source image of the url.Url is not encoded.
primaryThumbImageURL: Type: string

the primary source image of the url. Url is not encoded.
productVariantOptions: Type: array productVariantOptions

Additional Properties Allowed:

Objects containing product's variant options details if available for the product.
repositoryId: Type: string

The repository ID of the product
route: Type: string

The route property of the product
salePrice: Type: number

The sale price of the product
salePrices: Type: object salePrices

Additional Properties Allowed:

sale prices of the product in respective price list groups
shippingSurcharge: Type: number

Extra handling cost for shipping the product.
shippingSurcharges: Type: object shippingSurcharges

Additional Properties Allowed:

Extra handling costs for shipping the product in respective price list groups
smallImage: Type: array smallImage

Additional Properties Allowed:

The array of small image URLs. Urls are not encoded.
smallImageURLs: Type: array smallImageURLs

Additional Properties Allowed:

The urls of the small image.Urls are not encoded.
sourceImageURLs: Type: array sourceImageURLs

Additional Properties Allowed:

The array of source image URLs. Urls are not encoded.
thumbImageURLs: Type: array thumbImageURLs

Additional Properties Allowed:

The array of thumbnail image URLs. Urls are not encoded.
variantValuesOrder: Type: object variantValuesOrder

Additional Properties Allowed:

Object having various variant property as key and ordered values array as the value.

Nested Schema : sort

Type: object

Sorting criteria of the products.

Properties

order: Type: string

The order in which the products should be listed(asc/desc).
property: Type: string

The property on which to do the ordering of products.

Nested Schema : childSKUs

Type: array

List of SKU's for the product.

Request

Response

Example application/json

Examples