Oracle Commerce Cloud October 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: array items

Array having various products.
limit: Type: integer

Limit of number of products.
offset: Type: integer

Offset of product inventory.
sort: Type: array sort

Array having the order and property of product.
total: Type: integer

Total number of products. Deprecated.
totalResults: Type: integer

Total number of products.

Nested Schema : items

Type: array

Array having various products.

Request

Response

Example application/json

Examples