Search > Search
Commerce APISearchSearch

Search

The Search API brings to the table robust full-text search capabilities, near real-time data indexing, and complex query functionality. This enables highly granular searches across the store's data, including customers, products, orders, and more. The Search API supports not only keyword-based searching but also facets, filters, and relevance ranking, thereby providing a powerful and flexible tool for comprehensive data access and analysis within your store.

Endpoints

EndpointDescriptionJSON API
searchBrandsSearch brandsPOST:search/brands.json
searchCategoriesSearch categoriesPOST:search/categories.json
searchContentBlocksSearch content blocksPOST:search/content_blocks.json
searchCustomerInventorySearch customer inventory itemsPOST:search/customer_inventory.json
searchCustomersSearch customersPOST:search/customers.json
searchFilesSearch filesPOST:search/files.json
searchOrdersSearch ordersPOST:search/orders.json
searchProductsSearch productsPOST:search/products.json
searchPromotionsSearch promotionsPOST:search/promotions.json
searchPurchaseOrdersSearch purchase ordersPOST:search/purchase_orders.json
searchQuestionsSearch questionsPOST:search/questions.json
searchReindexRequest search re-indexing processPOST:search/reindex.json
searchReviewsSearch reviewsPOST:search/reviews.json
searchSubscriptionsSearch subscriptionsPOST:search/subscriptions.json
searchSuppliersSearch suppliersPOST:search/suppliers.json
searchTransfersSearch transfersPOST:search/transfers.json
searchUnifiedSearch everythingPOST:search/unified.json
searchVariantsSearch product variantPOST:search/variants.json
suggestBrandsSuggest brandsPOST:suggest/brands.json
suggestCategoriesSuggest categoriesPOST:suggest/categories.json
suggestContentBlocksSuggest content blocksPOST:suggest/content_blocks.json
suggestCustomerInventorySuggest customer inventory itemsPOST:suggest/customer_inventory.json
suggestCustomersSuggest customersPOST:suggest/customers.json
suggestFilesSuggest filesPOST:suggest/files.json
suggestOrdersSuggest ordersPOST:suggest/orders.json
suggestProductsSuggest productsPOST:suggest/products.json
suggestPromotionsSuggest promotionsPOST:suggest/promotions.json
suggestPurchaseOrdersSuggest purchase ordersPOST:suggest/purchase_orders.json
suggestQuestionsSuggest questionsPOST:suggest/questions.json
suggestReviewsSuggest reviewsPOST:suggest/reviews.json
suggestSubscriptionsSuggest subscriptionsPOST:suggest/subscriptions.json
suggestSuppliersSuggest suppliersPOST:suggest/suppliers.json
suggestTransfersSuggest transfersPOST:suggest/transfers.json

Types

Types
BrandExpandableItems
BrandSearchResult
CategoryExpandableItems
CategorySearchResult
ContentBlockExpandableItems
ContentBlockSearchResult
CustomerExpandableItems
CustomerInventoryExpandableItems
CustomerInventorySearchResult
CustomerInventoryTypeFilter
CustomerSearchResult
FileExpandableItems
FileSearchResult
OrderExpandableItems
OrderSearchResult
ProductExpandableItems
ProductQuestionExpandableItems
ProductQuestionSearchResult
ProductReviewExpandableItems
ProductReviewSearchResult
ProductSearchResult
ProductVariantSearchResult
PromotionExpandableItems
PromotionSearchResult
PurchaseOrderExpandableItems
PurchaseOrderSearchResult
SearchBrandsSortBy
SearchCategoriesSortBy
SearchContentBlocksSortBy
SearchCustomerInventorySortBy
SearchCustomersSortBy
SearchFilesSortBy
SearchOrdersSortBy
SearchProductsSortBy
SearchPromotionsSortBy
SearchPurchaseOrdersSortBy
SearchQuestionsSortBy
SearchReviewsSortBy
SearchSubscriptionsSortBy
SearchSuppliersSortBy
SearchTransfersSortBy
SearchVariantsSortBy
SubscriptionExpandableItems
SubscriptionSearchResult
SupplierExpandableItems
SupplierSearchResult
TransferExpandableItems
TransferSearchResult
UnifiedSearchResult
VariantTypeFilter