İçeriğe atla
ShopentlyLearn

Güncelle · Ürün varyantları — Varyantlar ve seçenekler

“Varyantlar ve seçenekler” içindeki belirtilen verileri değiştirin. Zorunlu alanlar ve yazma kuralları aşağıda açıklanmıştır.

PATCH/api/v1/products/{product_id}/variants/{variant_id}

Kimlik doğrulama
Bearer
En düşük plan
STANDARD
Gerekli izinler
catalog.product_variant:update

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 PATCH \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: example-update_variant_api_v1_products__product_id__variants__variant_id__patch' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "sku": "example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/products/example/variants/example

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-update_variant_api_v1_products__product_id__variants__variant_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products/example/variants/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
  "expected_version": 1,
  "sku": "example"
}');
$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-update_variant_api_v1_products__product_id__variants__variant_id__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 1,\n  "sku": "example"\n}'
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(
        'PATCH', base_url + '/api/v1/products/example/variants/example', 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

JSON
{
  "data": {
    "deleted": false,
    "id": "example",
    "version": 1
  },
  "meta": {
    "request_id": "example"
  }
}

Nasıl çalışır

  • Bir varyant bir ürüne aittir ve varyant seçeneği sözlüklerindeki değerleri kullanır.
  • Başvuru, seçenek ve değer CRUD işlemlerinin yanı sıra ürün varyantı okuma ve yazma işlemlerini de içerir.
  • Varyant fiyatı değişiklikleri için fiyatlandırma türü, tutar, para birimi ve gerekli sürümler açıkça belirtilir.
  • Temel fiyata uygulanan düzeltmeyle sabit pazar fiyatını birbirinden ayırın.
  • Bağımlı bir güncelleme göndermeden önce ürünün ve fiyatın güncel durumunu okuyun.

Parametreler

Yol parametreleri

product_idDizeZorunlu

Ürün tanımlayıcısı.

Kısıtlamalar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "example"
variant_idDizeZorunlu

Ürün varyantı tanımlayıcısı.

Kısıtlamalar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "example"

Sorgu parametreleri

localeDize nullİsteğe bağlı

Bu istek için seçilen dil.

Dize:minLength: 2maxLength: 20
market_idDize nullİsteğe bağlı

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Kısıtlamalar · Dize 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeDize nullİsteğe bağlı

Bağlam uç noktasının döndürdüğü pazar kodu.

Dize:minLength: 1maxLength: 16

İstek başlıkları

Idempotency-KeyDizeZorunlu

Tek bir mantıksal yazma işleminin benzersiz tanımlayıcısı.

minLength: 1maxLength: 128
Kısıtlamalar
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Örnek: "example-update_variant_api_v1_products__product_id__variants__variant_id__patch"

İstek gövdesi

application/json · Zorunlu

VariantUpdate
activeMantıksal değerİsteğe bağlı

Kaynağın etkin olup olmadığı.

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807
Örnek: 1
is_defaultMantıksal değerİsteğe bağlı

Bu seçeneğin varsayılan olup olmadığı.

media_idsDizi <Dize> İsteğe bağlı

Mevcut medya dosyalarının tanımlayıcıları.

maxItems: 20
Dizi:minLength: 1maxLength: 63
pricingVariantPrice İsteğe bağlı

Fiyat yapılandırması ve eşzamanlılık sürümleri.

Örnek: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}
skuDizeİsteğe bağlı

Stok tutma birimi kodu.

minLength: 1maxLength: 100
Kısıtlamalar
pattern
"^\\S+$"
Örnek: "example"

Yanıtlar

Yanıt 200

dataMutationData Zorunlu

Başarılı yanıtın verileri.

Alanlar · data
deletedMantıksal değerZorunlu

Silme işleminin uygulanıp uygulanmadığı.

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.

versionTam sayı nullZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Alanlar · meta

ContextPageMeta

localeDizeZorunlu

Bu istek için seçilen dil.

market_codeDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar kodu.

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

ContextMeta

localeDizeZorunlu

Bu istek için seçilen dil.

market_codeDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar kodu.

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

PageMeta

paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

RequestMeta

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100
Yanıt örneği

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