Listings APIListings API
Oturum aç
POST/api/v4/locations/archive

Konumları arşivleme

Bir veya daha fazla konumun geçerli faturalandırma döneminin sonunda arşivlenmesini planlar.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Gövde

AdTürZorunluAçıklama
input.locationIdsarray of stringszorunluBase64-encoded location node IDs to archive.
input.clientMutationIdstringisteğe bağlı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.

Örnek istek

Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.

Request body
{  "input": {    "locationIds": [      "TG9jYXRpb246MTgwMDI4OQ==",      "TG9jYXRpb246MTgwMDI5MA=="    ]  }}

Yanıtlar

200Locations scheduled for archival. Returns per-location status.
Response
{  "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.

Bir veya daha fazla konumu arşivler. Arşivleme hemen gerçekleşmez: her konum ARCHIVE_SCHEDULED durumuna alınır ve geçerli faturalandırma döneminin sonuna kadar yayında kalır. Bir sonraki fatura oluşturulduğunda konum tamamen arşivlenir ve konum için faturalandırma durur.

Kullanım senaryosu: kapanan şubeleri dönem sonunda sistemden çıkarma. Bir franchise birkaç mağazasını kalıcı olarak kapattığında, faturalandırmanın dönem ortasında değil, bir sonraki faturada sona ermesi için mağazaların base64 kimliklerini tek bir çağrıda gönderin. Yanıttaki result[] alanını inceleyin: her öğe, ilgili konuma ait status değerini ve success bayrağını bildirir; böylece kısmi bir hata (tek bir geçersiz kimlik), toplu işlemin geri kalanını engellemez.

Yanıttaki durum değerleri:

  • ARCHIVE_SCHEDULED: faturalandırma döneminin sonunda arşivlenmek üzere sıraya alındı
  • ARCHIVED: zaten arşivlenmiş

Geri alma: henüz planlanmış durumda olan bir arşivleme işlemini dönem kapanmadan geri almak için aynı kimliklerle planlanmış arşivlemeyi iptal etme çağrısını yapın. Arşivlenmiş konumlar yeniden etkinleştirilene kadar güncellenemez.

Request
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=="      ]    }  }'
Run in playground