Locations

Get location

Returns a single location the authenticated app has been granted access to.

此内容尚不支持你的语言。

GEThttps://api.maple.inc/v1/locations/{locationId}API key

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Parameters

locationId string path required

Responses

200 OK

object string required

Always location.
id string required
name string or null required
status string required

One of active, inactive, paused.
timezone string or null required
phone string or null required
address object required
address.line1 string or null required
address.line2 string or null required
address.city string or null required
address.region string or null required
address.postal_code string or null required
address.country string or null required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
404 Not found DeveloperApiNotFound
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

Get location

curl "$MAPLE_BASE/locations/str_123" \
  -H "Authorization: Bearer $MAPLE_KEY"

import os
import requests

r = requests.get(
    f"{os.environ['MAPLE_BASE']}/locations/str_123",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/locations/str_123`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "location",
  "id": "string",
  "name": "string",
  "status": "active",
  "timezone": "string",
  "phone": "+15555550123",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string"
  }
}

{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}