Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetShopsByProximity

Returns stores in proximity of a set of coordinates.

If ProductID and HasStock is set, only the stores with stock for that product will be returned.

Hierarchy

  • GetShopsByProximity

Index

Properties

Optional CountryID

CountryID: undefined | string

Country code of the user (ISO 3166-1)

Optional HasStock

HasStock: undefined | false | true

Filter only stores with available stock

Latitude

Latitude: number

Range: -90-90

Optional Limit

Limit: undefined | number

Amount of stores to return, defaults to setting GetShopsByProximityDefaultLimit / 10

Longitude

Longitude: number

Range: -180-180

Optional ProductID

ProductID: undefined | number

Entity type: Product

Optional Range

Range: undefined | number

Range around the coordinates to look for shops, in meters, defaults to setting DefaultShopProximityRange / 50_000

Optional Status