Sil — Ürünler
“Ürünler” içindeki belirtilen öğeyi silin. Bu işlemin gereksinimleri aşağıda açıklanmıştır.
DELETE/api/v1/products/{product_id}
- Kimlik doğrulama
Bearer- En düşük plan
- STANDARD
- Gerekli izinler
catalog.product:delete
Kod örnekleri
İstek örneği
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request DELETE \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-delete_product_api_v1_products__product_id__delete' \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/products/example?expected_version=1'
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = ['Idempotency-Key: example-delete_product_api_v1_products__product_id__delete'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products/example?expected_version=1');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {'Idempotency-Key': 'example-delete_product_api_v1_products__product_id__delete'}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'DELETE', base_url + '/api/v1/products/example?expected_version=1', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
Yanıt örneği 200
{
"data": {
"deleted": true,
"id": "example",
"version": null
},
"meta": {
"request_id": "example"
}
}
Nasıl çalışır
- Entegrasyon, plan sınırı nedeniyle engellenenler dışında silinmemiş tüm ürünleri, taslaklar dâhil okuyabilir.
- Engellenen ürünler listelere alınmaz; doğrudan erişim entitlements.resource_blocked döndürür.
- Bu nedenle bir ürünün API'de görünmesi, vitrinde yayımlanmış olmasıyla aynı değildir.
- Markalar, kategoriler, özellikler ve medya için mevcut tanımlayıcıları kullanın.
- Fiyatlarda para birimi, fiyat listesi, vergi modu ve eşzamanlılık sürümleri açıkça belirtilir.
- Ürün ve varyant fiyatlandırması ayrıdır; desteklenen fiyat yapısını ve kesin ondalık dizeleri kullanın.
Parametreler
Yol parametreleri
product_idDizeZorunluÜrün tanımlayıcısı.
Kısıtlamalar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Sorgu parametreleri
expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807
İstek başlıkları
Idempotency-KeyDizeZorunluTek bir mantıksal yazma işleminin benzersiz tanımlayıcısı.
minLength:1maxLength:128Kısıtlamalar
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Bu işlem JSON gövdesi kabul etmez.
Yanıtlar
Yanıt 200
Tam model: ApiResponse_MutationData_
dataMutationDataZorunluBaşarılı yanıtın verileri.
Alanlar ·
datadeletedMantıksal değerZorunluSilme işleminin uygulanıp uygulanmadığı.
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
versionTam sayı nullZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
Alanlar ·
metalocaleDizeZorunluBu istek için seçilen dil.
market_codeDizeZorunluBağlam uç noktasının döndürdüğü pazar kodu.
market_idDizeZorunluBağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
paginationPaginationZorunluİmleç tabanlı sayfalamanın üst verileri.
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
localeDizeZorunluBu istek için seçilen dil.
market_codeDizeZorunluBağlam uç noktasının döndürdüğü pazar kodu.
market_idDizeZorunluBağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
paginationPaginationZorunluİmleç tabanlı sayfalamanın üst verileri.
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
HTTP durumu
200- Başarılı yanıt Şema
400- Geçersiz istek
401- Kimlik doğrulaması gerekli
403- İzin reddedildi
404- Kaynak bulunamadı
409- Sürüm çakışması
422- Doğrulama başarısız
429- İstek sınırı aşıldı
Diğer HTTP durumları (7)
405- Yönteme izin verilmiyor
413- İstek çok büyük
415- Desteklenmeyen biçim
500- Sunucu hatası
502- API ağ geçidi hatası
503- Hizmet kullanılamıyor
504- Zaman aşımı
Hata kataloğu: ErrorResponse
Başlıklar
401
WWW-AuthenticateDizeİsteğe bağlıSunucunun gerektirdiği kimlik doğrulama şeması.
405
AllowDizeİsteğe bağlıBu kaynağın desteklediği HTTP yöntemleri.
429, 503
Retry-AfterTam sayıİsteğe bağlıYeniden denemeden önce saniye cinsinden en kısa bekleme süresi.
minimum:0