/api/v4/locations/archiveArsipkan lokasi
Menjadwalkan satu atau beberapa lokasi untuk diarsipkan pada akhir siklus penagihan saat ini.
Parameter
Body
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| input.locationIds | array of strings | wajib | Base64-encoded location node IDs to archive. |
| input.clientMutationId | string | opsional | 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. |
Contoh permintaan
Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.
{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==", "TG9jYXRpb246MTgwMDI5MA==" ] }}Respons
200Locations scheduled for archival. Returns per-location status.
{ "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.
Mengarsipkan satu atau beberapa lokasi. Pengarsipan tidak langsung dilakukan: setiap lokasi ditempatkan dalam status ARCHIVE_SCHEDULED dan tetap aktif hingga akhir siklus penagihan saat ini. Saat faktur berikutnya dibuat, lokasi tersebut diarsipkan sepenuhnya dan penagihan untuk lokasi tersebut dihentikan.
Contoh penggunaan: menonaktifkan cabang yang sudah tutup pada akhir siklus. Saat sebuah waralaba menutup beberapa toko secara permanen, kirim ID base64 toko-toko tersebut dalam satu panggilan agar penagihan berhenti saat faktur berikutnya dibuat, bukan di tengah siklus. Periksa result[] dalam respons: setiap entri melaporkan status dan penanda success untuk lokasi tersebut, sehingga kegagalan sebagian (satu ID yang tidak valid) tidak menghalangi pemrosesan lokasi lainnya dalam batch.
Nilai status dalam respons:
ARCHIVE_SCHEDULED: masuk antrean untuk diarsipkan pada akhir siklus penagihanARCHIVED: sudah diarsipkan
Pembatalan: untuk membatalkan pengarsipan yang masih terjadwal sebelum siklus berakhir, panggil batalkan pengarsipan terjadwal dengan ID yang sama. Lokasi yang telah diarsipkan tidak dapat diperbarui hingga diaktifkan kembali.
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==" ] } }'