Gå til indhold
ShopentlyLearn

Opret · Værdier — Egenskaber og værdier

Udfør ”Opret · Værdier” i ”Egenskaber og værdier” med de data, der er beskrevet nedenfor.

POST/api/v1/features/{identity}/values

Godkendelse
Bearer
Tilgængelig fra
STANDARD
Nødvendige rettigheder
catalog.feature:create

Kodeeksempler

Eksempel på forespørgsel

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_feature_value_api_v1_features__identity__values_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "value": "Example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/features/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_feature_value_api_v1_features__identity__values_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/features/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_feature_value_api_v1_features__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/features/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))

Eksempel på svar 201

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

Principper

  • Egenskaber og deres værdier har separate operationer for samlinger, detaljer, oprettelse, opdatering og sletning.
  • Brug de returnerede værdi-id'er, når du tildeler egenskaber til produkter.
  • Regler for valg og eksisterende produktrelationer valideres.
  • Læs aktuelle versioner før ændringer, og afklar afhængigheder, før du sletter en værdi, der stadig er i brug.

Parametre

Stiparametre

identityStrengObligatorisk

Identifikator anvendt i denne ressourcesti.

Begrænsninger
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example"

Forespørgselsparametre

localeStreng nullValgfrit

Sprog valgt til denne forespørgsel.

Streng:minLength: 2maxLength: 20
market_idStreng nullValgfrit

Markedsidentifikator returneret af kontekstendepunktet.

Begrænsninger · Streng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStreng nullValgfrit

Markedskode returneret af kontekstendepunktet.

Streng:minLength: 1maxLength: 16

Anmodningsheadere

Idempotency-KeyStrengObligatorisk

Unik identifikator for én logisk skriveoperation.

minLength: 1maxLength: 128
Begrænsninger
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Eksempel: "example-create_feature_value_api_v1_features__identity__values_post"

Forespørgselsindhold

application/json · Obligatorisk

FeatureValueCreate
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
positionHeltalValgfrit

Placering i den sorterede samling.

minimum: 0maximum: 2147483647
valueStrengObligatorisk

Værdi beskrevet af det omgivende skema.

minLength: 1maxLength: 180
Begrænsninger
pattern
"^[^\\x00]*$"
Eksempel: "Example"

Svar

Svar 201

dataMutationData Obligatorisk

Indholdet af et vellykket svar.

Felter · data
deletedBoolesk værdiObligatorisk

Om sletningen blev udført.

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

versionHeltal nullObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

ContextMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

RequestMeta

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

201
Ressource oprettet Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

201

LocationStrengValgfrit

Relativ URL til den oprettede ressource.

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0