com.indix.query

Interface BulkProductsQuery

All Superinterfaces:

ApiParameters, Query

All Known Implementing Classes:

SearchQuery

public interface BulkProductsQuery
extends ApiParameters

Nested Class Summary

Nested classes/interfaces inherited from interface com.indix.query.ApiParameters

ApiParameters.ApplyFiltersTo, ApiParameters.Availability, ApiParameters.PriceChange, ApiParameters.SelectOffersFrom, ApiParameters.SortBy

Method Summary

Methods

Modifier and Type	Method and Description
SearchQuery	withAlsoSoldAt(List<Integer> alsoSoldAt) Combined with storeId, limits results to products sold at both storeIds and alsoSoldAt storeIds.
SearchQuery	withApplyFilterTo(ApiParameters.ApplyFiltersTo applyFiltersTo) Specify the stores for which the offer level filter apply.
SearchQuery	withAvailability(ApiParameters.Availability availability) Limits results to either in-stock or out-of-stock items.
SearchQuery	withBrandId(List<Integer> brandId) Limits results to products of brands with given ids.
SearchQuery	withCategoryId(List<Integer> categoryId) Limits results to products of categories with given id.
SearchQuery	withCountryCode(String countryCode) Limits results to products of the geography with this code.
SearchQuery	withEndPrice(double endPrice) Combined with end_price, limits results to products sold by at least one store at a price between start and end
SearchQuery	withLastRecordedIn(int lastRecordedIn) Limits results to products which have price recorded in the last xx days.
SearchQuery	withOnPromotion(boolean onPromotion) Limits results to products which are on Promotion.
SearchQuery	withPriceChange(ApiParameters.PriceChange priceChange) Limits results to products whose prices have been increased or decreased.
SearchQuery	withPriceHistoryAvailable(boolean priceHistoryAvailable) Limits results to product that have price history available through the products/{:id}/prices endpoint.
SearchQuery	withSelectOffersFrom(ApiParameters.SelectOffersFrom selectOffersFrom) Specify the stores for which offers will be returned in the response.
SearchQuery	withStartPrice(double startPrice) Combined with end_price, limits results to products sold by at least one store at a price between start and end
SearchQuery	withStoreId(List<Integer> storeId) Limits results to products sold at store with id.
SearchQuery	withStoresCount(int storesCount) Limits results to products with at least a certain number of stores

Methods inherited from interface com.indix.query.Query

getParameters

Method Detail

withStoreId

SearchQuery withStoreId(List<Integer> storeId)

Limits results to products sold at store with id. Supports multiple values (acts as OR operator)

withAlsoSoldAt

SearchQuery withAlsoSoldAt(List<Integer> alsoSoldAt)

Combined with storeId, limits results to products sold at both storeIds and alsoSoldAt storeIds.

Parameters:

alsoSoldAt - - The list of alsoSoldAt values predefined in ApiParameters

withBrandId

SearchQuery withBrandId(List<Integer> brandId)

Limits results to products of brands with given ids.

withCategoryId

SearchQuery withCategoryId(List<Integer> categoryId)

Limits results to products of categories with given id.

withStartPrice

SearchQuery withStartPrice(double startPrice)

Combined with end_price, limits results to products sold by at least one store at a price between start and end

withEndPrice

SearchQuery withEndPrice(double endPrice)

Combined with end_price, limits results to products sold by at least one store at a price between start and end

withAvailability

SearchQuery withAvailability(ApiParameters.Availability availability)

Limits results to either in-stock or out-of-stock items. Accepted values: 'IN_STOCK','OUT_OF_STOCK'

withPriceHistoryAvailable

SearchQuery withPriceHistoryAvailable(boolean priceHistoryAvailable)

Limits results to product that have price history available through the products/{:id}/prices endpoint.

withOnPromotion

SearchQuery withOnPromotion(boolean onPromotion)

Limits results to products which are on Promotion. Accepts boolean values

withLastRecordedIn

SearchQuery withLastRecordedIn(int lastRecordedIn)

Limits results to products which have price recorded in the last xx days. Accepted Value is a non-negative integer

withStoresCount

SearchQuery withStoresCount(int storesCount)

Limits results to products with at least a certain number of stores

withPriceChange

SearchQuery withPriceChange(ApiParameters.PriceChange priceChange)

Limits results to products whose prices have been increased or decreased.

Parameters:

priceChange - - The list of alsoSoldAt values predefined in ApiParameters

withApplyFilterTo

SearchQuery withApplyFilterTo(ApiParameters.ApplyFiltersTo applyFiltersTo)

Specify the stores for which the offer level filter apply. Allowed values - storeId (apply filters to only stores in storeId), alsoSoldAt (apply filters to only stores in alsoSoldAt), storeIdOrAlsoSoldAt (apply filters to stores present in both storeId and alsoSoldAt), any (apply filters across all offers)

Parameters:

applyFiltersTo - - ApiParameters.ApplyFiltersTo

withSelectOffersFrom

SearchQuery withSelectOffersFrom(ApiParameters.SelectOffersFrom selectOffersFrom)

Specify the stores for which offers will be returned in the response. Allowed values - storeId (select offers matching filters from storeId), alsoSoldAt (select offers matching filters from alsoSoldAt), storeIdAndAlsoSoldAt (select offers matching filters from stores in both storeId and alsoSoldAt), all (select all offers irrespective of matching or storeId or alsoSoldAt data)

Parameters:

selectOffersFrom - - ApiParameters.SelectOffersFrom

withCountryCode

SearchQuery withCountryCode(String countryCode)

Limits results to products of the geography with this code. Example: 'US', 'GB', etc. If the user doesn’t pass a value, the default option returns the US countryCode data

Parameters:

countryCode - - String value specifying countrycode