Get Location

Returns the Location object for a valid identifier. If it’s for a deleted Location it returns the deleted property that’s set to true.

SecurityOAuth2.0
Request
path Parameters
location-id
required
string
header Parameters
x-api-key
string
tenant-id
string
Content-Type
string
Default: application/json
Responses
200
get/locations/{location-id}
Request samples 
Response samples 
application/json
{
  • "location_id": "string",
  • "location_code": "string",
  • "location_name": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_phone": "string",
  • "alternate_phone": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "postcode": "string",
  • "country": "string",
  • "coords": "string",
  • "what3words": "string",
  • "type": "business",
  • "shopify_location_id": "string",
  • "deleted": true,
  • "merchants": [
    ]
}