Get google location details

GET 
/api/v2/google/locations/:location_id

Returns a Google location object that corresponds to the given google_location_id. The location_id is a unique identifier for each location.

Request

Path Parameters

location_id stringrequired

Responses

200

application/json

Schema

Schema

id stringrequired

Unique identifier for the location

location_name string

Name of the location

store_code stringnullable

Code for the store

region_code stringnullable

Region code

postal_code stringnullable

Postal code

address_details stringnullable

Detailed address information

locality stringnullable

Locality

place_id string

Google Place ID

google_verifications

object

Verification status and timestamp for Google verifications

status string

Verification status

checked_at date-time

Timestamp when verified

phone_numbers stringnullable

Phone number

Example (from schema)

{
  "id": "6047dac0604f33da03018004",
  "location_name": "Annie - HQ",
  "store_code": "annie-hq",
  "region_code": "FR",
  "postal_code": "75018",
  "address_details": "130 rue mont cenis",
  "locality": "Paris",
  "place_id": "ChIJ3Qu-HpFt5kcRNHUedqwIzQY",
  "google_verifications": {
    "status": "verified",
    "checked_at": "2023-01-30T14:25:11.163950Z"
  },
  "phone_numbers": 675181818
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...