GeoQuery

  • boost
    Type: array object[] · Boost

    When set, boost products within certain geographic range from given point.

    • distance
      Type: number · Distance
      required

      Distance to center point, in kilometer or mile (according to distance_unit)

    • lat
      Type: number · Lat
      min:  
      -90
      max:  
      90
      required

      Latitude of the center point, should between 90 and -90

    • lon
      Type: number · Lon
      min:  
      -180
      max:  
      180
      required

      Longitude of the center point, should between 180 and -180

    • boost_positions
      Type: array integer[] · Boost Positions
          Defines a list of 0-based positions you want to place the boosted products at.

    If `boost_positions` is not specified (which is the default behavior), all the boosted products will be ranked
    higher than the rest of the products.
    • distance_unit
      enum

      Unit of distance(km or mile). Defaults to mile

      values
      • km
      • mile
    • field
      Type: string · Field

      Name of the field in product data that holds geographic coordinate. Defaults to location

  • filter
    Type: array object[] · Filter

    When set, filter result to include only products within certain geographic range from given point.

    • distance
      Type: number · Distance
      required

      Distance to center point, in kilometer or mile (according to distance_unit)

    • lat
      Type: number · Lat
      min:  
      -90
      max:  
      90
      required

      Latitude of the center point, should between 90 and -90

    • lon
      Type: number · Lon
      min:  
      -180
      max:  
      180
      required

      Longitude of the center point, should between 180 and -180

    • distance_unit
      enum

      Unit of distance(km or mile). Defaults to mile

      values
      • km
      • mile
    • field
      Type: string · Field

      Name of the field in product data that holds geographic coordinate. Defaults to location