Saltar para o conteúdo
ShopentlyLearn

Atualizar — Produtos

Altere os dados indicados em «Produtos». Os campos obrigatórios e as regras de escrita estão descritos abaixo.

PATCH/api/v1/products/{product_id}

Autenticação
Bearer
Disponível a partir de
STANDARD
Permissões necessárias
catalog.product:update
Permissões adicionais para determinados campos
  • Quando variant_value_ids está presente: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • Quando variants_enabled está presente: catalog.product_variant:update
Saber mais

Exemplos de código

Exemplo de requisição

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

Exemplo de resposta 200

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

Como funciona

  • A integração pode ler produtos não eliminados, incluindo rascunhos, exceto os bloqueados por um limite do plano.
  • Produtos bloqueados são omitidos das listas; o acesso direto retorna entitlements.resource_blocked.
  • Assim, a visibilidade na API difere da publicação na loja.
  • Use identificadores existentes de marcas, categorias, características e ficheiros de multimédia.
  • Os preços incluem moeda, lista de preços, tratamento fiscal e versões explícitas de concorrência.
  • Preços de produtos e variantes são distintos; use a estrutura de preços aceita e textos decimais exatos.

Parâmetros

Parâmetros do caminho

product_idTextoObrigatório

Identificador do produto.

Restrições
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemplo: "example"

Parâmetros de consulta

localeTexto nullOpcional

Idioma selecionado para esta requisição.

Texto:minLength: 2maxLength: 20
market_idTexto nullOpcional

Identificador do mercado retornado pelo endpoint de contexto.

Restrições · Texto 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeTexto nullOpcional

Código do mercado retornado pelo endpoint de contexto.

Texto:minLength: 1maxLength: 16

Cabeçalhos do pedido

Idempotency-KeyTextoObrigatório

Identificador único de uma operação lógica de escrita.

minLength: 1maxLength: 128
Restrições
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Exemplo: "example-update_product_api_v1_products__product_id__patch"

Corpo da requisição

application/json · Obrigatório

ProductUpdate
brand_idTexto nullOpcional

Identificador da marca.

Texto:minLength: 1maxLength: 63
conditionTextoOpcional

Condição do produto.

Restrições
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTexto nullOpcional

Descrição no idioma selecionado.

Texto:maxLength: 100000
Exemplo: null
expected_variant_price_versionsObjetoCampos adicionais: Número inteiro
minimum: 0maximum: 9223372036854775807
Opcional

Versões de preços lidas anteriormente, indexadas pelo identificador da variante.

maxProperties: 250
Restrições
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807
Exemplo: 1
feature_value_idsLista <Texto> Opcional

Identificadores dos valores de características selecionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
identifiersProductIdentifiers nullOpcional

Códigos de identificação do produto.

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
media_idsLista <Texto> Opcional

Identificadores de ficheiros de multimédia já existentes.

maxItems: 20
Lista:minLength: 1maxLength: 63
meta_descriptionTexto nullOpcional

Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160
meta_keywordsLista <Texto> nullOpcional

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleTexto nullOpcional

Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70
nameTexto nullOpcional

Nome do recurso no contexto correspondente.

Texto:maxLength: 300
Exemplo: null
pricingProductPrice Opcional

Configuração de preços e versões para controlo de concorrência.

Exemplo: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idTexto nullOpcional

Identificador da categoria principal.

Texto:minLength: 1maxLength: 63
publishedBooleanoOpcional

Indica se o recurso está publicado.

skuTextoOpcional

Código da unidade de manutenção de stock.

minLength: 1maxLength: 100
Restrições
pattern
"^\\S+$"
Exemplo: "example"
slugTexto nullOpcional

Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160
tax_category_idTexto nullOpcional

Identificador da categoria fiscal.

Texto:minLength: 1maxLength: 63
variant_value_idsLista <Texto> Opcional

Identificadores dos valores de variantes selecionados.

maxItems: 250
Lista:minLength: 1maxLength: 63
variants_enabledBooleanoOpcional

Indica se o produto utiliza variantes.

Respostas

Resposta 200

dataMutationData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Campos · data
deletedBooleanoObrigatório

Indica se a eliminação foi aplicada.

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

versionNúmero inteiro nullObrigatório

Versão do recurso utilizada para controlo de concorrência.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

Campos · meta

ContextPageMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Pedido inválido
401
Autenticação necessária
403
Permissão negada
404
Recurso não encontrado
409
Conflito de versão
422
Falha na validação
429
Limite de pedidos excedido
Outros estados HTTP (7)
405
Método não permitido
413
Pedido demasiado grande
415
Formato não suportado
500
Erro do servidor
502
Erro do gateway da API
503
Serviço indisponível
504
Tempo de espera excedido

Catálogo de erros: ErrorResponse

Cabeçalhos

401

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0