拠点のアーカイブ

パラメーター

ボディ

名前	型	必須	説明
input.locationIds	array of strings	必須	Base64-encoded location node IDs to archive.
input.clientMutationId	string	任意	Optional correlation token returned unchanged in the response. It does not prevent duplicate writes: the server does not detect repeated calls that reuse the same value.

レスポンス

200Locations scheduled for archival. Returns per-location status.

Response

{  "data": {    "archiveLocations": {      "clientMutationId": null,      "bulkEditTaskId": null,      "errors": null,      "success": null,      "result": [        {          "locationId": "TG9jYXRpb246MTgwMDI4OQ==",          "status": "ARCHIVE_SCHEDULED",          "success": true,          "errors": null        },        {          "locationId": "TG9jYXRpb246MTgwMDI5MA==",          "status": "ARCHIVE_SCHEDULED",          "success": true,          "errors": null        }      ]    }  }}

400Bad request, invalid or empty `locationIds`.

401Unauthenticated, missing or invalid API key.

403Forbidden, insufficient permissions to archive.

1つ以上の拠点をアーカイブします。アーカイブは即時には実行されません。各拠点はARCHIVE_SCHEDULEDに設定され、現在の請求サイクルが終了するまで稼働し続けます。次の請求書が生成されると、拠点は完全にアーカイブされ、その拠点への課金が停止します。

ユースケース：請求サイクルの終了時に閉鎖した支店の利用を終了します。 フランチャイズが複数の店舗を完全に閉鎖する場合は、それらのbase64 IDを1回の呼び出しで送信し、サイクルの途中ではなく、次の請求書の生成時に課金が終了するようにします。レスポンスのresult[]を確認してください。各エントリには、その拠点のstatusとsuccessフラグが含まれるため、一部の失敗（1つの無効なID）によってバッチの残りの処理が妨げられることはありません。

レスポンスのステータス値：

ARCHIVE_SCHEDULED：請求サイクルの終了時にアーカイブされるよう、キューに登録されています
ARCHIVED：すでにアーカイブされています

取り消し： まだ予約中のアーカイブを請求サイクルが終了する前に取り消すには、同じIDを指定してスケジュール済みアーカイブのキャンセルを呼び出します。アーカイブ済みの拠点は、再有効化するまで更新できません。

curl -X POST 'https://listingsapi.com/api/v4/locations/archive' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==", "TG9jYXRpb246MTgwMDI5MA==" ] } }'

パラメーター

ボディ

リクエストの例

レスポンス