Listings APIListings API
Accedi
POST/api/v4/locations/cancel_archive

Annullare l'archiviazione programmata delle sedi

Annulla un'archiviazione in sospeso per le sedi nello stato ARCHIVE_SCHEDULED, riportandole allo stato attivo.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Corpo

NomeTipoObbligatorioDescrizione
input.locationIdsarray of stringsobbligatorioBase64-encoded location node IDs whose scheduled archival should be cancelled.
input.clientMutationIdstringfacoltativoOptional correlation token returned unchanged in the response.

Richiesta di esempio

Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.

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

Risposte

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.

Annulla l'archiviazione programmata per le sedi attualmente nello stato ARCHIVE_SCHEDULED, impostato da archiviare le sedi prima della chiusura del ciclo di fatturazione. L'annullamento è possibile solo per le sedi ancora in attesa di archiviazione (non ancora completamente archiviate). Una volta annullata l'archiviazione, la sede torna allo stato ACTIVE e la fatturazione prosegue normalmente.

Caso d'uso: annullare una decisione presa per errore o successivamente rivista. Un negozio destinato alla chiusura ottiene una proroga prima dell'emissione della fattura. Invia qui il suo ID base64 per rimuoverlo dalla coda di archiviazione; result[] nella risposta conferma che ogni sede è tornata allo stato ACTIVE. Poiché l'operazione è pensata per l'elaborazione in blocco, puoi annullare più archiviazioni programmate con una singola chiamata e leggere i flag success per ciascuna sede.

Punto di attenzione: tempistiche e requisiti. Questa operazione funziona solo mentre la sede è ancora nello stato ARCHIVE_SCHEDULED. Dopo la chiusura del ciclo di fatturazione, la sede è completamente archiviata e questa chiamata restituisce 404 per quella sede; per ripristinare una sede già archiviata, usa invece il flusso di attivazione/riattivazione.

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