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

Arquivar locais

Agenda o arquivamento de um ou mais locais para o fim do ciclo de faturamento atual.

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

Exemplo de requisição

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

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

Respostas

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.

Arquiva um ou mais locais. O arquivamento não é imediato: cada local é colocado em ARCHIVE_SCHEDULED e permanece ativo até o fim do ciclo de faturamento atual. Quando a próxima fatura é gerada, o local é totalmente arquivado e a cobrança referente a ele é encerrada.

Caso de uso: desativar filiais fechadas no fim do ciclo. Quando uma franquia fecha permanentemente várias lojas, envie os IDs delas em base64 em uma única chamada para que a cobrança seja encerrada na próxima fatura, em vez de no meio do ciclo. Inspecione result[] na resposta: cada entrada informa o status e um sinalizador success para aquele local específico, de modo que uma falha parcial (um ID inválido) não bloqueie o restante do lote.

Valores de status na resposta:

  • ARCHIVE_SCHEDULED: na fila para arquivamento no fim do ciclo de faturamento
  • ARCHIVED: já arquivado

Reversão: para desfazer um arquivamento ainda agendado antes do encerramento do ciclo, chame cancelar arquivamento agendado com os mesmos IDs. Locais arquivados não podem ser atualizados até serem reativados.

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