Get google location details

GET 
https://api.staging.powerapi.com/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
Example: 6047dac0604f33da03018004
location_name string
Name of the location
Example: Annie - HQ
store_code stringnullable
Code for the store
Example: annie-hq
region_code stringnullable
Region code
Example: FR
postal_code stringnullable
Postal code
Example: 75018
address_details stringnullable
Detailed address information
Example: 130 rue mont cenis
locality stringnullable
Locality
Example: Paris
place_id string
Google Place ID
Example: ChIJ3Qu-HpFt5kcRNHUedqwIzQY
google_verifications object
Verification status and timestamp for Google verifications
status string
Verification status
Example: verified
checked_at date-time
Timestamp when verified
Example: 2023-01-30T14:25:11.163950Z
phone_numbers stringnullable
Phone number
Example: 675181818

Example (auto)

{
  "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
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

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

401

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

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

403

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

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

404

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

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

422

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
location stringrequired
Where in the request the error occurred
Possible values: [query, body, response, param]
errors object[]required
Array [
path stringrequired
Path to the property with the error
Possible values: non-empty
Example: business.id
constraints objectrequired
property name* string
Error message
Example: Required property
]

Example (auto)

{
  "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
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

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

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• java
• powershell

• CURL

curl -L 'https://api.staging.powerapi.com/api/v2/google/locations/:location_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://api.staging.powerapi.com

Auth

Security Scheme

beareroauth2

Bearer Token

Parameters

location_id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!