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=="      ]    }  }'