limit: Maximum records to retrieve per request, not to exceed 200.
property
query:
property
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.
property
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 200.
property
query:
property
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.
property
offset: The zero-based index of the first hit/data to include in the result.
hits: The sorted array of catalog search hits. Can be empty.
property
query:
property
sorts: The sorting that was applied to the result.
property
offset: The zero-based index of the first hit/data to include in the result.
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.
offset: The zero-based index of the first hit/data to include in the result.
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.
offset: The zero-based index of the first hit/data to include in the result.
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.
limit: Maximum records to retrieve per request, not to exceed 200.
property
query:
property
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.
property
offset: The zero-based index of the first hit/data to include in the result.
hits: The sorted array of search hits. This array can be empty.
property
query:
property
sorts: The sorting that was applied to the result.
property
offset: The zero-based index of the first hit/data to include in the result.
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.
limit: Maximum records to retrieve per request, not to exceed 200.
property
query:
property
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.
property
offset: The zero-based index of the first hit/data to include in the result.
hits: The sorted array of search hits. Can be empty.
property
query:
property
sorts: The sorting that was applied to the result.
property
offset: The zero-based index of the first hit/data to include in the result.
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.
ConditionsResult:{ conditions?: Array<Condition>; 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
conditions: The list of conditions for a rule. This can be empty.
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.
ExcludedProductsResult:{ data?: Array<ExcludedProduct>; 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
data: The list of the excluded products. This can be empty.
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.
assignedCount: Indicates total number of products assigned by the execution job.
property
unassignedCount: Indicates total number of products unassigned by the execution job.
property
matchedCount: Indicates total number of products evaluated and matched by the evaluation job.
property
jobStatus: Indicates the status of the rules execution job (that is, indicates whether the job completed successfully or an error occurred).
property
message: A description of any errors, failures, and exceptions that caused the job to fail.
property
lastRunDate: The date that the rules categorization job was last run for given catalog and category.
Max Length: 30
property
productIds: The list of matched product IDs returned by the execution job.
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
offset: The zero-based index of the first hit/data to include in the result.
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.
PaginatedResultBase
PaginatedResultBase:{ limit: number; offset: number; total: number } & {}
property
offset: The zero-based index of the first hit/data to include in the result.
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.
sorts: The sorting that was applied to the result.
property
hits: The sorted array of search hits. Can be empty.
property
offset: The zero-based index of the first hit/data to include in the result.
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.
assignedCategories: The catalog categories that the product is assigned to. It is read only.
property
ats: The Available To Sell (ATS) inventory value of the product. This is a calculated value.
property
brand: The brand of the product.
property
bundledProducts: The array of bundled products which the product includes. It is read only.
property
classificationCategory:
property
creationDate: Returns the value of attribute 'creationDate'. It is read only.
property
defaultVariantId: The ID of the product's default variant. It is read only.
property
ean: The European Article Number of the product.
property
id: The id (SKU) of the product.
Min Length: 1
Max Length: 100
property
image:
property
imageGroups: The array of product image groups. It is read only.
property
inStock: The flag that indicates if the product is in stock, or not. This is a calculated value.
property
lastModified: Returns the value of attribute 'lastModified'. It is read only.
property
localizedTaxClassId: The localized tax class identifier of the product.
property
longDescription: The localized long description of the product.
property
manufacturerName: The name of the product's manufacturer.
property
manufacturerSku: The SKU of the product's manufacturer.
property
master:
property
name: The localized name of the product.
property
online: The flag that indicates if the product is online, or not. This is a calculated value.
property
onlineFlag: The site-specific online status of the product.
property
owningCatalogId: The ID of the catalog that owns the product.
property
owningCatalogName: The localized name of the catalog that owns the product. It is read only.
property
pageDescription: The localized page description of the product.
property
pageKeywords: The localized page keywords of the product.
property
pageTitle: The localized page title of the product.
property
price: The price of the product.
property
priceCurrency: The currency code for a product's price.
property
pricePerUnit: The price per unit of the product. This is a read only field.
property
primaryCategories: The primary catalog categories that the product is assigned to. It is read only.
property
primaryCategoryId: The ID of the products primary category. This is a read only field. It is read only.
property
productBundles: The array of product bundles which the product belongs to. It is read only.
property
productOptions: The array of product options. This is applicable for products of type "option". It is read only.
property
productSets: The array of product sets which the product belongs to. It is read only.
property
searchable: The site-specific searchable status of the product.
property
setProducts: The array of set products which the product includes. It is read only.
property
shortDescription: The localized short description of the product.
property
taxClassId: The tax class identifier of the product.
property
type:
property
unit: The sales unit of the product.
property
unitMeasure: The unitMeasure of the product.
property
unitQuantity: The unitQuantity of the product.
property
upc: The Universal Product Code (UPC) of the product.
property
validFrom: The valid/online from date of the product.
property
validTo: The valid/online to date of the product.
property
variants: The array of variants of the product. This is applicable for product types "master" and "variationGroup" only. It is read only.
property
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.
property
variationGroups: The array of variation groups in the product. This is applicable for product type "master" only. It is read only.
property
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.
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.
filterMode: Compare mode: overlap, containing, or contained.
property
fromField: The field name of the field that starts the first range.
Max Length: 260
property
fromInclusive: A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to false.
property
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.
property
toField: The field name of the field that ends the first range.
Max Length: 260
property
toInclusive: A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to false.
property
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.
fromInclusive: A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to false.
property
to:
property
toInclusive: A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to false.
RangeFilterFrom
RangeFilterFrom:Date | number
RangeFilterTo
RangeFilterTo:Date | number
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.
enabled: A flag indicating whether this rule is enabled.
property
exclusion: A flag indicating whether this rule is an exclusion.
property
categorizationLocaleId: This field indicates the locale to be used for evaluating rules/conditions for the entire category. Note: this applies to all the rules for that category, and the last modification for this field will apply to the entire ruleset for that category.
Max Length: 10
property
categorizationClassificationFlag: This field indicates if the matching products assigned as a result of the rules run will be given the tag for classification category. Note: this applies to all the rules for that category, and the last modification for this field will apply to the entire ruleset for that category.
property
categorizationPrimaryFlag: This field indicates if the matching products assigned as a result of the rules run will be given the tag for primary category. Note: this applies to all the rules for that category, and the last modification for this field will apply to the entire ruleset for that category.
enabled: A flag indicating whether this rule is enabled.
property
exclusion: A flag indicating whether this rule is an exclusion.
property
categorizationLocaleId: This field indicates the locale to be used for evaluating rules/conditions for the entire category. Note: this applies to all the rules for that category, and the last modification for this field will apply to the entire ruleset for that category.
Max Length: 10
property
categorizationClassificationFlag: This field indicates if the matching products assigned as a result of the rules run will be given the tag for classification category. Note: this applies to all the rules for that category, and the last modification for this field will apply to the entire ruleset for that category.
property
categorizationPrimaryFlag: This field indicates if the matching products assigned as a result of the rules run will be given the tag for primary category. Note: this applies to all the rules for that category, and the last modification for this field will apply to the entire ruleset for that category.
RulesResult:{ data?: Array<Rule>; limit: number; total: number } & {}
property
data: The list of rules. This can be empty. Note - If the exclusion attribute is set to true, the rule is designated as an Exclusion rule. Any item matching an Exclusion rule is omitted from the final result set.
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.
limit: Maximum records to retrieve per request, not to exceed 200.
property
query:
property
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.
property
offset: The zero-based index of the first hit/data to include in the result.
displayName: The display name entered by the user.
property
id: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
Min Length: 1
Max Length: 32
property
inDeletion: The deletion status of this site, true if in deletion.
property
storefrontStatus: The storefront status of the site, it can be optionally be set to online, maintenance, to_be_deleted, and protected.
description: The description of the product sorting rule.
Max Length: 4000
property
id: The ID of the product sorting rule.
Max Length: 256
property
productSortingRuleSteps: The steps involved in sorting by this rule.
property
ruleContext: The context of the rule, either site or global.
property
site: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
filters: A list of filters that are logically combined by an operator.
operator: The logical operator that is used to combine the filters.