Перейти до вмісту
ShopentlyLearn

Створити — Товари

Виконайте «Створити» у «Товари» з даними, описаними нижче.

POST/api/v1/products

Автентифікація
Bearer
Доступно починаючи з
STANDARD
Потрібні дозволи
catalog.product:create
Додаткові дозволи для вибраних полів
  • Коли variant_value_ids не порожнє: 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_product_api_v1_products_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Example",
  "sku": "example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/products

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_product_api_v1_products_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products');
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, '{
  "name": "Example",
  "sku": "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_product_api_v1_products_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "name": "Example",\n  "sku": "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/products', 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"
  }
}

Як це працює

  • Інтеграція може читати всі невидалені товари, зокрема чернетки, крім заблокованих лімітом тарифу.
  • Заблоковані товари не потрапляють до списків; прямий доступ повертає entitlements.resource_blocked.
  • Тому доступність товару через API відрізняється від його публікації на вітрині.
  • Використовуйте наявні ідентифікатори брендів, категорій, характеристик і медіафайлів.
  • Для цін явно вказуються валюта, прайс-лист, податковий режим і версії контролю одночасних змін.
  • Ціни товару й варіантів відокремлені; використовуйте підтримувану структуру ціни та точні десяткові рядки.

Параметри

Параметри запиту

localeРядок nullНеобов’язкове

Мова, вибрана для цього запиту.

Рядок:minLength: 2maxLength: 20
market_idРядок nullНеобов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

Обмеження · Рядок 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeРядок nullНеобов’язкове

Код ринку, повернутий кінцевою точкою контексту.

Рядок:minLength: 1maxLength: 16

Заголовки запиту

Idempotency-KeyРядокОбов’язкове

Унікальний ідентифікатор однієї логічної операції запису.

minLength: 1maxLength: 128
Обмеження
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Приклад: "example-create_product_api_v1_products_post"

Тіло запиту

application/json · Обов’язкове

ProductCreate
brand_idРядок nullНеобов’язкове

Ідентифікатор бренду.

Рядок:minLength: 1maxLength: 63
conditionРядокНеобов’язкове

Стан товару.

Обмеження
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
За замовчуванням: "new"
descriptionРядок nullНеобов’язкове

Опис вибраною мовою.

Рядок:maxLength: 100000
feature_value_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних значень характеристик.

maxItems: 1000
Масив:minLength: 1maxLength: 63
identifiersProductIdentifiers nullНеобов’язкове

Ідентифікаційні коди товару.

market_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних ринків.

maxItems: 1000
Масив:minLength: 1maxLength: 63
media_idsМасив <Рядок> Необов’язкове

Ідентифікатори вже наявних медіафайлів.

maxItems: 20
Масив:minLength: 1maxLength: 63
meta_descriptionРядок nullНеобов’язкове

Опис для пошукових систем вибраною мовою.

Рядок:maxLength: 160
meta_keywordsМасив <Рядок> nullНеобов’язкове

Ключові слова для пошукових систем вибраною мовою.

Масив:maxItems: 20
Масив / Масив:maxLength: 50
meta_titleРядок nullНеобов’язкове

Заголовок для пошукових систем вибраною мовою.

Рядок:maxLength: 70
nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 300
Приклад: "Example"
pricingProductPrice Необов’язкове

Налаштування ціни та версії для контролю одночасних змін.

primary_category_idРядок nullНеобов’язкове

Ідентифікатор основної категорії.

Рядок:minLength: 1maxLength: 63
publishedЛогічне значенняНеобов’язкове

Чи опубліковано ресурс.

За замовчуванням: false
skuРядокОбов’язкове

Код складської облікової одиниці.

minLength: 1maxLength: 100
Обмеження
pattern
"^\\S+$"
Приклад: "example"
slugРядок nullНеобов’язкове

Сегмент шляху URL вибраною мовою.

Рядок:maxLength: 160
tax_category_idРядок nullНеобов’язкове

Ідентифікатор податкової категорії.

Рядок:minLength: 1maxLength: 63
variant_value_idsМасив <Рядок> Необов’язкове

Ідентифікатори вибраних значень варіантів.

maxItems: 250
Масив:minLength: 1maxLength: 63
variants_enabledЛогічне значенняНеобов’язкове

Чи використовує товар варіанти.

За замовчуванням: false

Відповіді

Відповідь 201

dataMutationData Обов’язкове

Дані успішної відповіді.

Поля · data
deletedЛогічне значенняОбов’язкове

Чи виконано видалення.

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

versionЦіле число nullОбов’язкове

Версія ресурсу для контролю одночасних змін.

metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове

Метадані відповіді.

Поля · meta

ContextPageMeta

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_codeРядокОбов’язкове

Код ринку, повернутий кінцевою точкою контексту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

paginationPagination Обов’язкове

Метадані пагінації за курсором.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

ContextMeta

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_codeРядокОбов’язкове

Код ринку, повернутий кінцевою точкою контексту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Обов’язкове

Метадані пагінації за курсором.

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