/api/v4/locations/cancel_archiveBatalkan pengarsipan lokasi terjadwal
Membatalkan pengarsipan yang tertunda untuk lokasi berstatus ARCHIVE_SCHEDULED, sehingga lokasi tersebut kembali aktif.
Parameter
Body
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| input.locationIds | array of strings | wajib | Base64-encoded location node IDs whose scheduled archival should be cancelled. |
| input.clientMutationId | string | opsional | Optional correlation token returned unchanged in the response. |
Contoh permintaan
Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.
{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==" ] }}Respons
200Archival cancelled. Locations return to ACTIVE status.
{ "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.
Membatalkan pengarsipan terjadwal untuk lokasi yang saat ini berstatus ARCHIVE_SCHEDULED, yaitu status yang ditetapkan oleh arsipkan lokasi sebelum siklus penagihan berakhir. Pengarsipan hanya dapat dibatalkan untuk lokasi yang masih menunggu pengarsipan (belum sepenuhnya diarsipkan). Setelah pengarsipan dibatalkan, lokasi kembali berstatus ACTIVE dan penagihan berlanjut seperti biasa.
Kasus penggunaan: membatalkan keputusan yang tidak disengaja atau yang telah ditarik kembali. Sebuah toko yang dijadwalkan tutup mendapat penangguhan sebelum faktur diproses. Kirim ID base64 toko tersebut di sini untuk menghapusnya dari antrean pengarsipan; result[] dalam respons mengonfirmasi bahwa setiap lokasi telah kembali berstatus ACTIVE. Karena operasi ini berorientasi pada pemrosesan batch, Anda dapat membatalkan beberapa pengarsipan terjadwal dalam satu panggilan dan membaca flag success untuk setiap lokasi.
Hal yang perlu diperhatikan: waktu dan kelayakan. Operasi ini hanya berfungsi selama lokasi masih berstatus ARCHIVE_SCHEDULED. Setelah siklus penagihan berakhir, lokasi sepenuhnya diarsipkan dan panggilan ini mengembalikan 404 untuk lokasi tersebut; gunakan alur aktivasi/reaktivasi untuk memulihkan lokasi yang sudah diarsipkan.
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==" ] } }'