Listings APIListings API
サインイン
POST/api/v4/locations/cancel_archive

予定されている拠点のアーカイブを取り消す

ARCHIVE_SCHEDULED ステータスの拠点の保留中のアーカイブを取り消し、アクティブな状態に戻します。

API キーが必要です。ヘッダーの形式とキーのローテーションについては認証を参照してください。

パラメーター

ボディ

名前型必須説明
input.locationIdsarray of strings必須Base64-encoded location node IDs whose scheduled archival should be cancelled.
input.clientMutationIdstring任意Optional correlation token returned unchanged in the response.

リクエストの例

そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。

Request body
{  "input": {    "locationIds": [      "TG9jYXRpb246MTgwMDI4OQ=="    ]  }}

レスポンス

200Archival cancelled. Locations return to ACTIVE status.
Response
{  "data": {    "cancelLocationsArchive": {      "clientMutationId": null,      "bulkEditTaskId": null,      "errors": null,      "success": null,      "result": [        {          "locationId": "TG9jYXRpb246MTgwMDI4OQ==",          "status": "ACTIVE",          "success": true,          "errors": null        }      ]    }  }}
400Bad request, invalid or empty `locationIds`.
401Unauthenticated, missing or invalid API key.
404Location not found or not in ARCHIVE_SCHEDULED status.

現在 ARCHIVE_SCHEDULED の状態にある拠点の予定されたアーカイブを取り消します。この状態は、請求サイクルが終了する前に 拠点をアーカイブ によって設定されます。取り消しができるのは、まだアーカイブ待ちで、完全にはアーカイブされていない拠点のみです。取り消すと、拠点は ACTIVE に戻り、請求は通常どおり継続されます。

ユースケース：誤操作や方針変更によるアーカイブを取り消す。 閉店予定だった店舗の営業継続が、請求書の発行前に決まった場合を想定します。その店舗の base64 ID をここに送信して、アーカイブ待ちのキューから削除します。レスポンスの result[] で、各拠点が ACTIVE に戻ったことを確認できます。バッチ処理に対応しているため、1 回の呼び出しで複数の予定されたアーカイブを取り消し、拠点ごとの success フラグを確認できます。

注意点：タイミングと対象条件。 この操作が機能するのは、拠点がまだ ARCHIVE_SCHEDULED の状態にある間のみです。請求サイクルが終了すると拠点は完全にアーカイブされ、この呼び出しはその拠点に対して 404 を返します。すでにアーカイブされた拠点を復元するには、代わりに有効化または再有効化のフローを使用してください。

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