Mine sisu juurde
ShopentlyLearn

Muuda — Tooted

Muutke määratud andmeid ressursis „Tooted“. Nõutavad väljad ja kirjutamisreeglid on kirjeldatud allpool.

PATCH/api/v1/products/{product_id}

Autentimine
Bearer
Saadaval alates
STANDARD
Nõutavad õigused
catalog.product:update
Valitud väljade lisaõigused
  • Kui variant_value_ids on esitatud: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • Kui variants_enabled on esitatud: catalog.product_variant:update
Lisateave

Koodinäited

Päringu näide

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))

Vastuse näide 200

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

Kuidas see toimib

  • Integratsioon saab lugeda kustutamata tooteid, sealhulgas mustandeid, välja arvatud paketi piiranguga blokeeritud tooted.
  • Blokeeritud tooted jäetakse loenditest välja; otsepäring tagastab entitlements.resource_blocked.
  • Seega erineb toote nähtavus API-s selle avaldamisest poes.
  • Kasuta brändide, kategooriate, omaduste ja meedia olemasolevaid identifikaatoreid.
  • Hinnad sisaldavad selgesõnalist valuutat, hinnakirja, maksurežiimi ja samaaegsuse kontrolli versioone.
  • Toote ja variandi hinnastamine on eraldi; kasuta toetatud hinnastruktuuri ja täpseid kümnendarvustringe.

Parameetrid

Tee parameetrid

product_idStringKohustuslik

Toote identifikaator.

Piirangud
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Näide: "example"

Päringu parameetrid

localeString nullValikuline

Selle päringu jaoks valitud keel.

String:minLength: 2maxLength: 20
market_idString nullValikuline

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Piirangud · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeString nullValikuline

Konteksti lõpp-punkti tagastatud turukood.

String:minLength: 1maxLength: 16

Päringu päised

Idempotency-KeyStringKohustuslik

Ühe loogilise muutmistoimingu kordumatu identifikaator.

minLength: 1maxLength: 128
Piirangud
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Näide: "example-update_product_api_v1_products__product_id__patch"

Päringu sisu

application/json · Kohustuslik

ProductUpdate
brand_idString nullValikuline

Brändi identifikaator.

String:minLength: 1maxLength: 63
conditionStringValikuline

Toote seisukord.

Piirangud
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionString nullValikuline

Kirjeldus valitud keeles.

String:maxLength: 100000
Näide: null
expected_variant_price_versionsObjektLisaväljad: Täisarv
minimum: 0maximum: 9223372036854775807
Valikuline

Varem loetud hinnaversioonid variandi identifikaatori järgi.

maxProperties: 250
Piirangud
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807
Näide: 1
feature_value_idsMassiiv <String> Valikuline

Valitud omaduseväärtuste identifikaatorid.

maxItems: 1000
Massiiv:minLength: 1maxLength: 63
identifiersProductIdentifiers nullValikuline

Toote tuvastuskoodid.

market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000
Massiiv:minLength: 1maxLength: 63
media_idsMassiiv <String> Valikuline

Olemasolevate meediafailide identifikaatorid.

maxItems: 20
Massiiv:minLength: 1maxLength: 63
meta_descriptionString nullValikuline

Otsingumootori kirjeldus valitud keeles.

String:maxLength: 160
meta_keywordsMassiiv <String> nullValikuline

Otsingumootori märksõnad valitud keeles.

Massiiv:maxItems: 20
Massiiv / Massiiv:maxLength: 50
meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70
nameString nullValikuline

Ressursi nimi vastavas kontekstis.

String:maxLength: 300
Näide: null
pricingProductPrice Valikuline

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid.

Näide: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idString nullValikuline

Põhikategooria identifikaator.

String:minLength: 1maxLength: 63
publishedTõeväärtusValikuline

Kas ressurss on avaldatud.

skuStringValikuline

Laoarvestusühiku kood.

minLength: 1maxLength: 100
Piirangud
pattern
"^\\S+$"
Näide: "example"
slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160
tax_category_idString nullValikuline

Maksukategooria identifikaator.

String:minLength: 1maxLength: 63
variant_value_idsMassiiv <String> Valikuline

Valitud variandiväärtuste identifikaatorid.

maxItems: 250
Massiiv:minLength: 1maxLength: 63
variants_enabledTõeväärtusValikuline

Kas toode kasutab variante.

Vastused

Vastus 200

dataMutationData Kohustuslik

Eduka vastuse andmed.

Väljad · data
deletedTõeväärtusKohustuslik

Kas kustutamine rakendati.

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

versionTäisarv nullKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

Väljad · meta

ContextPageMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

ContextMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

PageMeta

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

RequestMeta

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Vastuse näide

HTTP-olek

200
Edukas vastus Skeem
400
Vigane päring
401
Autentimine on nõutav
403
Juurdepääs keelatud
404
Ressurssi ei leitud
409
Versioonikonflikt
422
Valideerimine nurjus
429
Päringupiirang ületatud
Muud HTTP olekud (7)
405
Meetod pole lubatud
413
Päring on liiga suur
415
Vormingut ei toetata
500
Serveri viga
502
API lüüsi viga
503
Teenus pole saadaval
504
Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

401

WWW-AuthenticateStringValikuline

Serveri nõutav autentimisskeem.

405

AllowStringValikuline

Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline

Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0