Listings APIListings API
Se connecter
POST/api/v4/locations/archive

Archiver des établissements

Planifie l’archivage d’un ou de plusieurs établissements à la fin du cycle de facturation en cours.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Corps

NomTypeObligatoireDescription
input.locationIdsarray of stringsobligatoireBase64-encoded location node IDs to archive.
input.clientMutationIdstringfacultatifOptional 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.

Exemple de requête

Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.

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

Réponses

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.

Archive un ou plusieurs établissements. L’archivage n’est pas immédiat : chaque établissement passe à l’état ARCHIVE_SCHEDULED et reste actif jusqu’à la fin du cycle de facturation en cours. Lorsque la prochaine facture est générée, l’établissement est entièrement archivé et sa facturation cesse.

Cas d’utilisation : retirer les succursales fermées à la fin du cycle. Lorsqu’une franchise ferme définitivement plusieurs magasins, envoyez leurs identifiants base64 en un seul appel afin que leur facturation cesse à la prochaine facture plutôt qu’en cours de cycle. Examinez result[] dans la réponse : chaque entrée indique le status et un indicateur success pour l’établissement concerné, de sorte qu’un échec partiel (un identifiant incorrect) ne bloque pas le reste du lot.

Valeurs de statut dans la réponse :

  • ARCHIVE_SCHEDULED : en attente d’archivage à la fin du cycle de facturation
  • ARCHIVED : déjà archivé

Annulation : pour annuler un archivage encore planifié avant la fin du cycle, appelez annuler l’archivage planifié avec les mêmes identifiants. Les établissements archivés ne peuvent pas être mis à jour tant qu’ils n’ont pas été réactivés.

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