Listings APIListings API
로그인
POST/api/v4/locations/cancel_archive

예약된 사업장 보관 처리 취소

ARCHIVE_SCHEDULED 상태인 사업장의 대기 중인 보관 처리를 취소하여 활성 상태로 복원합니다.

API 키가 필요합니다. 헤더 형식과 키 교체는 인증을 참고하세요.

매개변수

본문

이름유형필수설명
input.locationIdsarray of strings필수Base64-encoded location node IDs whose scheduled archival should be cancelled.
input.clientMutationIdstring선택Optional correlation token returned unchanged in the response.

요청 예시

바로 붙여 넣을 수 있는 본문입니다. 예시 ID와 값을 실제 값으로 바꾸세요.

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

응답

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.

현재 ARCHIVE_SCHEDULED 상태인 사업장의 예약된 보관 처리를 취소하며, 이 상태는 청구 주기가 종료되기 전에 사업장 보관 처리를 통해 설정됩니다. 아직 보관 처리를 기다리는 사업장(보관 처리가 완전히 끝나지 않은 사업장)만 취소할 수 있습니다. 취소하면 사업장은 ACTIVE 상태로 돌아가고 청구는 정상적으로 계속됩니다.

사용 사례: 실수로 내렸거나 번복한 결정 되돌리기. 폐점 예정이던 매장이 청구서 발행 전에 폐점을 보류하게 된 경우입니다. 해당 매장의 base64 ID를 여기에 제출하여 보관 처리 대기열에서 제거합니다. 응답의 result[]는 각 사업장이 ACTIVE 상태로 돌아갔음을 확인해 줍니다. 일괄 처리를 지원하므로 한 번의 호출로 여러 사업장의 예약된 보관 처리를 취소하고 사업장별 success 플래그를 확인할 수 있습니다.

주의 사항: 시점과 적용 조건. 이 작업은 사업장이 아직 ARCHIVE_SCHEDULED 상태일 때만 가능합니다. 청구 주기가 종료되면 사업장의 보관 처리가 완전히 끝나고 이 호출은 해당 사업장에 대해 404를 반환하므로, 이미 보관 처리된 사업장을 복원하려면 대신 활성화/재활성화 흐름을 사용합니다.

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