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

Geplante Archivierung von Standorten abbrechen

Bricht eine ausstehende Archivierung für Standorte im Status ARCHIVE_SCHEDULED ab und versetzt sie wieder in den aktiven Zustand.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Body

NameTypErforderlichBeschreibung
input.locationIdsarray of stringserforderlichBase64-encoded location node IDs whose scheduled archival should be cancelled.
input.clientMutationIdstringoptionalOptional correlation token returned unchanged in the response.

Beispielanfrage

Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.

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

Antworten

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.

Bricht die geplante Archivierung für Standorte ab, die sich derzeit im Status ARCHIVE_SCHEDULED befinden, der durch Standorte archivieren vor dem Ende des Abrechnungszeitraums gesetzt wird. Die Archivierung kann nur für Standorte abgebrochen werden, deren Archivierung noch aussteht (die also noch nicht vollständig archiviert sind). Nach dem Abbruch kehrt der Standort in den Status ACTIVE zurück, und die Abrechnung wird wie gewohnt fortgesetzt.

Anwendungsfall: eine versehentlich getroffene oder revidierte Entscheidung rückgängig machen. Ein Geschäft, dessen Schließung geplant war, erhält vor der Rechnungserstellung einen Aufschub. Übermitteln Sie hier seine base64-ID, um es aus der Archivierungswarteschlange zu entfernen; die Antwort result[] bestätigt, dass jeder Standort wieder den Status ACTIVE hat. Da der Aufruf auf Stapelverarbeitung ausgelegt ist, können Sie mehrere geplante Archivierungen mit einem einzigen Aufruf abbrechen und die success-Flags für jeden Standort auslesen.

Achtung: Zeitpunkt und Voraussetzungen. Dies funktioniert nur, solange der Standort noch den Status ARCHIVE_SCHEDULED hat. Nach dem Ende des Abrechnungszeitraums ist der Standort vollständig archiviert, und dieser Aufruf gibt für ihn 404 zurück; verwenden Sie stattdessen den Ablauf zur Aktivierung/Reaktivierung, um einen bereits archivierten Standort wiederherzustellen.

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