Skip to main content

Search

Saleor provides full-text search capabilities across key entities in the system, allowing you to find records by matching terms against multiple fields simultaneously.

Added in Saleor 3.23

Supported Modules​

ModuleSearchable Fields
ProductsName, description, variant SKU, variant name, attribute values
OrdersOrder number, user email, customer name, customer note, external reference, billing/shipping address, line items, payments, transactions, discounts, invoices, order notes
CustomersFirst name, last name, email (including domain), addresses
Gift CardsCode (last 4 digits), full code, tags, used by / created by email and name
CheckoutsToken, email, user name, billing/shipping address, line items, payments, transactions
PagesTitle, slug, content, page type name and slug, attribute values
Field details

The following sections describe exactly which sub-fields are indexed for shared concepts like addresses, line items, and payments.

Address fields​

Applies to: Orders, Customers, Checkouts

  • firstName
  • lastName
  • streetAddress1
  • streetAddress2
  • companyName
  • city
  • cityArea
  • countryArea
  • countryName
  • countryCode
  • postalCode
  • phone

Line item fields​

Applies to: Orders, Checkouts

Orders:

  • productSku
  • productName
  • variantName
  • translatedProductName
  • translatedVariantName

Checkouts:

  • variant.sku
  • product.name
  • variant.name

Payment fields​

Applies to: Orders, Checkouts

  • paymentId
  • pspReference

Transaction fields​

Applies to: Orders, Checkouts

  • transaction.token
  • transaction.pspReference
  • transaction.events.pspReferences

Order-specific fields​

In addition to the shared fields above, orders also index:

Discounts:

  • discount.name
  • discount.translatedName

Invoices:

  • ID

Order notes:

  • Messages from NOTE_ADDED and NOTE_UPDATED events

Search Access Points​

The enhanced search is available via two entry points:

  • Root-level search argument — e.g., orders(search: "coffee")
  • filter.search field — e.g., orders(filter: { search: "coffee" })

Both use the same underlying full-text search engine.

Search Operators​

Every search term uses prefix matching by default — the query coff will match "coffee", "coffeehouse", etc. The only exception is when a term is wrapped in double quotes ("…"), which switches to exact phrase matching where the full phrase must appear as-is.

Multiple terms can be combined with the following operators:

OperatorSyntaxExampleDescription
Prefix matchingtermcoffMatches "coffee", "coffeehouse", etc. (default behavior)
AND (implicit)term1 term2coffee shopBoth terms must match; each term is prefix-matched
AND (explicit)term1 AND term2coffee AND shopSame as implicit AND; both terms must match
ORterm1 OR term2coffee OR teaEither term matches (uppercase OR required); each term is prefix-matched
NOT-termcoffee -decafExcludes results containing prefix matches for "decaf"
Exact phrase"phrase""green tea"Matches the exact phrase only — no prefix matching
Combiningmixed-"green tea" coffeeExclude an exact phrase and require a prefix-matched term

Search Behavior​

Case Sensitivity​

Search is case-insensitive. Searching for Coffee, coffee, or COFFEE will return the same results.

Special Characters​

Certain special characters are automatically converted to spaces during search processing. This ensures search queries work reliably even when they contain punctuation or special symbols.

Characters converted to spaces: ( ) & | ! : < > ' *

For example:

  • Searching for 22:20 is treated as two separate terms: 22 and 20
  • Searching for (coffee) searches for: coffee

Preserved characters: Letters, numbers, underscore (_), hyphen (-), at sign (@), and period (.)

Unclosed Quotes​

If you forget to close a quoted phrase, the search will treat everything after the opening quote as part of the phrase:

  • "green tea (missing closing quote) → searches for the phrase "green tea"

Empty or Invalid Queries​

  • Empty search string — Returns no results
  • Only special characters — If the query contains only special characters that get converted to spaces (e.g., ::::), it returns no results
  • Whitespace only — Returns no results

Examples​

Use the root-level search argument to find products:

query SearchProducts($search: String) {
  products(first: 10, search: $search) {
    edges {
      node {
        id
        name
      }
    }
  }
}

Search with operators on checkouts​

Use filter.search with operators to refine results:

query SearchCheckouts($filter: CheckoutFilterInput) {
  checkouts(first: 10, filter: $filter) {
    edges {
      node {
        id
        email
      }
    }
  }
}

Explicit relevance sorting​

Use the RANK sort field to explicitly sort by relevance:

query SearchCustomers($filter: CustomerFilterInput, $sortBy: UserSortingInput) {
  customers(
    first: 10
    filter: $filter
    sortBy: $sortBy
  ) {
    edges {
      node {
        id
        firstName
        lastName
        email
      }
    }
  }
}

Overriding the default sort order​

By default, search results are sorted by relevance. You can override this with any other supported sortBy field:

query SearchProductsSorted($search: String, $sortBy: ProductOrder) {
  products(
    first: 10
    search: $search
    sortBy: $sortBy
  ) {
    edges {
      node {
        id
        name
      }
    }
  }
}

Relevance Ranking​

  • By default, results are sorted by relevance (RANK) when a search query is provided.
  • Scoring algorithm:
    • Exact matches receive 2x weight in relevance scoring
    • Prefix matches receive 1x weight in relevance scoring
    • For example, searching for "coffee" will rank products with the exact word "coffee" higher than products containing "coffeehouse"
  • The default RANK sorting can be overridden using the sortBy parameter.
  • A RANK sort field is available for explicit relevance sorting.
  • Using RANK sort without a search query will result in an error.