elefymove
ドキュメント

開発者ドキュメント

ElefyMove Open APIのガイドとリファレンス。

これらのガイドは現在英語のみで提供されています。

The master calendar

ElefyMove’s calendar is the single source of truth for anything bookable. Every date range carries a state — AVAILABLE, HELD, BOOKED, or BLOCKED — and conflicts resolve first-come-first-served across every channel.

メソッドエンドポイントスコープ内容
GET/api/public/v1/listings/{id}/availabilityavailability:read指定期間のリスティング統合カレンダー（空き・仮押さえ・予約済み・ブロック）を取得します。
GET/api/public/v1/availabilityavailability:read最大50件のリスティングの空き状況を1回のリクエストでまとめて取得します。所有していない、または存在しないIDはリクエストを失敗させず、レスポンスのnotFoundに含まれます。
GET/api/public/v1/listings/{id}/blocksavailability:read指定リスティングに対する自社の有効な外部チャネルブロックを取得します。日付範囲で絞り込むこともできます。
POST/api/public/v1/listings/{id}/blocksavailability:write外部チャネルのブロックを、自社の参照 ID を付けて作成または更新します。
POST/api/public/v1/listings/{id}/blocks/batchavailability:write1件のリスティングに対して最大100件の外部チャネルブロックを1回のリクエストでまとめて作成・更新します。各ブロックごとに成功・失敗の結果が返ります。
DELETE/api/public/v1/listings/{id}/blocks/batchavailability:write1件のリスティングに対して最大100件の外部チャネルブロックを1回のリクエストでまとめて削除します。各ブロックごとに成功・失敗の結果が返ります。
DELETE/api/public/v1/listings/{id}/blocks/{externalRef}availability:write以前に登録した外部チャネルのブロックを削除します。
curl "https://elefymove.com/api/public/v1/listings/{listingId}/availability?from=2026-09-01&to=2026-09-30" \
  -H "X-Api-Key: efy_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# Response — 200 OK
[
  { "from": "2026-09-01", "to": "2026-09-14", "state": "AVAILABLE" },
  { "from": "2026-09-15", "to": "2026-09-20", "state": "BLOCKED", "source": "partner-site", "externalRef": "HMXYZ123" },
  { "from": "2026-09-21", "to": "2026-09-30", "state": "AVAILABLE" }
]

Syncing a whole portfolio? GET /availability reads up to 50 listings in one call — pass their ids as a comma-separated listingIds. An id you don't own or that doesn't exist is folded into the response's notFound array rather than failing the whole request.

External blocks

When a stay is booked on your own platform, write a block carrying your reference. Blocks are dates + a reference only — no guest personal data crosses the API. GET /listings/:id/blocks reads your own active blocks back, optionally narrowed by from/to.

The batch endpoints write or delete up to 100 blocks on one listing in a single call. Each block gets its own result — check every item in the response rather than assuming the whole batch landed; one bad date range never rolls back the others.

Temporary holds

Place a short-lived hold (up to 10 minutes per call) while a guest completes checkout on your side, then either confirm it into a block or release it early. Not ready in time? POST /holds/:id/extend re-arms the expiry — but a hold's total lifetime, measured from when it was created (not from the extension), is capped at 30 minutes. An extension that would cross that cap is refused with a 409, so extending repeatedly cannot hold inventory indefinitely.

メソッドエンドポイントスコープ内容
GET/api/public/v1/holdsholds:write自社の仮押さえを新しい順に一覧します。デフォルトでは有効なものだけを表示し、?status=allで範囲を広げられます。
GET/api/public/v1/holds/{id}holds:writeIDを指定して自社の仮押さえを1件取得します。
POST/api/public/v1/listings/{id}/holdsholds:writeゲストが自社サイトで決済する間、期間を仮押さえします。競合に負けたリクエストには SLOT_TAKEN を含む 409 が返ります。
POST/api/public/v1/holds/{id}/extendholds:write仮押さえの有効期限を現在時刻から延長します。仮押さえの総有効期間は作成時から最大30分に制限されており、この上限を超える延長リクエストは409で拒否されます。
DELETE/api/public/v1/holds/{id}holds:write有効期限前に自社の仮押さえを解除します。
curl -X POST "https://elefymove.com/api/public/v1/listings/{listingId}/holds" \
  -H "X-Api-Key: efy_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"from": "2026-09-15", "to": "2026-09-20", "ttlSeconds": 300}'

# Response — 201 Created
{ "holdId": "hld_9f3a2c1b", "expiresAt": "2026-08-13T10:15:00Z" }

Losing a conflict

If another channel takes the dates first, the losing request gets a machine-readable 409 — surface it to your guest and refresh availability:

# Same request, the dates were just taken by another channel
# Response — 409 Conflict
{
  "code": "SLOT_TAKEN",
  "conflictingState": "HELD",
  "wonBy": "external"
}