Get Asset from ID

GET

https://api.woosmap.com/stores/{storeId}

Used to retrieve an asset from his storeId

Authorization

key

apiKey query

A Public key generated specifically to authenticate API requests on the front side. See how to register a Public API Key.

Referer

apiKey header

The Referer HTTP request header is mandatory when using PublicApiKeyAuth. In browser environment, the Referer is set by the browser itself and cannot be overridden.

private_key

apiKey query

A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to register a Private API Key.

X-Api-Key

apiKey header

A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to register a Private API Key.

Path Parameters

storeId

string required

ID of the asset to get

Example: STORE_ID_123456

Response

200 application/json

Asset successfully retrieved

type

string

the Geojson Type (only 'Feature')

Available options: Feature

properties

object

Attributes describing an Asset.

Show 12 propertiesHide 12 properties

properties. name

string

The asset's name.

Example: My Cool Store

properties. store_id

string

A textual identifier that uniquely identifies an Asset. It must matches the following regexp [A-Za-z0-9]+

Example: STORE_ID_12345

properties. address

object

An object containing the separate components applicable to this address.

Example:

        {
  "lines": [
    "8 Southwark St"
  ],
  "country_code": "UK",
  "city": "London",
  "zipcode": "SE1 1TL"
}

Show 4 propertiesHide 4 properties

properties.address. lines

string[]

An Array for lines of an Asset Address

Example:

        [
  "Building Centre",
  "26 Store Street"
]

properties.address. country_code

string | null

An ISO_3166-1 Country Code where the Asset is located (see https://en.wikipedia.org/wiki/ISO_3166-1 for full list)

Example: UK

properties.address. city

string

A City where belongs an Asset

Example: London

properties.address. zipcode

string

An Zipcode / Postal code of an Asset Address

Example: WC1E 7BT

properties. contact

object

An object containing the asset's contact available information.

Example:

        {
  "website": "https://www.woosmap.com",
  "phone": "+44 20 7693 4000",
  "email": "[email protected]"
}

Show 3 propertiesHide 3 properties

properties.contact. website

string

The website contact for this Asset, such as a business' homepage.

Example: https://www.woosmap.com

properties.contact. phone

string

Contains the Asset's phone number in its local format.

Example: +44 20 7693 4000

properties.contact. email

string

Contains the Asset's email contact.

Example: [email protected]

properties. open

object

The Current opening status for an Asset

Example:

        {
  "open_now": true,
  "open_hours": [
    {
      "end": "20:00",
      "start": "05:00"
    }
  ],
  "week_day": 1,
  "current_slice": {
    "end": "20:00",
    "start": "05:00"
  }
}

Show 5 propertiesHide 5 properties

properties.open. current_slice

object

The hours for an opening period. To define a slice of time where the asset is open you must define a start and end keys. start and end must belong to the same day (crossing midnight may result in open_now being always false.)

Example:

        {
  "start": "08:30",
  "end": "19:30"
}

Show 2 propertiesHide 2 properties

properties.open.current_slice. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.open.current_slice. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.open. open_hours

object[]

the opening hours for the day

Show 2 propertiesHide 2 properties

properties.open.open_hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.open.open_hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.open. open_now

boolean

Boolean value indicating the status of the opening hours

properties.open. next_opening

object

the next opening hours period

Show 3 propertiesHide 3 properties

properties.open.next_opening. end

string

the hours of next opening

Example: 17:30

properties.open.next_opening. start

string

the hours of next closing

Example: 06:00

properties.open.next_opening. day

string

the day of next opening

Example: 2021-11-16

properties.open. week_day

integer

the day of the week starting from 1 to 7

properties. weekly_opening

object

The current Weekly Opening taking into account the special hours

Example:

        {
  "1": {
    "hours": [],
    "isSpecial": false
  },
  "2": {
    "hours": [
      {
        "end": "22:00",
        "start": "08:30"
      }
    ],
    "isSpecial": false
  },
  "3": {
    "hours": [
      {
        "end": "22:00",
        "start": "08:30"
      }
    ],
    "isSpecial": false
  },
  "4": {
    "hours": [
      {
        "end": "22:00",
        "start": "08:30"
      }
    ],
    "isSpecial": false
  },
  "5": {
    "hours": [
      {
        "end": "22:00",
        "start": "08:30"
      }
    ],
    "isSpecial": false
  },
  "6": {
    "hours": [
      {
        "end": "22:00",
        "start": "08:30"
      }
    ],
    "isSpecial": false
  },
  "7": {
    "hours": [
      {
        "end": "22:00",
        "start": "08:30"
      }
    ],
    "isSpecial": false
  },
  "timezone": "Europe/London"
}

Show 8 propertiesHide 8 properties

properties.weekly_opening. 1

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.1. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.1.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.1.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.1. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. 2

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.2. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.2.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.2.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.2. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. 3

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.3. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.3.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.3.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.3. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. 4

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.4. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.4.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.4.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.4. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. 5

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.5. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.5.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.5.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.5. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. 6

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.6. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.6.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.6.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.6. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. 7

object

The opening Hours for Monday

Example:

        {
  "hours": [
    {
      "start": "06:30",
      "end": "18:00"
    }
  ],
  "isSpecial": false
}

Show 2 propertiesHide 2 properties

properties.weekly_opening.7. hours

object[]

Show 2 propertiesHide 2 properties

properties.weekly_opening.7.hours. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.weekly_opening.7.hours. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.weekly_opening.7. isSpecial

boolean

Define if the hours comes from a special opening hours day.

Example: false

properties.weekly_opening. timezone

string

Timezone for the Opening Hours of an Asset. It is used to compute the open_now property of an asset. see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: Europe/London

properties. types

string[]

Contains an array of types describing the Asset.

Example:

        [
  "drive",
  "click_and_collect"
]

properties. tags

string[]

Contains an array of tags describing the Asset. For example a list of available amenities.

Example:

        [
  "wifi",
  "covered_parking"
]

properties. last_updated

string | null

the previous date timestamp when the asset has been updated

Example: 2022-11-08T15:48:08.556803+00:00

properties. user_properties

object | null

Contains all additional information relative to an Asset. If not set it returns null value.

Example:

        {
  "some_user_properties": "some_value"
}

properties. opening_hours

object | null

An object describing the opening hours of an Asset.

Example:

        {
  "timezone": "Europe/London",
  "usual": {
    "1": [],
    "default": [
      {
        "start": "08:30",
        "end": "22:00"
      }
    ]
  },
  "special": {
    "2015-02-07": [
      {
        "start": "08:00",
        "end": "23:00"
      }
    ]
  }
}

Show 3 propertiesHide 3 properties

properties.opening_hours. timezone

string

Timezone for the Opening Hours of an Asset. It is used to compute the open_now property of an asset. see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: Europe/London

properties.opening_hours. usual

object

An object describing the usual opening hours of an Asset.

Show 8 propertiesHide 8 properties

properties.opening_hours.usual. 1

object[]

The opening Hours for Monday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.1. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.1. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. 2

object[]

The opening Hours for Tuesday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.2. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.2. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. 3

object[]

The opening Hours for Wednesday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.3. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.3. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. 4

object[]

The opening Hours for Thursday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.4. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.4. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. 5

object[]

The opening Hours for Friday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.5. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.5. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. 6

object[]

The opening Hours for Saturday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.6. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.6. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. 7

object[]

The opening Hours for Sunday

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.7. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.7. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.usual. default

object[]

Contains the default opening hours to apply to all week days

Show 2 propertiesHide 2 properties

properties.opening_hours.usual.default. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.usual.default. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours. special

object

An object describing the special opening hours of an Asset.

Show 2 propertiesHide 2 properties

properties.opening_hours.special. 2015-02-07

object[]

The format for defining opening and closing hours for a particular day is the same as the usual. Instead of using numeric week day for keys you must use a date YYYY-MM-DD like "2015-03-08" (see ISO-8601).

Show 2 propertiesHide 2 properties

properties.opening_hours.special.2015-02-07. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.special.2015-02-07. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties.opening_hours.special. 2015-02-08

object[]

Show 2 propertiesHide 2 properties

properties.opening_hours.special.2015-02-08. start

string required

Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59

Example: 08:30

properties.opening_hours.special.2015-02-08. end

string required

Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59

Example: 19:30

properties. distance

number

The distance in meters from the geolocated position or searched position if exist

Example: 544.581

geometry

object

GeoJSon Point Geometry

Example:

        {
  "type": "Point",
  "coordinates": [
    -0.14408,
    51.5088
  ]
}

Show 2 propertiesHide 2 properties

geometry. type

string

the geometry type

Available options: Point

geometry. coordinates

number[]

An array of comma separated {latitude,longitude} strings.

Example:

        [
  43.4,
  -2.1
]

Errors

401

Unauthorized. Incorrect authentication credentials.

application/json

detail

string

Details for the credentials error

Example: Incorrect authentication credentials. Please check or use a valid API Key

403

Forbidden. This Woosmap API is not enabled for this project.

application/json

detail

string

Details for the forbidden error message

Example: This Woosmap API is not enabled for this project.

404

Not Found - storeId do not exist.

            curl -L 'https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'

            const requestOptions = {
  method: "GET",
  redirect: "follow"
};

fetch("https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

            import requests

url = "https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY"

payload = {}
headers = {
    'Referer': 'http://localhost'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

            {
  "type": "Feature",
  "properties": {
    "store_id": "10031",
    "name": "Santa Rosa & Yolanda",
    "contact": {
      "phone": "707-527-1006",
      "website": "https://www.starbucks.com/store-locator/store/10031/santa-rosa-yolanda-2688-santa-rosa-ave-santa-rosa-ca-954077625-us"
    },
    "address": {
      "lines": [
        "2688 Santa Rosa Ave",
        "Santa Rosa, CA 95407"
      ],
      "country_code": "US",
      "city": "Santa Rosa",
      "zipcode": "954077625"
    },
    "user_properties": {
      "take_away": "available"
    },
    "tags": [
      "DT",
      "WA",
      "CD",
      "DR",
      "LB",
      "GO",
      "XO",
      "MX",
      "NB",
      "BE",
      "LU"
    ],
    "types": [
      "Coffee shop"
    ],
    "last_updated": "2022-11-10T13:26:55.066524+00:00",
    "open": {
      "open_now": false,
      "open_hours": [
        {
          "end": "20:00",
          "start": "05:00"
        }
      ],
      "week_day": 2,
      "next_opening": {
        "day": "2025-09-16",
        "start": "05:00",
        "end": "20:00"
      }
    },
    "weekly_opening": {
      "1": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "2": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "3": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "4": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "5": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "6": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "7": {
        "hours": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "isSpecial": false
      },
      "timezone": "America/Los_Angeles"
    },
    "opening_hours": {
      "usual": {
        "1": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "2": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "3": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "4": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "5": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "6": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ],
        "7": [
          {
            "end": "20:00",
            "start": "05:00"
          }
        ]
      },
      "special": {},
      "timezone": "America/Los_Angeles"
    }
  },
  "geometry": {
    "type": "Point",
    "coordinates": [
      -122.712924,
      38.41244
    ]
  }
}

    

            {
  "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
}

    

            {
  "detail": "This Woosmap API is not enabled for this project."
}

    