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。由於此操作採批次處理,您可以在單次呼叫中取消多個已排程的封存作業,並讀取各地點的 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=="      ]    }  }'