Hoppa till innehållet
ShopentlyLearn

Uppdatera — Produkter

Ändra angivna data i ”Produkter”. Obligatoriska fält och skrivregler beskrivs nedan.

PATCH/api/v1/products/{product_id}

Autentisering
Bearer
Tillgänglig från
STANDARD
Behörigheter som krävs
catalog.product:update
Ytterligare behörigheter för valda fält
  • När variant_value_ids anges: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • När variants_enabled anges: catalog.product_variant:update
Läs mer

Kodexempel

Exempel på begäran

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

Exempel på svar 200

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

Så fungerar det

  • Integrationen kan läsa produkter som inte är borttagna, även utkast, med undantag för produkter som blockerats av abonnemangets gränser.
  • Blockerade produkter utelämnas från listor.
  • Direkt åtkomst returnerar entitlements.resource_blocked.
  • Produkters synlighet i API:et skiljer sig därför från publicering i butiken.
  • Använd befintliga identifierare för varumärken, kategorier, egenskaper och medier.
  • Priser har uttrycklig valuta, prislista, skattehantering och versioner för samtidighetskontroll.
  • Produktpriser och variantpriser är separata.
  • Använd den prisstruktur som stöds och exakta decimalsträngar.

Parametrar

Sökvägsparametrar

product_idSträngObligatoriskt

Produktens identifierare.

Begränsningar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exempel: "example"

Frågeparametrar

localeSträng nullValfritt

Språk valt för denna begäran.

Sträng:minLength: 2maxLength: 20
market_idSträng nullValfritt

Marknadsidentifierare returnerad av kontextendpointen.

Begränsningar · Sträng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeSträng nullValfritt

Marknadskod returnerad av kontextendpointen.

Sträng:minLength: 1maxLength: 16

Begärandehuvuden

Idempotency-KeySträngObligatoriskt

Unik identifierare för en logisk skrivoperation.

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

Begärans innehåll

application/json · Obligatoriskt

ProductUpdate
brand_idSträng nullValfritt

Varumärkets identifierare.

Sträng:minLength: 1maxLength: 63
conditionSträngValfritt

Produktens skick.

Begränsningar
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionSträng nullValfritt

Beskrivning på valt språk.

Sträng:maxLength: 100000
Exempel: null
expected_variant_price_versionsObjektYtterligare fält: Heltal
minimum: 0maximum: 9223372036854775807
Valfritt

Tidigare lästa prisversioner, kopplade till variantidentifierare.

maxProperties: 250
Begränsningar
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
feature_value_idsArray <Sträng> Valfritt

Identifierare för valda egenskapsvärden.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullValfritt

Produktens identifieringskoder.

market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
nameSträng nullValfritt

Resursens namn i aktuell kontext.

Sträng:maxLength: 300
Exempel: null
pricingProductPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

Exempel: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idSträng nullValfritt

Huvudkategorins identifierare.

Sträng:minLength: 1maxLength: 63
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

skuSträngValfritt

Artikelns SKU-kod.

minLength: 1maxLength: 100
Begränsningar
pattern
"^\\S+$"
Exempel: "example"
slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
tax_category_idSträng nullValfritt

Skattekategorins identifierare.

Sträng:minLength: 1maxLength: 63
variant_value_idsArray <Sträng> Valfritt

Identifierare för valda variantvärden.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleskt värdeValfritt

Anger om produkten använder varianter.

Svar

Svar 200

dataMutationData Obligatoriskt

Innehållet i ett lyckat svar.

Fält · data
deletedBooleskt värdeObligatoriskt

Anger om borttagningen utfördes.

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

versionHeltal nullObligatoriskt

Resursversion för samtidighetskontroll.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Fält · meta

ContextPageMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

ContextMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

RequestMeta

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel på svar

HTTP-status

200
Lyckat svar Schema
400
Ogiltig begäran
401
Autentisering krävs
403
Åtkomst nekad
404
Resursen hittades inte
409
Versionskonflikt
422
Valideringen misslyckades
429
Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405
Metoden tillåts inte
413
För stor begäran
415
Formatet stöds inte
500
Serverfel
502
Fel i API-gateway
503
Tjänsten är inte tillgänglig
504
Tidsgränsen överskreds

Felkatalog: ErrorResponse

HTTP-huvuden

401

WWW-AuthenticateSträngValfritt

Autentiseringsschema som servern kräver.

405

AllowSträngValfritt

HTTP-metoder som resursen stöder.

429, 503

Retry-AfterHeltalValfritt

Minsta väntetid före ett nytt försök, i sekunder.

minimum: 0