GET api/v100/stores?distance={distance}&storeID={storeID}&latitude={latitude}&longitude={longitude}&limit={limit}

Get a list of the nearest service stations.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
distance

decimal number

None.

storeID

string

None.

latitude

GPS Latitude Information

decimal number

None.

longitude

GPS Longitude Information

decimal number

None.

limit

Maximum quantity of sites to return. If null, will use 1 to georeference a site.

integer

None.

Headers

NameDescriptionTypeAdditional information
appkey

Ej. abcdefghijk

None.

session

Ej. 1234567890

None.

Body Parameters

None.

Response Information

Resource Description

Collection of RsStores
NameDescriptionTypeAdditional information
storeID

Store identifier

string

Required

brand

Service Station Brand Name

string

Required

storeName

Store Name

string

Required

currency

Currency ISO Code

string

Required

distance

Distance in meters from current coordinates to site

integer

Required

allowPurchase

Allow Purchase

boolean

Required

tags

Tags of the Store

Collection of Tags

None.

openHours

OpenHours

string

None.

city

City of the Service Station

string

String length: inclusive between 0 and 50

region

Region of the Service Station

string

String length: inclusive between 0 and 50

address

Address of the Service Station

string

String length: inclusive between 0 and 100

fuelPrices

Fuel Prices of the Merchants

Collection of FuelPrices

None.

phones

Site Phone Numbers List

Collection of Phones

None.

paymentCardTypes

Card Types tha site Supports

Collection of CardTypes

None.

geoCoordinates

Location of the store

GeoCoordinates

None.

currencyISOCode

Currency ISOCode

string

Required

currencySymbol

Currency Symbol

string

Required

FKCountries

Country's ID

integer

Required

Country

Country

Countries

None.

loyaltyCardTypes

Card Types tha site Supports to Loaylty

Collection of CardTypes

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "storeID": "sample string 1",
    "brand": "sample string 2",
    "storeName": "sample string 3",
    "currency": "sample string 4",
    "distance": 5,
    "allowPurchase": true,
    "tags": [
      {
        "tag": "sample string 1"
      },
      {
        "tag": "sample string 1"
      }
    ],
    "openHours": "sample string 7",
    "city": "sample string 8",
    "region": "sample string 9",
    "address": "sample string 10",
    "fuelPrices": [
      {
        "fuelProductName": "sample string 1",
        "fuelProductPrice": 2.0
      },
      {
        "fuelProductName": "sample string 1",
        "fuelProductPrice": 2.0
      }
    ],
    "phones": [
      {
        "phoneDescription": "sample string 1",
        "phoneNumber": "sample string 2"
      },
      {
        "phoneDescription": "sample string 1",
        "phoneNumber": "sample string 2"
      }
    ],
    "paymentCardTypes": [
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      },
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      }
    ],
    "geoCoordinates": {
      "latitude": 1.0,
      "longitude": 2.0,
      "angleUOM": "sample string 3",
      "datum": "sample string 4"
    },
    "currencyISOCode": "sample string 11",
    "currencySymbol": "sample string 12",
    "FKCountries": 13,
    "Country": {
      "ID": 1,
      "name": "sample string 2",
      "Status": 3,
      "IconURL": "sample string 4"
    },
    "loyaltyCardTypes": [
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      },
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      }
    ]
  },
  {
    "storeID": "sample string 1",
    "brand": "sample string 2",
    "storeName": "sample string 3",
    "currency": "sample string 4",
    "distance": 5,
    "allowPurchase": true,
    "tags": [
      {
        "tag": "sample string 1"
      },
      {
        "tag": "sample string 1"
      }
    ],
    "openHours": "sample string 7",
    "city": "sample string 8",
    "region": "sample string 9",
    "address": "sample string 10",
    "fuelPrices": [
      {
        "fuelProductName": "sample string 1",
        "fuelProductPrice": 2.0
      },
      {
        "fuelProductName": "sample string 1",
        "fuelProductPrice": 2.0
      }
    ],
    "phones": [
      {
        "phoneDescription": "sample string 1",
        "phoneNumber": "sample string 2"
      },
      {
        "phoneDescription": "sample string 1",
        "phoneNumber": "sample string 2"
      }
    ],
    "paymentCardTypes": [
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      },
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      }
    ],
    "geoCoordinates": {
      "latitude": 1.0,
      "longitude": 2.0,
      "angleUOM": "sample string 3",
      "datum": "sample string 4"
    },
    "currencyISOCode": "sample string 11",
    "currencySymbol": "sample string 12",
    "FKCountries": 13,
    "Country": {
      "ID": 1,
      "name": "sample string 2",
      "Status": 3,
      "IconURL": "sample string 4"
    },
    "loyaltyCardTypes": [
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      },
      {
        "ID": 1,
        "FKVaultCommunication": 2,
        "CardTypeCode": "sample string 3",
        "Description": "sample string 4",
        "loyaltyType": 5,
        "IconURL": "sample string 6",
        "IncludeCVV": 7,
        "IncludeExp": 8,
        "PanLength": 9,
        "PanMinLength": 10,
        "Status": 11,
        "PaymentMethod": 0
      }
    ]
  }
]