Store

Objects

Campaign object

Attribute	Description
storeId	Unique identifier of the store e.g. 8F18CFAF-DF38-4A7E-B541-7031E370ED3D
storeName	Name of the store e.g. Burger King Alpharetta
latitude	Latitude of the store e.g. 34.04935
longitude	Longitude of the store e.g. -84.15855
distance	radius from latitude and longitude to find data in the range. Unit is km. e.g. : 1000000
street1	Street address of the store. e.g. 1601 S MoPac Expy
street2	Street address of the store. e.g. Suite 200
city	City of the store postal address e.g. Austin
state	State of the store address e.g. TX
country	Country of the store address e.g. US
zip	Zipcode of the store address e.g.78746
phoneNumber	Contact number of the store
monday	Opening hours on the day
tuesday	Opening hours on the day
wednesday	Opening hours on the day
thursday	Opening hours on the day
friday	Opening hours on the day
saturday	Opening hours on the day
sunday	Opening hours on the day
cretDtim	Store registered date/time
merchantId	Identifier of the merchant associated with the location
wifi	Whether the store provides WIFI. Possible values are - Y: WIFI provided - N: WIFI not provided
driveThru	Whether the store provides driveThru. Possible values are - Y: DriveThru provided - N: DriveThru not provided
mobilePay	Whether the store provides mobilePay service. Possible values are - Y: MobilePay service provided - N: MobilePay service not provided
accessibility	Whether the store provides accessibility. Possible values are - Y: Accessibility provided - N: Accessibility not provided
fullService	Whether the store provides full service. Possible values are - Y: Full service provided - N: Full service not provided
specialVenue	Whether the store provides special venue. Possible values are - Y: Special venue provided - N: Special venue not provided

APIs

Get stores

Retrieve list of stores in the search conditions.

Precondition

Client logged in the service. Refer the section for registration/authentication.

Request

HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/campaign/{version}/getGeofencingCampaignList

Body parameters

Parameters	Type	Required	Note
latitude	double	Required	Latitude to find coupons in the range. example: 34.044454912173904
longitude	double	Required	Longitude to find coupons in the range. example: -84.48063315578163
wifi	String	Optional	Whether the store provides WIFI. Possible values are - True: WIFI provided - False: WIFI not provided
driveThru	String	Optional	Whether the store provides driveThru. Possible values are - Y: DriveThru provided - N: DriveThru not provided
mobilePay	String	Optional	Whether the store provides mobilePay service. Possible values are - Y: MobilePay service provided - N: MobilePay service not provided
accessibility	String	Optional	Whether the store provides accessibility. Possible values are - Y: Accessibility provided - N: Accessibility not provided
fullService	String	Optional	Whether the store provides full service. Possible values are - Y: Full service provided - N: Full service not provided
specialVenue	String	Optional	Whether the store provides special venue. Possible values are - Y: Special venue provided - N: Special venue not provided
allDay	String	Optional	Whether the store opens all day - Y: The store opens all day - N: The store doesn’t open all day
radius	double	Optional	radius from latitude and longitude to find data in the range. Unit is km. e.g. : 1000000
merchantIds	String[]	Optional	Identifier of the merchant associated with the location

Example request

curl -X POST "http://api-dev.fintiv.co:8080/storelocator/v2/getStore"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d
‘{
               "accessibility": "Y",
               "driveThru": "Y",
               "fullService": "N",
               "latitude": 34.04457909523886,
               "longitude": -84.48085648015558,
               "merchantIds": ["B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A"],
               "mobilePay": "N",
                "radius": 21,
                "specialVenue": "N",
                "wifi": "Y"
}’

Response

Returns list of stores in the search criteria.
Example response

{
  "result": {
    "code": 0
  },
  "storeList": [
    {
      "storeId": "E0A3E9E5-7FE9-44FA-B9E5-6F7E59177CEF",
      "serviceId": 0,
      "storeName": "Burger King Duluth 2",
      "street1": "2111 Pleasant Hill Rd",
      "street2": "suite 100",
      "city": "Duluth",
      "state": "GA",
      "zip": "30096",
      "country": "US",
      "latitude": 33.957483,
      "longitude": -84.134155,
      "phoneNumber": "778-770-7000",
      "monday": "0920-1120",
      "tuesday": "0920-1120",
      "wednesday": "0920-1120",
      "thursday": "0920-21_2",
      "friday": "0920-1120",
      "saturday": "0920-1120",
      "sunday": "0920-1120",
      "wifi": "Y",
      "driveThru": "Y",
      "mobilePay": "Y",
      "accessibility": "Y",
      "fullService": "Y",
      "specialVenue": "Y",
      "cretDtim": "2019-02-04T09:46:13.000+0000",
      "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "distance": 20.752155066456638
    }
  ]
}