/api/v4/locations/cancel_archiveإلغاء الأرشفة المجدولة للمواقع
يلغي الأرشفة المعلّقة للمواقع التي تكون في الحالة ARCHIVE_SCHEDULED، ويعيدها إلى الحالة النشطة.
المعلمات
النص الأساسي
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| input.locationIds | array of strings | مطلوب | Base64-encoded location node IDs whose scheduled archival should be cancelled. |
| input.clientMutationId | string | اختياري | Optional correlation token returned unchanged in the response. |
مثال على الطلب
نص جاهز للصق. استبدل المعرّفات والقيم النموذجية بقيمك.
{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==" ] }}الاستجابات
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.
يلغي الأرشفة المجدولة للمواقع الموجودة حاليًا في الحالة ARCHIVE_SCHEDULED، وهي الحالة التي تُعيَّن بواسطة أرشفة المواقع قبل إغلاق دورة الفوترة. لا يمكن إلغاء الأرشفة إلا للمواقع التي لا تزال تنتظر الأرشفة (ولم تُؤرشف بالكامل بعد). بمجرد إلغاء الأرشفة، يعود الموقع إلى الحالة ACTIVE وتستمر الفوترة كالمعتاد.
حالة استخدام: التراجع عن قرار اتُّخذ بالخطأ أو عُدل عنه. يحصل متجر كان من المقرر إغلاقه على مهلة قبل إصدار الفاتورة. أرسل معرّفه بصيغة base64 هنا لإزالته من قائمة انتظار الأرشفة؛ وتؤكد result[] في الاستجابة أن كل موقع قد عاد إلى الحالة ACTIVE. ولأن هذه العملية تدعم المعالجة على دفعات، يمكنك إلغاء عدة عمليات أرشفة مجدولة في استدعاء واحد وقراءة علامة success لكل موقع.
تنبيه: التوقيت والأهلية. لا تعمل هذه العملية إلا إذا كان الموقع لا يزال في الحالة ARCHIVE_SCHEDULED. بعد إغلاق دورة الفوترة، يُؤرشف الموقع بالكامل ويُرجع هذا الاستدعاء 404 لهذا الموقع؛ استخدم مسار التفعيل/إعادة التفعيل لاستعادة موقع مؤرشف بالفعل بدلًا من ذلك.
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==" ] } }'