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

Annuler l’archivage programmé d’établissements

Annule un archivage en attente pour les établissements au statut ARCHIVE_SCHEDULED et les rétablit à l’état actif.

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 whose scheduled archival should be cancelled.
input.clientMutationIdstringfacultatifOptional correlation token returned unchanged in the response.

Exemple de requête

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

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

Réponses

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.

Annule l’archivage programmé des établissements actuellement à l’état ARCHIVE_SCHEDULED, défini par archiver des établissements avant la clôture du cycle de facturation. L’annulation n’est possible que pour les établissements dont l’archivage est encore en attente (pas encore entièrement archivés). Une fois l’archivage annulé, l’établissement revient à l’état ACTIVE et la facturation se poursuit normalement.

Cas d’utilisation : revenir sur une décision prise par erreur ou révisée. Un magasin dont la fermeture était prévue bénéficie d’un sursis avant l’émission de la facture. Soumettez ici son ID en base64 pour le retirer de la file d’attente d’archivage ; la réponse result[] confirme que chaque établissement est revenu à l’état ACTIVE. Comme cette opération fonctionne par lots, vous pouvez annuler plusieurs archivages programmés en un seul appel et consulter les indicateurs success de chaque établissement.

Point d’attention : délai et éligibilité. Cette opération ne fonctionne que tant que l’établissement est encore à l’état ARCHIVE_SCHEDULED. Après la clôture du cycle de facturation, l’établissement est entièrement archivé et cet appel renvoie 404 pour celui-ci ; utilisez alors le processus d’activation ou de réactivation pour rétablir un établissement déjà archivé.

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