Store locations API

Endpoints:


Get all store locations

Description: Returns all store locations within your account.
Endpoint: (GET) /stores/:uid

Response body:

{
  "data": {
    "stores": [
      {
        "id": 16,
        "name": "Aspen - CO Principle ST",
        "nickname": "Aspen",
        "avatar": "https://lab.alpineiq.com/avatar/1002",
        "addr": {
          "city": "aspen",
          "country": "US",
          "zipCode": "81612",
          "state": "CO",
          "street": "1723 stargazer dr",
          "lat": 31.7479481,
          "long": -93.59451609999999
        },
        "userID": "1002",
        "reviewLinks": {
          "google": "aspenFinestbrand",
          "facebook": "aspenFinestbrand",
          "leafly": "aspenFinestbrand",
          "weedmaps": "aspenFinestbrand",
          "instagram": "aspenFinestbrand",
          "twitter": "aspenFinestbrand",
          "yelp": "aspenFinestbrand"
        },
        "sourceMapping": {"cova": "theNameCovaHasForStore"},
        "onlineShopURL": "https://iheartjane.com/some-store",
        "phone": "8882220000"
      },
    ],
  ]
}
FieldTypeDescription
idintStore ID
namestringName of store
nicknamestringNickname of store (Overrides name of store for SMS macro)
avatarstringAvatar of store
addrobjAddress object for store. Lat + Long are automatically filled in/ updated when address changes
userIDstringUser ID this store falls under
reviewLinksobjUser ID’s for 3rd party platform review link pages.
sourceMappingobjThe Alpine IQ store ID the contact has set as their favorite
onlineShopURLstringURL to this stores online shopping experience (appears in wallet for consumers to shop from mobile)
phonestringStore phone number (appears in wallet for consumers to call)

PUT store

Description: Lets you update a store
Endpoint: (PUT) /stores/:uid/:storeID

Payload:

{
  "data": {
    "stores": [
      {
        "id": 16,
        "name": "Aspen - CO Principle ST",
        "nickname": "Aspen",
        "avatar": "https://lab.alpineiq.com/avatar/1002",
        "addr": {
          "city": "aspen",
          "country": "US",
          "zipCode": "81612",
          "state": "CO",
          "street": "1723 stargazer dr",
          "lat": 31.7479481,
          "long": -93.59451609999999
        },
        "userID": "1002",
        "reviewLinks": {
          "google": "aspenFinestbrand",
          "facebook": "aspenFinestbrand",
          "leafly": "aspenFinestbrand",
          "weedmaps": "aspenFinestbrand",
          "instagram": "aspenFinestbrand",
          "twitter": "aspenFinestbrand",
          "yelp": "aspenFinestbrand"
        },
        "sourceMapping": {"cova": "theNameCovaHasForStore"},
        "onlineShopURL": "https://iheartjane.com/some-store",
        "phone": "8882220000"
      },
    ],
  ]
}