searchProducts

Operation Id:

products/products/search/post [Official Documentaction]

Methods

dispatchSettings Object
returnProducts String
returnElements Array<String>
productIsAvailable String
productIsVisible String
productVersionId Integer
productInPromotion String
productInDiscount String
productInDistinguished String
productInSpecial String
productInForPointsSelling String
productIsObservedByClients String
skipDefaultProduct String
showPromotionsPrices String
categories Array<Object>
producers Array<Object>
productParams Array<Object>
productIndexes Array<Object>
productShops Array<Object>
productPromotionsIds Array<Integer>
productDate Object
productParametersParams Array<Object>
productSeriesParams Array<Object>
productUnits Array<Object>
productWarranties Array<Object>
deliverersIds Array<Integer>
containsText String
containsCodePart String
productAvailableInStocks Object
productAvailableInAuctions Object
resultsPage Integer
resultsLimit Integer
ordersBy Array<Object>
productSearchingLangId String
productSearchingCurrencyId String
returnPricesCurrency String
productHasNote String
productInExportToPriceComparisonSites String
productInExportToAmazonMarketplace String
selectedAmazonMarketplacesList Array<String>
productInBestseller String
productInNew String
searchByShops Object
productSearchPriceRange Object
productVatRates Array<Number>
productIsVatFree String
productHasWholesalePrice String
productInPersistent String
returnProductsVersions String
productInSumInBasket String
productType Object
productMenuItems Object
productLocationId Integer
productLocationTextId String
alwaysReturnProductShopSizesAttributes Boolean
returnEmptyStocksWithReservation Boolean
picturesData Object
responsibleProducerCode String
responsiblePersonCode String
byMenus value: number|string|number[]|string[]
byShops value: number|string|number[]|string[]
dates dateFrom: DateLike, dateTo: DateLike, type: "added"|"finished"|"resumed"|"modified"|"quantity_changed"|"price_changed"|"modified_and_quantity_changed"
orderBy elementName: "id"|"name"|"code"|"product_sizecode"|"code_producer"|"retail_price"|"pos_price"|"vat"|"wholesale_price"|"minimal_price"|"pictures_count"|"auction_name"|"pricecomparer_name"|"version_name"|"series_name"|"category_name"|"deliverer_name"|"adding_time"|"modification_time"|"price_changed_time"|"quantity_changed_time"|"currency"|"currency_shop"|"taxcode"|"meta_title"|"meta_description"|"meta_keywords"|"suggested_price"|"observed_clients"|"observed_time"|"wishes_clients"|"wishes_time", descending: boolean
shops values: number|string|number[]|string[]
ids values: number|string|number[]|string[]
byProducers values: number|string|number[]|string[]
byCategories values: number|string|number[]|string[]
byUnits values: number|string|number[]|string[]
bySeries values: number|string|number[]|string[]
byWarranties values: number|string|number[]|string[]
byIndexes values: number|string|number[]|string[]
onlyMainVersion onlyMain: boolean
byPrice minPrice: number, maxPrice: number, priceType: "retail_price"|"wholesale_price"|"minimal_price"|"pos_price"|"last_purchase_price"
inStock stockIds: boolean|number|string|number[]|string[]

Examples

This function returns the elements of a list named "searchProducts" that specifically have the attribute "code".

const result = await idosellRequest.searchProducts
	.returnElements(["code"])
	.exec()

This function retrieves a list of finished products that have dates between December 1, 2023, and December 31, 2023.

const result = await idosellRequest.searchProducts
	.dates("2023-12-01",  "2023-12-31", "finished")
	.exec()

This function returns a list of products starting from the 10th item of the 2nd page.

const result = await idosellRequest.searchProducts
	.page(2,10)
	.exec()

The function returns a list of product IDs containing [9, 10, 17].

const result = await idosellRequest.searchProducts
	.ids([9,10,17])
	.exec()

This function returns a list of products with a retail price between $200 and $500.

const result = await idosellRequest.searchProducts
	.byPrice(200, 500, "retail_price")
	.exec()

This function filters and returns a list of products based on the menu ID provided as an argument.

const result = await idosellRequest.searchProducts
	.byMenus([152])
	.exec()

This function retrieves a list of products associated with the shops identified by the IDs [1,2].

const result = await idosellRequest.searchProducts
	.byShops([1,2])
	.exec()

This function retrieves a list of products based on the producer's ID number 1142347122.

const result = await idosellRequest.searchProducts
	.byProducers(1142347122)
	.exec()

This function retrieves a list of products by their corresponding categories using a specified ID number.

const result = await idosellRequest.searchProducts
	.byCategories(1214553884)
	.exec()

This function filters and returns a list of products that have 1 unit.

const result = await idosellRequest.searchProducts
	.byUnits(1)
	.exec()

This function returns a list of products which belong to series 1.

const result = await idosellRequest.searchProducts
	.bySeries([1])
	.exec()

This function returns a list of products that only include the main version.

const result = await idosellRequest.searchProducts
	.onlyMainVersion()
	.exec()

This function filters a list of products and returns only those with a warranty length of 1 year.

const result = await idosellRequest.searchProducts
	.byWarranties([1])
	.exec()

This function returns a list of products that are not in stock.

const result = await idosellRequest.searchProducts
	.inStock(false)
	.exec()

This function returns a list of products that are currently in stock.

const result = await idosellRequest.searchProducts
	.inStock()
	.exec()

This function checks which products are in stock and have IDs 2 and 3.

const result = await idosellRequest.searchProducts
	.inStock([2,3])
	.exec()