Listings APIListings API
Iniciar sesión
POST/api/v4/locations/archive

Archivar ubicaciones

Programa el archivado de una o más ubicaciones al final del ciclo de facturación actual.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Cuerpo

NombreTipoObligatorioDescripción
input.locationIdsarray of stringsobligatorioBase64-encoded location node IDs to archive.
input.clientMutationIdstringopcionalOptional 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.

Solicitud de ejemplo

Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.

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

Respuestas

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.

Archiva una o más ubicaciones. El archivado no es inmediato: cada ubicación pasa al estado ARCHIVE_SCHEDULED y permanece activa hasta el final del ciclo de facturación actual. Cuando se genera la siguiente factura, la ubicación queda completamente archivada y deja de facturarse.

Caso de uso: dar de baja sucursales cerradas al final del ciclo. Cuando una franquicia cierra permanentemente varias tiendas, envía sus IDs en base64 en una sola llamada para que dejen de facturarse al generarse la siguiente factura, en lugar de a mitad del ciclo. Inspecciona result[] en la respuesta: cada entrada indica el status y un indicador success para esa ubicación específica, de modo que un fallo parcial (un ID incorrecto) no bloquea el resto del lote.

Valores de estado en la respuesta:

  • ARCHIVE_SCHEDULED: en cola para su archivado al final del ciclo de facturación
  • ARCHIVED: ya archivada

Reversión: para deshacer un archivado que aún está programado antes de que termine el ciclo, llama a cancelar el archivado programado con los mismos IDs. Las ubicaciones archivadas no se pueden actualizar hasta que se reactiven.

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