Module products

filters: A list of filters that are logically combined by an operator.

operator: The logical operator that is used to combine the filters.

must: List of queries to be evaluated as an AND operator.

mustNot: List of queries to be evaluated as a NOT operator.

should: List of queries to be evaluated as an OR operator.

catalogId: The ID of the catalog.

• Min Length: 1
• Max Length: 256

categoryId: The ID of the category.

• Min Length: 1
• Max Length: 256

id: The ID of the supported attribute.

• Max Length: 256

attributeName: The display name of the supported attribute.

• Max Length: 4000

attributeType: The type of the attribute (custom/system/categorization). "system" indicates the System Attribute of the Product in ECOM, "custom" indicates the Custom Attribute of the Product in ECOM defined by merchant and "categorization" indicates the attribute used for categorization purposes ONLY and is not a defined attribute on the Product Object.

valueType: The value type of the attribute.

allowedOperators: The list of allowed operators for this attribute based on its value type.

allowedValues: The list of allowed values for this attribute IF its attributeType is an ENUM.

allowedDisplayValues: The list of allowed Localized Display values for this attribute IF its attributeType is an ENUM based on the locale query param requested. If no locale query param value is provided "default" locale is assumed.

data: The list of the categorization attribute definitions. This can be empty.

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).

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

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

detail: A human-readable explanation specific to this occurrence of the problem.

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.

• Max Length: 2048

boolFilter:

queryFilter:

range2Filter:

rangeFilter:

termFilter:

filter:

query:

images: The images of the image group.

variationAttributes: Returns a list of variation attributes applying to this image group.

viewType: The image view type.

markup: The rendered HTML.

source: The raw markup text.

masterId: The id (SKU) of the product.

• Min Length: 1
• Max Length: 100

orderable: A flag indicating whether at least one of the variants is orderable.

price: The minimum sales price of the related variants.

priceMax: The maximum sales of related variants.

prices: prices

absUrl: The absolute URL with request protocol.

alt: The alternative image text.

disBaseUrl: The Dynamic Image Service (DIS) base URL for product images only.

path: The raw media file path.

title: The image title.

currencyMnemonic:

value: The amount of money for the given currency.

path: The path to the nested document.

• Max Length: 2048

query:

scoreMode: Indicates how scores for matching child objects affect the root parent document’s relevance score.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

query:

sorts: The sorting that was applied to the result.

hits: The sorted array of search hits. Can be empty.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

assignedCategories: The catalog categories that the product is assigned to. It is read only.

ats: The Available To Sell (ATS) inventory value of the product. This is a calculated value.

brand: The brand of the product.

bundledProducts: The array of bundled products which the product includes. It is read only.

classificationCategory:

creationDate: Returns the value of attribute 'creationDate'. It is read only.

defaultVariantId: The ID of the product's default variant. It is read only.

ean: The European Article Number of the product.

id: The id (SKU) of the product.

• Min Length: 1
• Max Length: 100

image:

imageGroups: The array of product image groups. It is read only.

inStock: The flag that indicates if the product is in stock, or not. This is a calculated value.

lastModified: Returns the value of attribute 'lastModified'. It is read only.

localizedTaxClassId: The localized tax class identifier of the product.

longDescription: The localized long description of the product.

manufacturerName: The name of the product's manufacturer.

manufacturerSku: The SKU of the product's manufacturer.

master:

name: The localized name of the product.

online: The flag that indicates if the product is online, or not. This is a calculated value.

onlineFlag: The site-specific online status of the product.

owningCatalogId: The ID of the catalog that owns the product.

owningCatalogName: The localized name of the catalog that owns the product. It is read only.

pageDescription: The localized page description of the product.

pageKeywords: The localized page keywords of the product.

pageTitle: The localized page title of the product.

price: The price of the product.

priceCurrency: The currency code for a product's price.

pricePerUnit: The price per unit of the product. This is a read only field.

primaryCategories: The primary catalog categories that the product is assigned to. It is read only.

primaryCategoryId: The ID of the products primary category. This is a read only field. It is read only.

productBundles: The array of product bundles which the product belongs to. It is read only.

productOptions: The array of product options. This is applicable for products of type "option". It is read only.

productSets: The array of product sets which the product belongs to. It is read only.

searchable: The site-specific searchable status of the product.

setProducts: The array of set products which the product includes. It is read only.

shortDescription: The localized short description of the product.

taxClassId: The tax class identifier of the product.

type:

unit: The sales unit of the product.

unitMeasure: The unitMeasure of the product.

unitQuantity: The unitQuantity of the product.

upc: The Universal Product Code (UPC) of the product.

validFrom: The valid/online from date of the product.

validTo: The valid/online to date of the product.

variants: The array of variants of the product. This is applicable for product types "master" and "variationGroup" only. It is read only.

variationAttributes: The sorted array of variation attributes assigned to the product. This is applicable for product types "master", "variationGroup" and "variant" only. It is read only.

variationGroups: The array of variation groups in the product. This is applicable for product type "master" only. It is read only.

variationValues: The variation values selected for the product in variation attribute id and value pairs. This is applicable for product types "Variant" and "VariationGroup" only. It is read only.

customName: The localized custom name of the product option.

defaultProductOptionValue: The default product option value.

description: The localized description of the product option.

id: The object attribute definition ID which is also the identifier for the product option.

• Min Length: 1

image:

name: The name of the object attribute definition.

selectedOptionValue: The selected option value of the product option.

shared: The flag that indicates if the product option is shared or local.

sortingMode: The sorting mode for the product option values.

values: The sorted array of values of the product option.

defaultProductOptionValue: Flag indicating if the product option value is the default value for the product option.

id: The ID of the product option value.

• Min Length: 1

optionPrices: The list of prices in the product option value.

skuExtension: The SKU extension of the product option value.

value: The localized value of the product option.

data: The array of product option objects.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

limit: Maximum records to retrieve per request, not to exceed 200.

query:

sorts: The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.

offset: The zero-based index of the first hit/data to include in the result.

hits: A sorted array of search hits (Product objects). The array can be empty.

query:

sorts: The sorting that was applied to the result.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

bundle: A flag indicating whether the product is a bundle.

bundled: A flag indicating whether the product is bundled.

item: A flag indicating whether the product is a standard item.

master: A flag indicating whether the product is a master.

option: A flag indicating whether the product is an option.

partOfProductSet: A flag indicating whether the product is part of product set.

partOfRetailSet: A flag indicating whether the product is part of retail set.

retailSet: A flag indicating whether the product is a retail set.

set: A flag indicating whether the product is a set.

variant: A flag indicating whether the product is a variant.

variationGroup: A flag indicating whether the product is a variation group.

boolQuery:

filteredQuery:

matchAllQuery: Matches all documents (namespace and document type). This query comes in handy if you just want to filter a search result or really do not have any constraints.

nestedQuery:

termQuery:

textQuery:

query:

filterMode: Compare mode: overlap, containing, or contained.

fromField: The field name of the field that starts the first range.

• Max Length: 260

fromInclusive: A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to false.

fromValue: The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.

toField: The field name of the field that ends the first range.

• Max Length: 260

toInclusive: A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to false.

toValue: The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.

field: The search field.

• Max Length: 260

from:

fromInclusive: A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to false.

to:

toInclusive: A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to false.

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).

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.

limit: Maximum records to retrieve per request, not to exceed 200.

query:

sorts: The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.

offset: The zero-based index of the first hit/data to include in the result.

field: The name of the field to sort on.

• Max Length: 256

sortOrder: The sort order to be applied when sorting. When omitted, the default sort order (asc) is used.

field: The filter field.

• Max Length: 260

operator: The operator used to compare the field's values with the given values.

values: The filter values.

fields: The document fields that the values are matched against, combined with the operator.

operator: Returns the operator to use for the term query.

values: The values that the fields are compared against, combined with the operator.

fields: The document fields that the search phrase matches against.

searchPhrase: A search phrase, which can include multiple terms separated by spaces.

ats: The Available To Sell (ATS) inventory value of the product. This is a calculated value.

defaultProductVariation: A flag indicating whether the variant is a default variant.

image:

inStock: True if the product is in stock, false if not.

online: If the product is currently online. True if online, false if not.

orderable: A flag indicating whether the variant is orderable.

price: The sales price of the variant.

priceCurrency: Currency code for the price of the product.

productId: The id (SKU) of the product.

• Min Length: 1
• Max Length: 100

searchable: A flag indicating whether the variant is searchable.

variationAttributes: Variation attributes.

variationValues: The actual variation attribute ID - value pairs.

limit: Maximum records to retrieve per request, not to exceed 200.

query:

sorts: The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.

offset: The zero-based index of the first hit/data to include in the result.

hits: An array of search hits (Variant objects).

query:

sorts: The sorting that was applied to the result.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

data: An array of variants.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

attributeDefinitionId: The id of the requested attribute definition.

attributeDefinitionName: The localized display name of the variation attribute definition.

defaultValue: Default variation attribute value.

id: The ID of the variation attribute.

• Min Length: 1

name: The localized display name of the variation attribute.

shared: Returns the value of attribute 'shared' if attribute is local or shared.

slicing: Returns the value of attribute 'slicing'.

values: The sorted array of variation values. This array can be empty.

variationAttributeType: Variation attribute type.

description: The localized description of the variation value.

image:

imageSwatch:

name: The localized display name of the variation value.

orderable: A flag indicating whether at least one variant with this variation attribute value is available to sell.

position: The position of the value among all values of a variation attribute.

value: The actual variation value.

• Min Length: 1

data: The array of variation attribute objects.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.

orderable: A flag indicating whether the variation group is orderable.

price: The sales price of the variation group.

productId: The ID (SKU) of the variation group.

• Min Length: 1
• Max Length: 100

variationValues: The actual variation attribute ID - value pairs.

data: The array of variation group objects.

offset: The zero-based index of the first hit/data to include in the result.

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).

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.