Přejít na obsah
ShopentlyLearn

Upravit — Produkty

Změňte zadaná data v „Produkty“. Povinná pole a pravidla zápisu jsou popsána níže.

PATCH/api/v1/products/{product_id}

Ověřování
Bearer
Dostupné od tarifu
STANDARD
Požadovaná oprávnění
catalog.product:update
Další oprávnění pro vybraná pole
  • Pokud je uvedeno variant_value_ids: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • Pokud je uvedeno variants_enabled: catalog.product_variant:update
Další informace

Příklady kódu

Příklad požadavku

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_product_api_v1_products__product_id__patch' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "sku": "example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/products/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_product_api_v1_products__product_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products/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_product_api_v1_products__product_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', 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))

Příklad odpovědi 200

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

Jak to funguje

  • Integrace může číst nesmazané produkty včetně konceptů, kromě produktů blokovaných limitem tarifu.
  • Blokované produkty nejsou v seznamech; přímý přístup vrací entitlements.resource_blocked.
  • Viditelnost produktu v API se proto liší od jeho zveřejnění v obchodě.
  • Používejte existující identifikátory značek, kategorií, vlastností a médií.
  • Ceny obsahují výslovně určenou měnu, ceník, daňový režim a verze pro řízení souběžných změn.
  • Ceny produktů a variant se rozlišují; používejte podporovanou strukturu cen a přesné desetinné řetězce.

Parametry

Parametry cesty

product_idŘetězecPovinné

Identifikátor produktu.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

Parametry dotazu

localeŘetězec nullVolitelné

Jazyk vybraný pro tento požadavek.

Řetězec:minLength: 2maxLength: 20
market_idŘetězec nullVolitelné

Identifikátor trhu vrácený koncovým bodem kontextu.

Omezení · Řetězec 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeŘetězec nullVolitelné

Kód trhu vrácený koncovým bodem kontextu.

Řetězec:minLength: 1maxLength: 16

Hlavičky požadavku

Idempotency-KeyŘetězecPovinné

Jedinečný identifikátor jedné logické operace zápisu.

minLength: 1maxLength: 128
Omezení
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Příklad: "example-update_product_api_v1_products__product_id__patch"

Tělo požadavku

application/json · Povinné

ProductUpdate
brand_idŘetězec nullVolitelné

Identifikátor značky.

Řetězec:minLength: 1maxLength: 63
conditionŘetězecVolitelné

Stav produktu.

Omezení
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionŘetězec nullVolitelné

Popis ve vybraném jazyce.

Řetězec:maxLength: 100000
Příklad: null
expected_variant_price_versionsObjektDalší pole: Celé číslo
minimum: 0maximum: 9223372036854775807
Volitelné

Dříve načtené verze cen s identifikátory variant jako klíči.

maxProperties: 250
Omezení
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
Příklad: 1
feature_value_idsPole <Řetězec> Volitelné

Identifikátory vybraných hodnot vlastností.

maxItems: 1000
Pole:minLength: 1maxLength: 63
identifiersProductIdentifiers nullVolitelné

Identifikační kódy produktu.

market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000
Pole:minLength: 1maxLength: 63
media_idsPole <Řetězec> Volitelné

Identifikátory již existujících mediálních souborů.

maxItems: 20
Pole:minLength: 1maxLength: 63
meta_descriptionŘetězec nullVolitelné

Popis pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 160
meta_keywordsPole <Řetězec> nullVolitelné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Pole:maxItems: 20
Pole / Pole:maxLength: 50
meta_titleŘetězec nullVolitelné

Titulek pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 70
nameŘetězec nullVolitelné

Název zdroje v příslušném kontextu.

Řetězec:maxLength: 300
Příklad: null
pricingProductPrice Volitelné

Nastavení cen a jejich verze pro řízení souběžných změn.

Příklad: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idŘetězec nullVolitelné

Identifikátor hlavní kategorie.

Řetězec:minLength: 1maxLength: 63
publishedLogická hodnotaVolitelné

Zda je zdroj zveřejněn.

skuŘetězecVolitelné

Skladový kód položky.

minLength: 1maxLength: 100
Omezení
pattern
"^\\S+$"
Příklad: "example"
slugŘetězec nullVolitelné

Úsek cesty URL ve vybraném jazyce.

Řetězec:maxLength: 160
tax_category_idŘetězec nullVolitelné

Identifikátor daňové kategorie.

Řetězec:minLength: 1maxLength: 63
variant_value_idsPole <Řetězec> Volitelné

Identifikátory vybraných hodnot variant.

maxItems: 250
Pole:minLength: 1maxLength: 63
variants_enabledLogická hodnotaVolitelné

Zda produkt používá varianty.

Odpovědi

Odpověď 200

dataMutationData Povinné

Obsah úspěšné odpovědi.

Pole · data
deletedLogická hodnotaPovinné

Zda bylo smazání provedeno.

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

versionCelé číslo nullPovinné

Verze zdroje používaná k řízení souběžných změn.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Pole · meta

ContextPageMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

ContextMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0