Skip to content
ShopentlyLearn

Update a product

Update a product using Shopently API. Check required JSON fields, permissions and write requirements. Examples in cURL, PHP and Python.

PATCH/api/v1/products/{product_id}

Authentication
Bearer
Available from
STANDARD
Required permissions
catalog.product:update
Additional permissions for selected fields
  • When variant_value_ids is included: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • When variants_enabled is included: catalog.product_variant:update
Learn more

Code examples

Request example

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

Response example 200

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

How it works

  • The integration can read non-deleted products, including drafts, except products blocked by a plan limit.
  • Blocked products are excluded from lists; direct access returns entitlements.resource_blocked.
  • Product visibility in API therefore differs from storefront publication.
  • Use existing identifiers for brands, categories, features and media.
  • Prices carry an explicit currency, price list, tax mode and concurrency versions.
  • Product and variant pricing are distinct; use the supported pricing structure and exact decimal strings.

Parameters

Path parameters

product_idStringRequired

Product identifier.

Constraints
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Example: "example"

Query parameters

localeString nullOptional

Language selected for this request.

String:minLength: 2maxLength: 20
market_idString nullOptional

Market identifier returned by the context endpoint.

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

Market code returned by the context endpoint.

String:minLength: 1maxLength: 16

Request headers

Idempotency-KeyStringRequired

Unique identifier for one logical write operation.

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

Request body

application/json · Required

ProductUpdate
brand_idString nullOptional

Brand identifier.

String:minLength: 1maxLength: 63
conditionStringOptional

Product condition.

Constraints
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionString nullOptional

Description in the selected language.

String:maxLength: 100000
Example: null
expected_variant_price_versionsObjectAdditional fields: Integer
minimum: 0maximum: 9223372036854775807
Optional

Previously read price versions, keyed by variant identifier.

maxProperties: 250
Constraints
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionIntegerRequired

Version read before the write; a mismatch rejects the update.

minimum: 1maximum: 9223372036854775807
Example: 1
feature_value_idsArray <String> Optional

Identifiers of selected feature values.

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

Product identification codes.

market_idsArray <String> Optional

Identifiers of selected markets.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <String> Optional

Identifiers of already existing media assets.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionString nullOptional

Search-engine description in the selected language.

String:maxLength: 160
meta_keywordsArray <String> nullOptional

Search-engine keywords in the selected language.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleString nullOptional

Search-engine title in the selected language.

String:maxLength: 70
nameString nullOptional

Resource name in the relevant context.

String:maxLength: 300
Example: null
pricingProductPrice Optional

Price configuration and its concurrency versions.

Example: {"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 nullOptional

Primary category identifier.

String:minLength: 1maxLength: 63
publishedBooleanOptional

Whether the resource is published.

skuStringOptional

Stock keeping unit code.

minLength: 1maxLength: 100
Constraints
pattern
"^\\S+$"
Example: "example"
slugString nullOptional

URL path segment in the selected language.

String:maxLength: 160
tax_category_idString nullOptional

Tax category identifier.

String:minLength: 1maxLength: 63
variant_value_idsArray <String> Optional

Identifiers of selected variant values.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleanOptional

Whether the product uses variants.

Responses

Response 200

dataMutationData Required

Successful response payload.

Fields · data
deletedBooleanRequired

Whether the deletion was applied.

idStringRequired

Resource identifier; preserve it as returned.

versionInteger nullRequired

Resource version used for concurrency control.

metaContextPageMeta ContextMeta PageMeta RequestMeta Required

Response metadata.

Fields · meta

ContextPageMeta

localeStringRequired

Language selected for this request.

market_codeStringRequired

Market code returned by the context endpoint.

market_idStringRequired

Market identifier returned by the context endpoint.

paginationPagination Required

Cursor pagination metadata.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

ContextMeta

localeStringRequired

Language selected for this request.

market_codeStringRequired

Market code returned by the context endpoint.

market_idStringRequired

Market identifier returned by the context endpoint.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

PageMeta

paginationPagination Required

Cursor pagination metadata.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

RequestMeta

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Response example

HTTP status

200
Successful response Schema
400
Invalid request
401
Authentication required
403
Permission denied
404
Resource not found
409
Version conflict
422
Validation failed
429
Rate limit exceeded
Other HTTP statuses (7)
405
Method not allowed
413
Request too large
415
Unsupported media type
500
Server error
502
API gateway error
503
Service unavailable
504
Gateway timeout

Error catalog: ErrorResponse

Headers

401

WWW-AuthenticateStringOptional

Authentication scheme required by the server.

405

AllowStringOptional

HTTP methods supported by this resource.

429, 503

Retry-AfterIntegerOptional

Minimum delay before retrying, in seconds.

minimum: 0