Léim ar ábhar
ShopentlyLearn

Cruthaigh — Táirgí

Déan “Cruthaigh” in “Táirgí” leis na sonraí a thuairiscítear thíos.

POST/api/v1/products

Fíordheimhniú
Bearer
Ar fáil ó
STANDARD
Ceadanna riachtanacha
catalog.product:create
Ceadanna breise do réimsí roghnaithe
  • Nuair nach bhfuil variant_value_ids folamh: catalog.product_variant:create
Tuilleadh eolais

Samplaí cóid

Sampla iarratais

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

Sampla freagra 201

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

Conas a oibríonn sé

  • Is féidir leis an gcomhtháthú gach táirge nár scriosadh a léamh, dréachtaí san áireamh, ach amháin táirgí atá blocáilte ag teorainn plean.
  • Fágtar táirgí blocáilte as liostaí; tugann rochtain dhíreach entitlements.resource_blocked.
  • Mar sin ní hionann infheictheacht san API agus foilsiú sa siopa.
  • Úsáid aitheantóirí atá ann cheana do bhrandaí, catagóirí, tréithe agus meáin.
  • Tá airgeadra, praghasliosta, modh cánach agus leaganacha comhreatha follasacha ag praghsanna.
  • Tá praghsáil táirge agus athraithigh ar leith; úsáid an struchtúr tacaithe agus teaghráin dheachúlacha bheachta.

Paraiméadair

Paraiméadair fhiosrúcháin

localeTeaghrán nullRoghnach

Teanga roghnaithe don iarratas seo.

Teaghrán:minLength: 2maxLength: 20
market_idTeaghrán nullRoghnach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Srianta · Teaghrán 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeTeaghrán nullRoghnach

Cód margaidh a thugann an críochphointe comhthéacs.

Teaghrán:minLength: 1maxLength: 16

Ceanntásca iarratais

Idempotency-KeyTeaghránRiachtanach

Aitheantóir uathúil d'oibríocht loighciúil scríbhneoireachta amháin.

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

Corp an iarratais

application/json · Riachtanach

ProductCreate
brand_idTeaghrán nullRoghnach

Aitheantóir branda.

Teaghrán:minLength: 1maxLength: 63
conditionTeaghránRoghnach

Riocht an táirge.

Srianta
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Réamhshocrú: "new"
descriptionTeaghrán nullRoghnach

Cur síos sa teanga roghnaithe.

Teaghrán:maxLength: 100000
feature_value_idsEagar <Teaghrán> Roghnach

Aitheantóirí na luachanna tréithe roghnaithe.

maxItems: 1000
Eagar:minLength: 1maxLength: 63
identifiersProductIdentifiers nullRoghnach

Cóid aitheantais táirge.

market_idsEagar <Teaghrán> Roghnach

Aitheantóirí na margaí roghnaithe.

maxItems: 1000
Eagar:minLength: 1maxLength: 63
media_idsEagar <Teaghrán> Roghnach

Aitheantóirí sócmhainní meán atá ann cheana.

maxItems: 20
Eagar:minLength: 1maxLength: 63
meta_descriptionTeaghrán nullRoghnach

Cur síos inneall cuardaigh sa teanga roghnaithe.

Teaghrán:maxLength: 160
meta_keywordsEagar <Teaghrán> nullRoghnach

Eochairfhocail inneall cuardaigh sa teanga roghnaithe.

Eagar:maxItems: 20
Eagar / Eagar:maxLength: 50
meta_titleTeaghrán nullRoghnach

Teideal inneall cuardaigh sa teanga roghnaithe.

Teaghrán:maxLength: 70
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 300
Sampla: "Example"
pricingProductPrice Roghnach

Cumraíocht praghsála agus a leaganacha comhreatha.

primary_category_idTeaghrán nullRoghnach

Aitheantóir na príomhchatagóire.

Teaghrán:minLength: 1maxLength: 63
publishedLuach BooleRoghnach

An bhfuil an acmhainn foilsithe.

Réamhshocrú: false
skuTeaghránRiachtanach

Cód aonaid coimeádta stoic.

minLength: 1maxLength: 100
Srianta
pattern
"^\\S+$"
Sampla: "example"
slugTeaghrán nullRoghnach

Cuid de chosán URL sa teanga roghnaithe.

Teaghrán:maxLength: 160
tax_category_idTeaghrán nullRoghnach

Aitheantóir catagóire cánach.

Teaghrán:minLength: 1maxLength: 63
variant_value_idsEagar <Teaghrán> Roghnach

Aitheantóirí luachanna athraitheach roghnaithe.

maxItems: 250
Eagar:minLength: 1maxLength: 63
variants_enabledLuach BooleRoghnach

An úsáideann an táirge athraithigh.

Réamhshocrú: false

Freagraí

Freagra 201

dataMutationData Riachtanach

Sonraí freagra rathúil.

Réimsí · data
deletedLuach BooleRiachtanach

Ar cuireadh an scriosadh i bhfeidhm.

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

versionSlánuimhir nullRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Réimsí · meta

ContextPageMeta

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

market_codeTeaghránRiachtanach

Cód margaidh a thugann an críochphointe comhthéacs.

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

paginationPagination Riachtanach

Meiteashonraí leathanaithe le cúrsóir.

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

market_codeTeaghránRiachtanach

Cód margaidh a thugann an críochphointe comhthéacs.

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Riachtanach

Meiteashonraí leathanaithe le cúrsóir.

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100
Sampla freagra

Stádas HTTP

201
Acmhainn cruthaithe Scéim
400
Iarratas neamhbhailí
401
Fíordheimhniú riachtanach
403
Cead diúltaithe
404
Acmhainn gan aimsiú
409
Coinbhleacht leagain
422
Theip ar bhailíochtú
429
Teorainn iarratas sáraithe
Stádais HTTP eile (7)
405
Modh neamhcheadaithe
413
Iarratas rómhór
415
Formáid gan tacaíocht
500
Earráid freastalaí
502
Earráid gheata API
503
Seirbhís gan fáil
504
Teorainn ama sáraithe

Catalóg earráidí: ErrorResponse

Ceanntásca

201

LocationTeaghránRoghnach

URL coibhneasta na hacmhainne cruthaithe.

401

WWW-AuthenticateTeaghránRoghnach

An scéim fíordheimhnithe a éilíonn an freastalaí.

405

AllowTeaghránRoghnach

Modhanna HTTP a thacaíonn an acmhainn seo leo.

429, 503

Retry-AfterSlánuimhirRoghnach

An mhoill íosta roimh atriail, i soicindí.

minimum: 0