/api/v4/locations/cancel_archiveCancelar el archivado programado de ubicaciones
Cancela el archivado pendiente de las ubicaciones en estado ARCHIVE_SCHEDULED y las devuelve al estado activo.
Parámetros
Cuerpo
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| input.locationIds | array of strings | obligatorio | Base64-encoded location node IDs whose scheduled archival should be cancelled. |
| input.clientMutationId | string | opcional | Optional correlation token returned unchanged in the response. |
Solicitud de ejemplo
Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.
{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==" ] }}Respuestas
200Archival cancelled. Locations return to ACTIVE status.
{ "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.
Cancela el archivado programado de las ubicaciones que actualmente están en ARCHIVE_SCHEDULED, el estado establecido por archivar ubicaciones antes de que finalice el ciclo de facturación. Solo se puede cancelar el archivado de las ubicaciones que aún están pendientes de archivado (que todavía no se han archivado por completo). Una vez cancelado, la ubicación vuelve a ACTIVE y la facturación continúa con normalidad.
Caso de uso: revertir una decisión accidental o que se ha reconsiderado. Una tienda cuyo cierre estaba previsto recibe una prórroga antes de que se emita la factura. Envía aquí su ID en base64 para eliminarla de la cola de archivado; la respuesta result[] confirma que cada ubicación ha vuelto a ACTIVE. Como la operación está orientada al procesamiento por lotes, puedes cancelar varios archivados programados en una sola llamada y consultar los indicadores success de cada ubicación.
Advertencia: plazos y requisitos. Esto solo funciona mientras la ubicación siga en ARCHIVE_SCHEDULED. Una vez que finaliza el ciclo de facturación, la ubicación queda completamente archivada y esta llamada devuelve 404 para ella; en ese caso, utiliza el flujo de activación/reactivación para restaurar una ubicación ya archivada.
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==" ] } }'