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

Standorte archivieren

Plant die Archivierung eines oder mehrerer Standorte zum Ende des aktuellen Abrechnungszyklus.

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

Beispielanfrage

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

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

Antworten

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.

Archiviert einen oder mehrere Standorte. Die Archivierung erfolgt nicht sofort: Jeder Standort wird in den Status ARCHIVE_SCHEDULED versetzt und bleibt bis zum Ende des aktuellen Abrechnungszyklus aktiv. Wenn die nächste Rechnung erstellt wird, wird der Standort vollständig archiviert und seine Abrechnung endet.

Anwendungsfall: Geschlossene Filialen zum Zyklusende außer Betrieb nehmen. Wenn ein Franchiseunternehmen mehrere Filialen dauerhaft schließt, übermitteln Sie deren base64-IDs in einem einzigen Aufruf, damit die Abrechnung mit der nächsten Rechnung statt mitten im Zyklus endet. Prüfen Sie result[] in der Antwort: Jeder Eintrag enthält status und ein success-Flag für den jeweiligen Standort, sodass ein teilweiser Fehler (eine ungültige ID) den Rest des Stapels nicht blockiert.

Statuswerte in der Antwort:

  • ARCHIVE_SCHEDULED: zur Archivierung am Ende des Abrechnungszyklus vorgemerkt
  • ARCHIVED: bereits archiviert

Rückgängigmachen: Um eine noch geplante Archivierung vor dem Ende des Zyklus rückgängig zu machen, rufen Sie geplante Archivierung abbrechen mit denselben IDs auf. Archivierte Standorte können erst aktualisiert werden, nachdem sie reaktiviert wurden.

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