Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Retailers

Find retailer locations using either an address or coordinates

post/get_retailer_locations

Request body

OR

Example request

{
  "street": "5201 Great America Pkwy",
  "city": "Santa Clara",
  "state": "CA",
  "postal_code": "95054"
}

Response

List of Retailers Created

retailer'7-Eleven' | 'Ace Cash Express' | 'Albertson's' | 'Casey's' | 'CVS' | 'Dollar General' | 'Family Dollar' | 'Fidelity Express' | 'Kroger' | 'Pin4' | 'QuotePro' | 'Walgreens' | 'Walmart'

The name of the retailer

streetstring

The street address of this retailer location.

citystring

The state of this retailer location

latitudestring

The latitude coordinate of this retailer location.

longitudestring

The longitude coordinate of this retailer location.

distancestring

The distance (in miles) of this retailer location from the customer address.

phonestring

The phone number of this retailer location.

pnm_retailer_identifier'7-Eleven' | 'R4443678411 (Ace Cash Express)' | '00028 (Albertson's)' | '03135 (Blackhawk Network)' | '01346 (Casey's)' | 'CVS' | '52e507ae8599be79d0010786000a3989 (Dollar General)' | '0de49278bc2c7cffa6f4e7481e51e62e (Family Dollar)' | 'FidelityExpress' | 'GDN-KROGER' | 'PIN4' | 'QUOTEPRO' | 'GDN-WALGREENS' | 'R2396117362 (Walmart)'

A unique, PayNearMe-provided ID for the retailer

Example response

{
  "retailer": "7-Eleven",
  "street": "486 Gov. Printz Blvd.",
  "city": "DE",
  "latitude": "39.75529",
  "longitude": "-75.49923",
  "distance": "1.17",
  "phone": "302-764-5180",
  "pnm_retailer_identifier": "7-Eleven"
}