Vai al contenuto
ShopentlyLearn

Crea · Valori delle opzioni — Varianti e opzioni

Esegui «Crea · Valori delle opzioni» in «Varianti e opzioni» con i dati descritti di seguito.

POST/api/v1/variant-options/{identity}/values

Autenticazione
Bearer
Disponibile dal piano
STANDARD
Permessi necessari
catalog.variant_option:create

Esempi di codice

Esempio di richiesta

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: example-create_variant_value_api_v1_variant_options__identity__values_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "value": "Example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/variant-options/example/values

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-create_variant_value_api_v1_variant_options__identity__values_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/variant-options/example/values');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    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-create_variant_value_api_v1_variant_options__identity__values_post'}
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(
        'POST', base_url + '/api/v1/variant-options/example/values', 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))

Esempio di risposta 201

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

Principi

  • Una variante appartiene a un prodotto e usa valori dei dizionari delle opzioni.
  • La documentazione comprende CRUD di opzioni e valori, oltre a lettura e scrittura delle varianti di prodotto.
  • La modifica del prezzo della variante richiede tipo di prezzo, importo, valuta e versioni espliciti.
  • Distingui una variazione rispetto al prezzo base da un prezzo fisso di mercato.
  • Leggi lo stato corrente di prodotto e prezzi prima di inviare un aggiornamento dipendente.

Parametri

Parametri del percorso

identityStringaObbligatorio

Identificativo usato nel percorso di questa risorsa.

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

Parametri di query

localeStringa nullFacoltativo

Lingua selezionata per questa richiesta.

Stringa:minLength: 2maxLength: 20
market_idStringa nullFacoltativo

Identificativo del mercato restituito dall’endpoint del contesto.

Vincoli · Stringa 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStringa nullFacoltativo

Codice del mercato restituito dall’endpoint del contesto.

Stringa:minLength: 1maxLength: 16

Intestazioni della richiesta

Idempotency-KeyStringaObbligatorio

Identificativo univoco di una singola operazione logica di scrittura.

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

Corpo della richiesta

application/json · Obbligatorio

VariantValueCreate
color_hexStringa nullFacoltativo

Colore rappresentato da un codice esadecimale.

Vincoli · Stringa 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807
Esempio: 1
valueStringaObbligatorio

Valore descritto dallo schema circostante.

minLength: 1maxLength: 180
Vincoli
pattern
"^[^\\x00]*$"
Esempio: "Example"

Risposte

Risposta 201

dataMutationData Obbligatorio

Contenuto di una risposta riuscita.

Campi · data
deletedBooleanoObbligatorio

Indica se l’eliminazione è stata applicata.

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

versionIntero nullObbligatorio

Versione della risorsa per il controllo della concorrenza.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Campi · meta

ContextPageMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

ContextMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio di risposta

Stato HTTP

201
Risorsa creata Schema
400
Richiesta non valida
401
Autenticazione richiesta
403
Permesso negato
404
Risorsa non trovata
409
Conflitto di versione
422
Validazione non riuscita
429
Limite di richieste superato
Altri stati HTTP (7)
405
Metodo non consentito
413
Richiesta troppo grande
415
Formato non supportato
500
Errore del server
502
Errore del gateway API
503
Servizio non disponibile
504
Tempo di attesa scaduto

Catalogo degli errori: ErrorResponse

Header

201

LocationStringaFacoltativo

URL relativo della risorsa creata.

401

WWW-AuthenticateStringaFacoltativo

Schema di autenticazione richiesto dal server.

405

AllowStringaFacoltativo

Metodi HTTP supportati da questa risorsa.

429, 503

Retry-AfterInteroFacoltativo

Attesa minima prima di riprovare, in secondi.

minimum: 0