/api/v4/locations/cancel_archivePlanlanmış konum arşivlemesini iptal etme
ARCHIVE_SCHEDULED durumundaki konumlar için bekleyen arşivlemeyi iptal ederek konumları yeniden etkin hale getirir.
Parametreler
Gövde
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| input.locationIds | array of strings | zorunlu | Base64-encoded location node IDs whose scheduled archival should be cancelled. |
| input.clientMutationId | string | isteğe bağlı | Optional correlation token returned unchanged in the response. |
Örnek istek
Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.
{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==" ] }}Yanıtlar
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.
Şu anda, faturalandırma dönemi kapanmadan önce konumları arşivleme işleminin ayarladığı ARCHIVE_SCHEDULED durumunda bulunan konumlar için planlanmış arşivlemeyi iptal eder. Yalnızca hâlâ arşivlenmeyi bekleyen (henüz tamamen arşivlenmemiş) konumların arşivlemesi iptal edilebilir. İptal edildiğinde konum ACTIVE durumuna döner ve faturalandırma normal şekilde devam eder.
Kullanım senaryosu: yanlışlıkla alınan veya sonradan değiştirilen bir kararı geri alma. Kapatılması planlanan bir mağazanın kapanışı, fatura oluşturulmadan önce ertelenir. Mağazayı arşivleme kuyruğundan çıkarmak için base64 ID değerini buraya gönderin; yanıttaki result[], her konumun yeniden ACTIVE durumuna döndüğünü doğrular. Toplu işleme yönelik olduğundan, tek bir çağrıda birden fazla planlanmış arşivlemeyi iptal edebilir ve konum başına success bayraklarını okuyabilirsiniz.
Dikkat edilmesi gereken nokta: zamanlama ve uygunluk. Bu işlem yalnızca konum hâlâ ARCHIVE_SCHEDULED durumundayken çalışır. Faturalandırma dönemi kapandıktan sonra konum tamamen arşivlenir ve bu çağrı söz konusu konum için 404 döndürür; zaten arşivlenmiş bir konumu geri yüklemek için bunun yerine etkinleştirme/yeniden etkinleştirme akışını kullanın.
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==" ] } }'