/api/v4/locations/archiveأرشفة المواقع
يجدول أرشفة موقع واحد أو أكثر في نهاية دورة الفوترة الحالية.
المعلمات
النص الأساسي
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| 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. |
مثال على الطلب
نص جاهز للصق. استبدل المعرّفات والقيم النموذجية بقيمك.
{ "input": { "locationIds": [ "TG9jYXRpb246MTgwMDI4OQ==", "TG9jYXRpb246MTgwMDI5MA==" ] }}الاستجابات
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.
يؤرشف موقعًا واحدًا أو أكثر. الأرشفة ليست فورية: يُنقل كل موقع إلى الحالة ARCHIVE_SCHEDULED ويظل نشطًا حتى نهاية دورة الفوترة الحالية. عند إصدار الفاتورة التالية، يُؤرشف الموقع بالكامل وتتوقف فوترته.
حالة الاستخدام: إيقاف خدمة الفروع المغلقة في نهاية الدورة. عندما تُغلق سلسلة تعمل بنظام الامتياز التجاري عدة متاجر نهائيًا، أرسل معرّفاتها المرمّزة بصيغة base64 في استدعاء واحد كي تتوقف الفوترة عند إصدار الفاتورة التالية بدلًا من منتصف الدورة. افحص result[] في الاستجابة: يعرض كل عنصر status وعلامة success لذلك الموقع تحديدًا، لذا فإن الفشل الجزئي (معرّف واحد غير صالح) لا يمنع معالجة بقية الدفعة.
قيم الحالة في الاستجابة:
ARCHIVE_SCHEDULED: في قائمة انتظار الأرشفة في نهاية دورة الفوترةARCHIVED: مؤرشف بالفعل
التراجع: لإلغاء أرشفة لا تزال مجدولة قبل انتهاء الدورة، استدعِ إلغاء الأرشفة المجدولة باستخدام المعرّفات نفسها. لا يمكن تحديث المواقع المؤرشفة حتى يُعاد تفعيلها.
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==" ] } }'