INPUT_OBJECT

AdvertSearchInput

Advert search arguments for building an ElasticSearch query.

link GraphQL Schema definition

  • input AdvertSearchInput {
  • # Request specific adverts by ID rather than query on advert attributes.
  • advertIds: [ID!]
  • # Minimum date for booking availability. Specific to adverts for services
  • #
  • # that accept date-based reservations, such as hotels, tours, or events.
  • bookingDateFrom: ISO8601DateTime
  • # Minimum date for booking availability. Specific to adverts for services
  • #
  • # that accept date-based reservations, such as hotels, tours, or events.
  • bookingDateTo: ISO8601DateTime
  • # IDs of desired brands. See the Brand data type for more details.
  • brandIds: [ID!]
  • # Brand name as represented by a partial URL path with spaces replaced by '-'.
  • #
  • # Must match a brand name saved in the database and search index.
  • brandSlug: String
  • # The conditions of the product being advertised.
  • conditions: [AdvertConditionEnum!]
  • # IDs of the desired countries (i.e. where the sellers are based).
  • #
  • # See the Country data type for more details.
  • countryIds: [ID!]
  • # Indicates how long the advertised event or holiday lasts.
  • durationPeriod: AdvertDurationPeriodEnum
  • # Gender for whom the product is intended.
  • genders: [AdvertGenderEnum!]
  • # Location name, usually a city, as represented by a partial URL path with spaces
  • # replaced by '-'.
  • #
  • # Must match an indexed location name.
  • locationSlug: String
  • # Query adverts by maximum price denominated in cents.
  • maxPriceCents: Int
  • # Query adverts by minimum price denominated in cents.
  • minPriceCents: Int
  • # IDs of desired option values (e.g. 'red', 'large').
  • #
  • # See the OptionValue data type for more details.
  • optionValueIds: [ID!]
  • # The desired postcode, which matches according to the seller's address
  • postcode: String
  • # IDs of the desired advert templates (i.e. products). Mostly used to search by
  • # model year.
  • productIds: [ID!]
  • # Search advert text fields with one or more keywords.
  • keywordQuery: String
  • # For searching by region or state. Must be the abbreviation
  • #
  • # of the region/state name (e.g. use 'VIC', not 'Victoria').
  • regionName: String
  • # Region, state, or province name as represented by a partial URL path with spaces
  • # replaced by '-'.
  • regionSlug: String
  • # The ways in which the good or service can be purchased and collected.
  • saleTypes: [AdvertSaleTypeEnum!]
  • # When location is included in the search, the radius (in kilometers
  • #
  • # or miles depending on country) from the geographic center of the queried
  • # location.
  • searchDistance: Int
  • # Whether your searching for adverts by retailer or by individual adverts.
  • searchType: AdvertSearchTypeEnum
  • # IDs of the desired sellers. See the Seller data type for more details.
  • sellerIds: [ID!]
  • # The attributes by which results can be sorted.
  • sortBy: AdvertSearchSortByEnum
  • # ID of the desired taxon. See the Taxon data type for more details.
  • taxonId: ID
  • # Taxon name as represented by a partial URL path with spaces replaced by '-'.
  • taxonSlug: String
  • # Based on the taxonType of the associated Taxon.
  • taxonType: TaxonTypeEnum
  • # Only return adverts which have been updated since this date
  • updatedSince: ISO8601DateTime
  • }