Μετάβαση στο περιεχόμενο
ShopentlyLearn

Δημιουργία · Παραλλαγές προϊόντος — Παραλλαγές και επιλογές

Εκτελέστε «Δημιουργία · Παραλλαγές προϊόντος» στο «Παραλλαγές και επιλογές» με τα δεδομένα που περιγράφονται παρακάτω.

POST/api/v1/products/{product_id}/variants

Έλεγχος ταυτότητας
Bearer
Διαθέσιμο από
STANDARD
Απαιτούμενα δικαιώματα
catalog.product_variant:create

Παραδείγματα κώδικα

Παράδειγμα αιτήματος

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_api_v1_products__product_id__variants_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "value_ids": [
    "example"
  ]
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/products/example/variants

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_api_v1_products__product_id__variants_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products/example/variants');
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_ids": [
    "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_api_v1_products__product_id__variants_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 1,\n  "value_ids": [\n    "example"\n  ]\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/products/example/variants', 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))

Παράδειγμα απόκρισης 201

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

Αρχές

  • Μια παραλλαγή ανήκει σε προϊόν και χρησιμοποιεί τιμές από τους καταλόγους επιλογών παραλλαγών.
  • Η τεκμηρίωση περιλαμβάνει δημιουργία, ανάγνωση, ενημέρωση και διαγραφή επιλογών και τιμών, καθώς και αναγνώσεις και εγγραφές παραλλαγών προϊόντων.
  • Οι αλλαγές τιμής παραλλαγής χρησιμοποιούν ρητό τύπο τιμολόγησης, ποσό, νόμισμα και απαιτούμενες εκδόσεις.
  • Διακρίνετε την προσαρμογή βασικής τιμής από τη σταθερή τιμή αγοράς.
  • Διαβάζετε την τρέχουσα κατάσταση προϊόντος και τιμών πριν υποβάλετε εξαρτώμενη ενημέρωση.

Παράμετροι

Παράμετροι διαδρομής

product_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος.

Περιορισμοί
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Παράδειγμα: "example"

Παράμετροι ερωτήματος

localeΣυμβολοσειρά nullΠροαιρετικό

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

Συμβολοσειρά:minLength: 2maxLength: 20
market_idΣυμβολοσειρά nullΠροαιρετικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

Περιορισμοί · Συμβολοσειρά 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeΣυμβολοσειρά nullΠροαιρετικό

Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.

Συμβολοσειρά:minLength: 1maxLength: 16

Κεφαλίδες αιτήματος

Idempotency-KeyΣυμβολοσειράΥποχρεωτικό

Μοναδικό αναγνωριστικό μίας λογικής πράξης εγγραφής.

minLength: 1maxLength: 128
Περιορισμοί
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Παράδειγμα: "example-create_variant_api_v1_products__product_id__variants_post"

Περιεχόμενο αιτήματος

application/json · Υποχρεωτικό

VariantCreate
activeΛογική τιμήΠροαιρετικό

Δείχνει αν ο πόρος είναι ενεργός.

Προεπιλογή: true
expected_versionΑκέραιοςΥποχρεωτικό

Έκδοση που διαβάστηκε πριν από την εγγραφή· αν δεν συμφωνεί, η ενημέρωση απορρίπτεται.

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
is_defaultΛογική τιμήΠροαιρετικό

Δείχνει αν είναι η προεπιλεγμένη επιλογή.

media_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά ήδη υπαρχόντων αρχείων πολυμέσων.

maxItems: 20
Πίνακας:minLength: 1maxLength: 63
pricingVariantPrice Προαιρετικό

Ρυθμίσεις τιμολόγησης και εκδόσεις ελέγχου ταυτόχρονων εγγραφών.

skuΣυμβολοσειράΠροαιρετικό

Κωδικός μονάδας αποθέματος.

minLength: 1maxLength: 100
Περιορισμοί
pattern
"^\\S+$"
value_idsΠίνακας <Συμβολοσειρά> Υποχρεωτικό

Αναγνωριστικά τιμών λεξικού.

minItems: 1maxItems: 250
Πίνακας:minLength: 1maxLength: 63
Παράδειγμα: ["example"]

Αποκρίσεις

Απόκριση 201

dataMutationData Υποχρεωτικό

Δεδομένα επιτυχούς απόκρισης.

Πεδία · data
deletedΛογική τιμήΥποχρεωτικό

Δείχνει αν εφαρμόστηκε η διαγραφή.

idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.

versionΑκέραιος nullΥποχρεωτικό

Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.

metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

Μεταδεδομένα απόκρισης.

Πεδία · meta

ContextPageMeta

localeΣυμβολοσειράΥποχρεωτικό

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

market_codeΣυμβολοσειράΥποχρεωτικό

Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

paginationPagination Υποχρεωτικό

Μεταδεδομένα σελιδοποίησης με cursor.

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

ContextMeta

localeΣυμβολοσειράΥποχρεωτικό

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

market_codeΣυμβολοσειράΥποχρεωτικό

Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Υποχρεωτικό

Μεταδεδομένα σελιδοποίησης με cursor.

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100
Παράδειγμα απόκρισης

Κατάσταση HTTP

201
Δημιουργήθηκε πόρος Σχήμα
400
Μη έγκυρο αίτημα
401
Απαιτείται ταυτοποίηση
403
Δεν επιτρέπεται η πρόσβαση
404
Ο πόρος δεν βρέθηκε
409
Διένεξη έκδοσης
422
Αποτυχία επικύρωσης
429
Υπέρβαση ορίου αιτημάτων
Άλλες καταστάσεις HTTP (7)
405
Η μέθοδος δεν επιτρέπεται
413
Πολύ μεγάλο αίτημα
415
Μη υποστηριζόμενος τύπος
500
Σφάλμα διακομιστή
502
Σφάλμα πύλης API
503
Μη διαθέσιμη υπηρεσία
504
Υπέρβαση χρόνου αναμονής

Κατάλογος σφαλμάτων: ErrorResponse

Κεφαλίδες

201

LocationΣυμβολοσειράΠροαιρετικό

Σχετικό URL του πόρου που δημιουργήθηκε.

401

WWW-AuthenticateΣυμβολοσειράΠροαιρετικό

Σχήμα ελέγχου ταυτότητας που απαιτεί ο διακομιστής.

405

AllowΣυμβολοσειράΠροαιρετικό

Μέθοδοι HTTP που υποστηρίζει αυτός ο πόρος.

429, 503

Retry-AfterΑκέραιοςΠροαιρετικό

Ελάχιστος χρόνος αναμονής πριν από νέα προσπάθεια, σε δευτερόλεπτα.

minimum: 0