description: The localized description of the category.
property
id: The ID of the category.
Min Length: 1
Max Length: 256
property
image: The URL of the category image.
property
name: The localized name of the category.
property
onlineSubCategoriesCount: The total number of online sub-categories. This information will be available from B2C Commerce version 24.5.
property
pageDescription: The localized page description of the category.
property
pageKeywords: The localized page keywords of the category.
property
pageTitle: The localized page title of the category.
property
parentCategoryId: The ID of the parent category.
property
parentCategoryTree: The List of the parent categories.
property
thumbnail: The URL of the category thumbnail.
CategoryResult
CategoryResult:{ data: Array<Category>; limit: number; total: number } & {}
property
data: The array of category documents.
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization
Max Length: 256
property
type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.
Max Length: 2048
property
detail: A human-readable explanation specific to this occurrence of the problem.
property
instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.
ats: The Available To Sell (ATS) of the product. If it is infinity, the return value is 999999. The value can be overwritten by the OCAPI setting 'product.inventory.ats.max_threshold'.
property
backorderable: A flag indicating whether the product is backorderable.
property
id: The inventory ID.
Min Length: 1
Max Length: 256
property
inStockDate: A flag indicating the date when the product will be in stock.
property
orderable: A flag indicating whether at least one of the products is available to sell.
property
preorderable: A flag indicating whether the product is preorderable.
property
stockLevel: The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the OCAPI setting 'product.inventory.stock_level.max_threshold'.
Levels
Levels:0 | 1 | 2
Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
orderable: A flag indicating whether at least one of the variants can be ordered.
property
price: The minimum sales price of the related variants.
property
priceMax: The maximum sales price of the related variants.
property
prices: List of sale prices.
NoValue
NoValue:"N/A"
A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
maxPrice: Maximum price for the given pricebook (usually for a master Product would be the price for the Variant which has the highest price out of all Variants in that pricebook)
property
minPrice: Minimum price for the given pricebook (usually for a master Product would be the price for the Variant which has the least price out of all Variants in that pricebook)
property
pricebook: The active pricebook from which the min and the max prices are calculated. The pricebook is based on the site context of the request as defined in ECOM.
bundledProducts: The array of all bundled products of this product.
property
currency:
property
ean: The European Article Number of the product.
property
fetchDate:
property
id: The id (SKU) of the product.
Min Length: 1
Max Length: 100
property
imageGroups: The array of product image groups.
property
inventories: The array of product inventories explicitly requested via the 'inventory_ids' query parameter. This property is only returned in context of the 'availability' expansion.
property
inventory: The site default inventory information. This property is only returned in context of the 'availability' expansion.
property
longDescription: The localized product's long description.
property
manufacturerName: The product's manufacturer name.
property
manufacturerSku: The product's manufacturer SKU.
property
master: The master product information, only for types: master, variation group, and variant.
property
minOrderQuantity: The minimum order quantity for this product.
property
name: The localized product name.
property
options: The array of product options, only for type option. This array can be empty.
property
pageDescription: The localized product's page description.
property
pageKeywords: The localized product's page description.
property
pageTitle: The localized product's page title.
property
pageMetaTags: Page Meta tags associated with the given product.
property
price: The sales price of the product. In case of complex products, like master or set, this is the minimum price of related child products.
property
pricePerUnit: The price per unit if defined for the product
property
pricePerUnitMax: The max price per unit typically for a master product's variant.
property
priceMax: The maximum sales of related child products in complex products like master or set.
property
priceRanges: Array of one or more price range objects representing one or more Pricebooks in context for the site.
property
prices: The prices map with pricebook IDs and their values.
property
primaryCategoryId: The ID of the products primary category.
property
productLinks: The array of source and target product links information.
property
productPromotions: An array of active customer product promotions for this product, sorted by promotion priority using SORT_BY_EXCLUSIVITY ordering (exclusivity → rank → promotion class → discount type → best discount → ID). This array can be empty. Coupon promotions are not returned in this array. See PromotionPlan.SORT_BY_EXCLUSIVITY for more details.
property
recommendations: Returns a list of recommendations.
property
setProducts: The array of set products of this product.
property
shortDescription: The localized product short description.
property
slugUrl: The complete link to this product's storefront page.
property
stepQuantity: The steps in which the order amount of the product can be increased.
property
tieredPrices: The document represents list of tiered prices if the product is a variant
property
type: The product type information. Can be one or more of the following values: item, master, variation_group, variant, bundle, and set.
property
unit: The sales unit of the product.
property
upc: The Universal Product Code (UPC).
property
validFrom: The time a product is valid from.
property
validTo: The time a product is valid to.
property
variants: The array of actual variants. Only for master, variation group, and variant types. This array can be empty.
property
variationAttributes: Sorted array of variation attributes information. Only for master, variation group, and variant types. This array can be empty.
property
variationGroups: The array of actual variation groups. Only for master, variation group, and variant types. This array can be empty.
property
variationValues: The actual variation attribute ID - value pairs. Only for variant and variation group types.
calloutMsg: The localized callout message of the recommendation.
property
image:
property
longDescription: The localized long description of the recommendation.
property
name: The localized name of the recommendation.
property
recommendationType:
property
recommendedItemId: The recommended item ID of the recommendation.
property
shortDescription: The localized short description of the recommendation.
RecommendationType
RecommendationType:{ displayValue: string; value: number } & {}
property
displayValue: The localized display value of the recommendation type.
property
value: The value of the recommendation type.
ResultBase
ResultBase:{ limit: number; total: number } & {}
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
id:
product: The product being bundled.
quantity: For the product being bundled, the quantity added to the bundle.