Aller au contenu
ShopentlyLearn

Modifier · Valeurs des options — Variantes et options

Modifiez les données indiquées dans « Variantes et options ». Les champs requis et règles d’écriture sont décrits ci-dessous.

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

Authentification
Bearer
Disponible à partir de
STANDARD
Autorisations requises
catalog.variant_option:update

Exemples de code

Exemple de requête

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

Exemple de réponse 200

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

Fonctionnement

  • Une variante appartient à un produit et utilise des valeurs des répertoires d'options de variantes.
  • La référence inclut les opérations CRUD des options et valeurs, ainsi que la lecture et l'écriture des variantes de produits.
  • Les changements de prix d'une variante exigent un type de prix, un montant, une devise et les versions nécessaires.
  • Distinguez l'ajustement du prix de base du prix fixe d'un marché.
  • Lisez l'état actuel du produit et des prix avant une modification dépendante.

Paramètres

Paramètres de chemin

identityChaîneObligatoire

Identifiant utilisé dans ce chemin de ressource.

Contraintes
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemple: "example"
value_idChaîneObligatoire

Identifiant d'une valeur du répertoire.

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

Paramètres de requête

localeChaîne nullFacultatif

Langue sélectionnée pour cette requête.

Chaîne:minLength: 2maxLength: 20
market_idChaîne nullFacultatif

Identifiant de marché renvoyé par le point d'accès au contexte.

Contraintes · Chaîne 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeChaîne nullFacultatif

Code de marché renvoyé par le point d'accès au contexte.

Chaîne:minLength: 1maxLength: 16

En-têtes de requête

Idempotency-KeyChaîneObligatoire

Identifiant unique d'une opération logique d'écriture.

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

Corps de la requête

application/json · Obligatoire

VariantValueUpdate
color_hexChaîne nullFacultatif

Couleur représentée par un code hexadécimal.

Contraintes · Chaîne 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807
Exemple: 1
valueChaîne nullFacultatif

Valeur décrite par le schéma environnant.

Chaîne:minLength: 1maxLength: 180
Contraintes · Chaîne 1
pattern
"^[^\\x00]*$"
Exemple: "Example"

Réponses

Réponse 200

dataMutationData Obligatoire

Données d'une réponse réussie.

Champs · data
deletedBooléenObligatoire

Indique si la suppression a été appliquée.

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

versionEntier nullObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire

Métadonnées de la réponse.

Champs · meta

ContextPageMeta

localeChaîneObligatoire

Langue sélectionnée pour cette requête.

market_codeChaîneObligatoire

Code de marché renvoyé par le point d'accès au contexte.

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

paginationPagination Obligatoire

Métadonnées de pagination par curseur.

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

ContextMeta

localeChaîneObligatoire

Langue sélectionnée pour cette requête.

market_codeChaîneObligatoire

Code de marché renvoyé par le point d'accès au contexte.

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoire

Métadonnées de pagination par curseur.

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100
Exemple de réponse

Statut HTTP

200
Réponse réussie Schéma
400
Requête invalide
401
Authentification requise
403
Accès refusé
404
Ressource introuvable
409
Conflit de version
422
Échec de validation
429
Limite de requêtes dépassée
Autres statuts HTTP (7)
405
Méthode non autorisée
413
Requête trop volumineuse
415
Format non pris en charge
500
Erreur du serveur
502
Erreur de passerelle API
503
Service indisponible
504
Délai de passerelle dépassé

Catalogue des erreurs: ErrorResponse

En-têtes

401

WWW-AuthenticateChaîneFacultatif

Schéma d'authentification exigé par le serveur.

405

AllowChaîneFacultatif

Méthodes HTTP prises en charge par cette ressource.

429, 503

Retry-AfterEntierFacultatif

Délai minimal avant une nouvelle tentative, en secondes.

minimum: 0