Ürünler
Kategoriyi arşivle
POST/v1/categories/{id}/archive
Kategoriyi vitrinden kaldırın; ürün bağları silinmez.
- Gereken izin
Bearer anahtarı ve
archive:write,products:write- Maliyet
0 puan (bağlantı başına 60 saniyede 600 puan)
- Tekrar anahtarı
Gerekir:
Idempotency-Keybaşlığı.
İstek
Temel adres: https://api.siparis.app/v1
Yol parametreleri
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın cat_ önekli dış kimliği. | "cat_1234567890abcdef1234567890abcdef" |
Başlıklar
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
Idempotency-Key | metin · null olabilir | Evet | Zorunlu tekrar anahtarı; en çok 200 karakter. Yeni işte yeni değer; ağ tekrarında aynı gövde ve aynı değer. | "ilk-esitleme-20261016-001" |
If-Match | metin · null olabilir | Hayır | İsteğe bağlı önkoşul: son ETag değerini çift tırnaklarıyla gönderin. Komutun kilidi altında farklıysa 412 revision_mismatch. | "\"3\"" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|
Örnek istek
curl --fail-with-body --silent --show-error --request POST \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/categories/cat_1234567890abcdef1234567890abcdef/archive" \
-H "Authorization: Bearer $SIPARIS_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: ornek-post-v1-categories-cat-1234567890abcdef1234567890abcdef-archive-001' \
--data-binary @- <<'JSON'
{}
JSONimport json
import os
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError
# İmzalı indirme hedefine Bearer taşımamak için yönlendirme kendiliğinden izlenmez.
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
base = os.environ.get("SIPARIS_API_URL", "https://api.siparis.app/v1")
headers = {
"Authorization": "Bearer " + os.environ["SIPARIS_API_KEY"],
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-categories-cat-1234567890abcdef1234567890abcdef-archive-001",
}
request = Request(base + "/categories/cat_1234567890abcdef1234567890abcdef/archive", headers=headers, method="POST",
data="{}".encode("utf-8"))
try:
with build_opener(NoRedirect).open(request, timeout=30) as response:
print(response.read().decode("utf-8"))
except HTTPError as error:
print(error.code, error.read().decode("utf-8"))
raise
// Node.js 22+; anahtar yalnız sunucunun ortam değişkenindedir.
const base = process.env.SIPARIS_API_URL ?? "https://api.siparis.app/v1";
if (!process.env.SIPARIS_API_KEY) throw new Error("SIPARIS_API_KEY gerekli");
const response = await fetch(base + "/categories/cat_1234567890abcdef1234567890abcdef/archive", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-categories-cat-1234567890abcdef1234567890abcdef-archive-001",
},
redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
signal: AbortSignal.timeout(30_000),
body: JSON.stringify({}),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);
Kimlik içeren yollarda örnek kimliği kendi liste yanıtınızdan alın. SIPARIS_API_KEY sunucu ortamında tanımlı olmalı; yerelde SIPARIS_API_URL ile /v1 içeren adresi değiştirin. Üretimde tekrar kurallarını uygulayın.
Yanıt
200 İstek başarıyla tamamlandı.
İçerik türü: application/json
{
"archived": false,
"created_at": "2026-10-16T09:00:00Z",
"description": "Seramik kupa, 300 ml.",
"id": "cat_1234567890abcdef1234567890abcdef",
"image": "https://example.com/kupa.jpg",
"name": "Mutfak",
"parent": null,
"revision": 1,
"slug": "ornek-kupa",
"sort_order": 0,
"status": "active",
"updated_at": "2026-10-16T09:00:00Z"
}Yanıt alanları (12)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
archived | true/false | Evet | Arşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir. | false |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
description | metin · null olabilir | Evet | Kaynağın açıklama metni. | "Seramik kupa, 300 ml." |
id | metin | Evet | Kaynağın dış kimliği; cat_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "cat_1234567890abcdef1234567890abcdef" |
image | metin · null olabilir | Evet | Görselin genel HTTPS adresi. | "https://example.com/kupa.jpg" |
name | metin | Evet | Kaydın görünen adı. | "Mutfak" |
parent | metin · null olabilir | Evet | Üst kategori kimliği (cat_ ve 32 küçük onaltılık karakter). | null |
revision | tam sayı | Evet | Kaydın revizyonu; If-Match için ETag ile birlikte kullanılır. | 1 |
slug | metin · null olabilir | Evet | Adreslerde kullanılan kısa ad. | "ornek-kupa" |
sort_order | tam sayı | Evet | Panel ve vitrindeki sırası; küçük değer önce gelir. | 0 |
status | metin | Evet | Kaynağın işlem durumu. | "active" |
updated_at | tarih-saat | Evet | Son değişiklik zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
Bu uca özgü yanıt başlıkları: ETag (Kaynağın güçlü sürüm etiketi; If-Match için tırnaklarıyla saklayın.).
Hatalar
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 403 | forbidden | Mevcut ticari kural bu işlemi yapmanıza izin vermiyor. | Gerekli kapsamları ve siparişin durumunu kontrol edin. |
| 400 | invalid_if_match | If-Match geçerli bir güçlü ETag değil. | GET kaynak yanıtındaki ETag değerini çift tırnaklarıyla aynen kullanın. |
| 412 | revision_mismatch | Kayıt siz okuduktan sonra değişmiş. | Güncel kaydı okuyun; düzeltmeyi yeniden değerlendirip yeni tekrar anahtarıyla gönderin. |
| 403 | business_scope_required | Bu kayıt işletme genelindedir. | Bütün markalara yetkili bağlantı kullanın. |
| 422 | category_cycle | Kategori kendisinin veya alt kategorisinin altına taşınamaz. | Başka üst kategori seçin; yeni tekrar anahtarı kullanın. |
| 409 | taxonomy_name_conflict | Aynı anda bu addan başka kayıt açıldı. | Güncel listeyi okuyun; yeni tekrar anahtarıyla yeniden deneyin. |
| 409 | taxonomy_restore_conflict | Kayıt arşivden geri getirilemedi. | Güncel arşiv durumunu kontrol edin. |
Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.