사업장 보관 처리

매개변수

본문

이름	유형	필수	설명
input.locationIds	array of strings	필수	Base64-encoded location node IDs to archive.
input.clientMutationId	string	선택	Optional 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.

응답

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_SCHEDULED 상태로 전환되며 현재 청구 주기가 끝날 때까지 활성 상태를 유지합니다. 다음 청구서가 생성되면 해당 사업장은 완전히 보관 처리되고 해당 사업장에 대한 청구가 중단됩니다.

사용 사례: 폐점한 지점을 청구 주기 종료 시점에 정리하기. 프랜차이즈에서 여러 매장을 영구 폐점하는 경우, 한 번의 호출로 해당 매장들의 base64 ID를 제출하면 청구 주기 도중이 아니라 다음 청구서가 생성될 때 청구가 중단됩니다. 응답의 result[]를 확인합니다. 각 항목은 해당 사업장의 status 및 success 플래그를 보고하므로, 일부 실패(잘못된 ID 1개)가 일괄 처리의 나머지 작업을 차단하지 않습니다.

응답의 상태 값:

ARCHIVE_SCHEDULED: 청구 주기 종료 시 보관 처리되도록 대기 중
ARCHIVED: 이미 보관 처리됨

취소: 청구 주기가 끝나기 전에 아직 예약 상태인 보관 처리를 취소하려면 동일한 ID로 예약된 보관 처리 취소를 호출합니다. 보관 처리된 사업장은 다시 활성화하기 전까지 업데이트할 수 없습니다.

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==" ] } }'

매개변수

본문

요청 예시

응답