Get location details

GET 
/v1/partner/locations/:location_id

Retrieves comprehensive information for a specific location using its unique ID. Returns details such as address, contact information, hours of operation, and associated visit types.

Token scope:

{'scope': 'read:locations'}

Request

Path Parameters

location_id Location Idrequired

Required. The unique identifier of the location

Responses

200

Successful Response

application/json

Schema

Schema

address Address (string)required

The street address of the location.

city City (string)required

The city where the location is situated.

display_address Display Address (string)required
group_name Group Name (string)required

hours

object

required

Friday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Monday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Saturday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Sunday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Thursday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Tuesday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Wednesday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

hours_default

object

required

Friday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Monday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Saturday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Sunday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Thursday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Tuesday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

Wednesday

object[]

required

Array [

from_time timerequired

to_time timerequired

]

id Id (integer)required

The unique identifier of the location.

lat_long Lat Long (string)required
name Name (string)required

The name of the location.

phone Phone (string)required

The contact phone number for the location.

platform_type Platform Type (string)required
state State (string)required

The state where the location is situated.

subpremise Subpremise (string)
time_zone Time Zone (string)required

The time zone of the location.

visit_types

object

required

anyOf

MOD1

Array [

string

]

MOD2

string

website Website (string)
zip_code Zip Code (string)required

Example (from schema)

{
  "address": "string",
  "city": "string",
  "display_address": "string",
  "group_name": "string",
  "hours": {
    "Friday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Monday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Saturday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Sunday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Thursday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Tuesday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Wednesday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ]
  },
  "hours_default": {
    "Friday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Monday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Saturday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Sunday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Thursday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Tuesday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ],
    "Wednesday": [
      {
        "from_time": "string",
        "to_time": "string"
      }
    ]
  },
  "id": 0,
  "lat_long": "string",
  "name": "string",
  "phone": "string",
  "platform_type": "string",
  "state": "string",
  "subpremise": "string",
  "time_zone": "string",
  "visit_types": [
    null
  ],
  "website": "string",
  "zip_code": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...