Listings APIListings API
登入
POST/api/v4/locations/archive

封存地點

排程在目前帳務週期結束時封存一個或多個地點。

需要 API 金鑰。標頭格式與金鑰輪替請參閱驗證。

參數

請求主體

名稱類型必填說明
input.locationIdsarray of strings必填Base64-encoded location node IDs to archive.
input.clientMutationIdstring選填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.

請求範例

可直接貼上的請求主體。請將預留位置 ID 與值換成您自己的。

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

回應

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.

封存一個或多個地點。封存不會立即生效：每個地點都會進入 ARCHIVE_SCHEDULED 狀態，並持續上線直到目前帳務週期結束。產生下一張帳單時，地點才會完全封存，並停止對該地點計費。

使用案例：在週期結束時停用已歇業的分店。 當連鎖加盟業者永久關閉多家門市時，可透過一次呼叫提交這些地點的 base64 ID，讓計費在產生下一張帳單時終止，而非在週期中途終止。請檢查回應中的 result[]：每筆項目都會回報該特定地點的 status 和 success 旗標，因此部分失敗（例如一個無效 ID）不會阻礙批次中其餘地點的處理。

回應中的狀態值：

  • ARCHIVE_SCHEDULED：已排入佇列，將於帳務週期結束時封存
  • ARCHIVED：已封存

復原： 若要在週期結束前取消仍在排程中的封存作業，請使用相同的 ID 呼叫取消排程封存。已封存的地點必須重新啟用後才能更新。

Request
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=="      ]    }  }'
Run in playground