INPUT_OBJECT

SellerSearchInput

Seller search arguments for building an ElasticSearch query.

link GraphQL Schema definition

  • input SellerSearchInput {
  • # Search by name of the company or store. Includes partial text matches in
  • # results.
  • businessName: String
  • # Official name of a city or suburb. Takes precedence over postcode if both are
  • # provided.
  • city: String
  • # Include sellers within this distance of the location searched.
  • #
  • # NOTE: As of June 2020, this currently defaults to 10 kms or miles
  • #
  • # (depending on country), but this will be deprecated in favour
  • #
  • # of defaulting to no limit on distance from the queried location.
  • distance: Int
  • # Whether to ignore the distance argument
  • #
  • # in favour of not limiting seller results by distance from the queried location.
  • #
  • # NOTE: As of June 2020, this is a temporary field that will be deprecated
  • #
  • # once the default for distance is changed from 10 to nil.
  • ignoreDistance: Boolean
  • # Filter by ID of the seller.
  • id: ID
  • # Postcode/Zip code. Postcode will be ignored if city is also provided.
  • postcode: String
  • # Full, official name of a state, region, or territory.
  • #
  • # State will be ignored if city or postcode is provided and is in a different
  • # state.
  • state: String
  • # Flag to filter sellers to online only stores. Defaults to nil.
  • onlineOnly: Boolean
  • # Flag to filter sellers to only those that have valid geocode data. Defaults to
  • # false.
  • geocoded: Boolean
  • # Filter by store category.
  • sellerCategory: String
  • # Filter by the URL slug of the store category.
  • sellerCategorySlug: String
  • # Only return sellers which have been updated since this date
  • updatedSince: ISO8601DateTime
  • }