Locations

The location of stores is crucial for users to determine which store they can visit. The API can display the list of stores, including their names, locations, opening hours, and contact information.

Endpoints

GET /api/v2/store/warehouse# Retrieve Store LocationGET /api/v2/store/name-of-the-store/show# Retrieve Location

Retrieve Store Location

The API endpoint 'GET Store' provides you with detailed store location information.

Parameters

No parameter required.

Attributes

store_id string

The store id.

store_code string

The code of the store.

slug string

The slug of the store url.

name string

The name of the store.

store_fax string

The fax number of the store.

store_phone_number string

The phone number of the store.

store_address string

The address of the store.

lat string

The information about the latitude of the store, to show maps.

lng string

The information about the longitude of the store, to show maps.

formatted_store_phone_number string

The formatted phone number of the store.

chunked_store_address array of objects

The address of the store.

format_store_name null

Is it optional to use this.

store_name_only null

It is optional to use this.

GET /api/v2/store/warehouse

curl --location 'https://appliance-api.com/api/v2/store' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

[
  {
    "store_id": "5cae35250384b",
    "store_code": "29",
    "slug": "example-appliance",
    "name": "Example Store",
    "store_fax": "000-000-000",
    "store_phone_number": "636-277-9025",
    "store_address": "52 Crossroads Plaza, O'Fallon, MO 63368",
    "lat": "38.7609732",
    "lng": "-90.69915700000001",
    "formatted_store_phone_number": "(636) 277-9025",
    "chunked_store_address": [
      "52 Crossroads Plaza",
      " O'Fallon",
      " MO 63368"
    ],
    "format_store_name": null,
    "store_name_only": null
  },
  {
    "store_id": "STORE0002",
    "store_code": "58",
    "slug": "example-appliances",
    "name": "Example Store",
    "store_fax": "314-200-6558",
    "store_phone_number": "314-200-6556",
    "store_address": "5841 S Lindbergh Blvd, St. Louis, MO 63123",
    "lat": "38.5215133",
    "lng": "-90.3475082",
    "formatted_store_phone_number": "(314) 200-6556",
    "chunked_store_address": [
      "5841 S Lindbergh Blvd",
      " St. Louis",
      " MO 63123"
    ],
    "format_store_name": null,
    "store_name_only": null
  },
  {
    "store_id": "STORE0003",
    "store_code": "10",
    "slug": "example-appliances",
    "name": "Example Store",
    "store_fax": "636-227-4783",
    "store_phone_number": "636-227-7727",
    "store_address": "14755 Manchester Rd, Ballwin, MO 63011",
    "lat": "38.593539",
    "lng": "-90.5340169",
    "formatted_store_phone_number": "(636) 227-7727",
    "chunked_store_address": [
      "14755 Manchester Rd",
      " Ballwin",
      " MO 63011"
    ],
    "format_store_name": null,
    "store_name_only": null
  },
  {
    "store_id": "STORE0004",
    "store_code": "49",
    "slug": "example-appliances",
    "name": "Example Store",
    "store_fax": "314-352-6767",
    "store_phone_number": "314-352-8845",
    "store_address": "4900 Hampton Ave, St. Louis, MO 63109",
    "lat": "38.5865201",
    "lng": "-90.2922827",
    "formatted_store_phone_number": "(314) 352-8845",
    "chunked_store_address": [
      "4900 Hampton Ave",
      " St. Louis",
      " MO 63109"
    ],
    "format_store_name": null,
    "store_name_only": null
  }
]

Retrieve Location

The store location page does not only include location information but also other descriptions about the stores.

Parameters

No parameter required.

Attributes

store_id string

The store id.

store_code string

The code of the store.

slug string

The slug of the store url.

name string

The name of the store.

store_fax string

The fax number of the store.

store_phone_number string

The phone number of the store.

store_address string

The address of the store.

lat string

The latitude of the store.

lng string

The longitude of the store.

store_tax_percentage string

The information about store's tax percentage.

virtual_tour null

It is optional to use this.

formatted_store_phone number string

The formatted phone number of the store.

chunked_store_address array of objects

The address of the store.

format_store_name null

It is optional to use this.

store_name_only null

It is optional to use this.

content array of objects

The contain of store description.

id number

The id of the store.

store_id string

The id of the store.

content string

The content of the store description.

created_at string

The date when the content was updated.

images array of objects

id number

The id of the store.

store_id string

The id of the zone.

images string

The source image of the store.

order number

type string

created_at string

The date when the image was created.

updated_at string

The date when the image was updated.

store_hour array of objects

The information about store hour.

store_id string

The id of the store.

day string

The open day of the store.

time_open string

The open time of the store.

time_close string

The close time of the store.

type integer

type_name string

GET /api/v2/store/name-of-the-store/show

curl --location 'https://appliance-api.com/api/v2/store/example-appliances-ofallon-mo/show' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "store_code": "29",
  "store_id": "5cae35250384b",
  "slug": "example-appliances-ofallon-mo",
  "name": "Example Appliances",
  "store_phone_number": "636-277-9025",
  "store_fax": "000-000-000",
  "store_address": "52 Crossroads Plaza, O'Fallon, MO 63368",
  "lat": "38.7609732",
  "lng": "-90.69915700000001",
  "store_tax_percentage": "7.950",
  "virtual_tour": null,
  "formatted_store_phone_number": "(636) 277-9025",
  "chunked_store_address": [
    "52 Crossroads Plaza",
    " O'Fallon",
    " MO 63368"
  ],
  "format_store_name": null,
  "store_name_only": null,
  "content": {
    "id": 1,
    "store_id": "5cae35250384b",
    "content": "<p>Shop Quality-Made Appliances in St. Charles County</p> <p>Committed to quality, value, and service, our Example  family believes in supporting our O’Fallon neighbors with home appliances <i>they can trust</i>. Located right here in Crossroads Plaza, our appliance showroom features the full spectrum of refrigerators, dishwashers, ovens, and <i>beyond</i>. Learn why Example is considered the best appliance store in St. Charles County. Be sure to ask about our next-day local deliveries too! We invite you to either stop by our 5-star rated location or give us a call at (636) 277-9025 to discover the Example <i>difference</i> for yourself.</p>",
    "created_at": "2022-10-20 00:30:00",
    "updated_at": "2022-10-20 00:30:00"
  },
  "images": [
    {
      "id": 1,
      "store_id": "29",
      "images": "/img/retail/o'fallon/059--Full.jpg",
      "order": 1,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 2,
      "store_id": "29",
      "images": "/img/retail/o'fallon/060--Full.jpg",
      "order": 2,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 3,
      "store_id": "29",
      "images": "/img/retail/o'fallon/061--Full.jpg",
      "order": 3,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 4,
      "store_id": "29",
      "images": "/img/retail/o'fallon/062--Full.jpg",
      "order": 4,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 5,
      "store_id": "29",
      "images": "/img/retail/o'fallon/065--Full.jpg",
      "order": 5,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 6,
      "store_id": "29",
      "images": "/img/retail/o'fallon/067--Full.jpg",
      "order": 6,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 8,
      "store_id": "29",
      "images": "/img/retail/o'fallon/070--Full.jpg",
      "order": 8,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 9,
      "store_id": "29",
      "images": "/img/retail/o'fallon/071--Full.jpg",
      "order": 9,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 10,
      "store_id": "29",
      "images": "/img/retail/o'fallon/072--Full.jpg",
      "order": 10,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 11,
      "store_id": "29",
      "images": "/img/retail/o'fallon/075--Full.jpg",
      "order": 11,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 12,
      "store_id": "29",
      "images": "/img/retail/o'fallon/076--Full.jpg",
      "order": 12,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 13,
      "store_id": "29",
      "images": "/img/retail/o'fallon/077--Full.jpg",
      "order": 13,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 14,
      "store_id": "29",
      "images": "/img/retail/o'fallon/079--Full.jpg",
      "order": 14,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 15,
      "store_id": "29",
      "images": "/img/retail/o'fallon/080--Full.jpg",
      "order": 15,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 16,
      "store_id": "29",
      "images": "/img/retail/o'fallon/083--Full.jpg",
      "order": 16,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 17,
      "store_id": "29",
      "images": "/img/retail/o'fallon/085--Full.jpg",
      "order": 17,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 18,
      "store_id": "29",
      "images": "/img/retail/o'fallon/087--Full.jpg",
      "order": 18,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 19,
      "store_id": "29",
      "images": "/img/retail/o'fallon/089--Full.jpg",
      "order": 19,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    },
    {
      "id": 20,
      "store_id": "29",
      "images": "/img/retail/o'fallon/091--Full.jpg",
      "order": 20,
      "type": "store",
      "created_at": "2019-08-22 10:04:08",
      "updated_at": "2019-08-27 04:36:06"
    }
  ],
  "store_hour": [
    {
      "store_id": "5cae35250384b",
      "day": "Monday",
      "time_open": "9:00 AM",
      "time_close": "6:00 PM",
      "type": 1,
      "type_name": "Open"
    },
    {
      "store_id": "5cae35250384b",
      "day": "Tuesday",
      "time_open": "9:00 AM",
      "time_close": "6:00 PM",
      "type": 1,
      "type_name": "Open"
    },
    {
      "store_id": "5cae35250384b",
      "day": "Wednesday",
      "time_open": "9:00 AM",
      "time_close": "6:00 PM",
      "type": 1,
      "type_name": "Open"
    },
    {
      "store_id": "5cae35250384b",
      "day": "Thursday",
      "time_open": "9:00 AM",
      "time_close": "6:00 PM",
      "type": 1,
      "type_name": "Open"
    },
    {
      "store_id": "5cae35250384b",
      "day": "Friday",
      "time_open": "10:00 AM",
      "time_close": "5:00 PM",
      "type": 1,
      "type_name": "Open"
    },
    {
      "store_id": "5cae35250384b",
      "day": "Saturday",
      "time_open": "10:00 AM",
      "time_close": "5:00 PM",
      "type": 1,
      "type_name": "Open"
    },
    {
      "store_id": "5cae35250384b",
      "day": "Sunday",
      "time_open": "9:00 AM",
      "time_close": "6:00 PM",
      "type": 2,
      "type_name": "Closed"
    }
  ]
}

Locations

Retrieve Store Location​

Parameters​

Attributes​

Retrieve Location​

Parameters​

Attributes​

Retrieve Store Location

Parameters

Attributes

Retrieve Location

Parameters

Attributes