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"
},
],
]
}| Field | Type | Description | |
|---|---|---|---|
| id | int | Store ID | |
| name | string | Name of store | |
| nickname | string | Nickname of store (Overrides name of store for SMS macro) | |
| avatar | string | Avatar of store | |
| addr | obj | Address object for store. Lat + Long are automatically filled in/ updated when address changes | |
| userID | string | User ID this store falls under | |
| reviewLinks | obj | User ID’s for 3rd party platform review link pages. | |
| sourceMapping | obj | The Alpine IQ store ID the contact has set as their favorite | |
| onlineShopURL | string | URL to this stores online shopping experience (appears in wallet for consumers to shop from mobile) | |
| phone | string | Store 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"
},
],
]
}
