Saltar para o conteúdo
ShopentlyLearn

Atualizar · Valores das opções — Variantes e opções

Altere os dados indicados em «Variantes e opções». Os campos obrigatórios e as regras de escrita estão descritos abaixo.

PATCH/api/v1/variant-options/{identity}/values/{value_id}

Autenticação
Bearer
Disponível a partir de
STANDARD
Permissões necessárias
catalog.variant_option:update

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_variant_value_api_v1_variant_options__identity__values__value_id__patch' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "value": "Example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/variant-options/example/values/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_variant_value_api_v1_variant_options__identity__values__value_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/variant-options/example/values/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,
  "value": "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_variant_value_api_v1_variant_options__identity__values__value_id__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 1,\n  "value": "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/variant-options/example/values/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

  • Uma variante pertence a um produto e usa valores dos catálogos de opções de variantes.
  • A referência inclui criação, leitura, atualização e eliminação de opções e valores, além das leituras e escritas de variantes de produtos.
  • As alterações de preços de variantes usam tipo de preço, valor, moeda e versões exigidas explícitos.
  • Diferencie um ajuste base de um preço fixo de mercado.
  • Leia o estado atual do produto e do preço antes de enviar uma atualização dependente.

Parâmetros

Parâmetros do caminho

identityTextoObrigatório

Identificador usado no caminho deste recurso.

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

Identificador do valor do catálogo.

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_variant_value_api_v1_variant_options__identity__values__value_id__patch"

Corpo da requisição

application/json · Obrigatório

VariantValueUpdate
color_hexTexto nullOpcional

Cor representada por um código hexadecimal.

Restrições · Texto 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807
Exemplo: 1
valueTexto nullOpcional

Valor definido pelo esquema que o contém.

Texto:minLength: 1maxLength: 180
Restrições · Texto 1
pattern
"^[^\\x00]*$"
Exemplo: "Example"

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