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

Archiviare le sedi

Programma l'archiviazione di una o più sedi alla fine del ciclo di fatturazione corrente.

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 to archive.
input.clientMutationIdstringfacoltativoOptional 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.

Richiesta di esempio

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

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

Risposte

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.

Archivia una o più sedi. L'archiviazione non è immediata: ogni sede viene impostata su ARCHIVE_SCHEDULED e rimane attiva fino alla fine del ciclo di fatturazione corrente. Quando viene generata la fattura successiva, la sede viene archiviata definitivamente e la relativa fatturazione si interrompe.

Caso d'uso: dismettere le filiali chiuse alla fine del ciclo. Quando un franchising chiude definitivamente diversi negozi, invia i loro ID base64 in un'unica chiamata affinché la fatturazione termini alla fattura successiva anziché a metà ciclo. Controlla result[] nella risposta: ogni voce riporta status e un flag success per quella specifica sede, quindi un errore parziale (un ID errato) non blocca il resto del batch.

Valori di stato nella risposta:

  • ARCHIVE_SCHEDULED: in coda per l'archiviazione alla fine del ciclo di fatturazione
  • ARCHIVED: già archiviata

Annullamento: per annullare un'archiviazione ancora programmata prima della chiusura del ciclo, richiama annullare l'archiviazione programmata con gli stessi ID. Le sedi archiviate non possono essere aggiornate finché non vengono riattivate.

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