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

Cancelar o arquivamento agendado de locais

Cancela um arquivamento pendente de locais com status ARCHIVE_SCHEDULED, tornando-os ativos novamente.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
input.locationIdsarray of stringsobrigatórioBase64-encoded location node IDs whose scheduled archival should be cancelled.
input.clientMutationIdstringopcionalOptional correlation token returned unchanged in the response.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

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

Respostas

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.

Cancela o arquivamento agendado de locais que estão atualmente em ARCHIVE_SCHEDULED, o estado definido por arquivar locais antes do encerramento do ciclo de cobrança. Só é possível cancelar o arquivamento de locais que ainda aguardam essa ação (que ainda não foram totalmente arquivados). Após o cancelamento, o local retorna a ACTIVE e a cobrança continua normalmente.

Caso de uso: reverter uma decisão acidental ou reconsiderada. Uma loja com fechamento previsto ganha uma nova chance antes da emissão da fatura. Envie o ID em base64 dela aqui para removê-la da fila de arquivamento; a resposta result[] confirma que cada local voltou a ACTIVE. Como a operação é feita em lote, você pode cancelar vários arquivamentos agendados em uma única chamada e ler os indicadores success de cada local.

Ponto de atenção: prazo e elegibilidade. Isso só funciona enquanto o local ainda está em ARCHIVE_SCHEDULED. Após o encerramento do ciclo de cobrança, o local é totalmente arquivado e esta chamada retorna 404 para ele; nesse caso, use o fluxo de ativação/reativação para restaurar um local já arquivado.

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