Opprett — Kategorier
Utfør «Opprett» i «Kategorier» med dataene som er beskrevet nedenfor.
POST/api/v1/categories
- Autentisering
Bearer- Tilgjengelig fra
- STANDARD
- Nødvendige tilganger
catalog.category:create
Kodeeksempler
Eksempel på forespørsel
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_category_api_v1_categories_post' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/categories
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_category_api_v1_categories_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/categories');
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"
}');
$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_category_api_v1_categories_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "name": "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/categories', 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
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Prinsipper
- Opprett og oppdater kategorier med gyldige overordnede identifikatorer og valgt språk- og markedskontekst.
- Les gjeldende versjon før du redigerer eller sletter en kategori.
- Sletting må respektere eksisterende relasjoner.
- En kategori som fortsatt er i bruk, kan bli avvist med resource.in_use; avklar først avhengighetene gjennom støttede operasjoner.
Parametere
Spørringsparametere
localeStreng nullValgfrittSpråk valgt for denne forespørselen.
Streng:minLength:2maxLength:20market_idStreng nullValgfrittMarkedsidentifikator returnert av kontekstendepunktet.
Begrensninger · Streng 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStreng nullValgfrittMarkedskode returnert av kontekstendepunktet.
Streng:minLength:1maxLength:16
Forespørselshoder
Idempotency-KeyStrengObligatoriskUnik identifikator for én logisk skriveoperasjon.
minLength:1maxLength:128Begrensninger
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Forespørselsinnhold
application/json · Obligatorisk
CategoryCreate
descriptionStreng nullValgfrittBeskrivelse på valgt språk.
Streng:maxLength:50000introductionStreng nullValgfrittInnledningstekst på valgt språk.
Streng:maxLength:5000is_visibleBoolsk verdiValgfrittOm ressursen er synlig.
market_idsArray <Streng> ValgfrittIdentifikatorer for valgte markeder.
maxItems:1000Array:minLength:1maxLength:63meta_descriptionStreng nullValgfrittSøkemotorbeskrivelse på valgt språk.
Streng:maxLength:160meta_keywordsArray <Streng> nullValgfrittSøkemotornøkkelord på valgt språk.
Array:maxItems:20Array / Array:maxLength:50meta_titleStreng nullValgfrittSøkemotortittel på valgt språk.
Streng:maxLength:70nameStrengObligatoriskRessursens navn i den relevante konteksten.
minLength:1maxLength:200parent_idStreng nullValgfrittIdentifikator for overordnet kategori.
Streng:minLength:1maxLength:63slugStreng nullValgfrittURL-stisegment på valgt språk.
Streng:maxLength:160
Svar
Svar 201
Fullstendig modell: ApiResponse_MutationData_
dataMutationDataObligatoriskInnholdet i et vellykket svar.
Felter ·
dataFullstendig modell:
MutationDatadeletedBoolsk verdiObligatoriskOm slettingen ble utført.
idStrengObligatoriskRessursidentifikator; behold den slik den returneres.
versionHeltall nullObligatoriskRessursversjon brukt til samtidighetskontroll.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoriskSvarmetadata.
Felter ·
metaFullstendig modell:
ContextPageMetalocaleStrengObligatoriskSpråk valgt for denne forespørselen.
market_codeStrengObligatoriskMarkedskode returnert av kontekstendepunktet.
market_idStrengObligatoriskMarkedsidentifikator returnert av kontekstendepunktet.
paginationPaginationObligatoriskMetadata for markørbasert sideinndeling.
request_idStrengObligatoriskSaksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.
minLength:1maxLength:100
Fullstendig modell:
ContextMetalocaleStrengObligatoriskSpråk valgt for denne forespørselen.
market_codeStrengObligatoriskMarkedskode returnert av kontekstendepunktet.
market_idStrengObligatoriskMarkedsidentifikator returnert av kontekstendepunktet.
request_idStrengObligatoriskSaksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.
minLength:1maxLength:100
paginationPaginationObligatoriskMetadata for markørbasert sideinndeling.
request_idStrengObligatoriskSaksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.
minLength:1maxLength:100
Fullstendig modell:
RequestMetarequest_idStrengObligatoriskSaksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.
minLength:1maxLength:100
HTTP-status
201- Ressurs opprettet Skjema
400- Ugyldig forespørsel
401- Autentisering kreves
403- Tilgang nektet
404- Ressursen ble ikke funnet
409- Versjonskonflikt
422- Validering mislyktes
429- Forespørselsgrensen er overskredet
Andre HTTP-statuser (7)
405- Metoden er ikke tillatt
413- Forespørselen er for stor
415- Formatet støttes ikke
500- Serverfeil
502- Feil i API-gateway
503- Tjenesten er utilgjengelig
504- Tidsavbrudd
Feilkatalog: ErrorResponse
Headere
201
LocationStrengValgfrittRelativ URL til ressursen som ble opprettet.
401
WWW-AuthenticateStrengValgfrittAutentiseringsmetode serveren krever.
405
AllowStrengValgfrittHTTP-metoder denne ressursen støtter.
429, 503
Retry-AfterHeltallValgfrittMinste ventetid før neste forsøk, i sekunder.
minimum:0