Zum Inhalt springen
ShopentlyLearn

Aktionen · Erstellen

Aktionen · Erstellen. Jeder Code muss Kombinationen erlauben. Rabatte werden nacheinander berechnet.

POST/api/v1/discounts/promotions

Authentifizierung
Bearer
Verfügbar ab
STANDARD
Erforderliche Berechtigungen
discounts.promotions:create

Codebeispiele

Beispielanfrage

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: learn-create_campaign_api_v1_discounts_promotions_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "markets": [
    {
      "currency": "PLN",
      "market_id": "poland",
      "minor_units": 2
    }
  ],
  "name": "Autumn guide offer"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/discounts/promotions

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: learn-create_campaign_api_v1_discounts_promotions_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/promotions');
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, '{
  "markets": [
    {
      "currency": "PLN",
      "market_id": "poland",
      "minor_units": 2
    }
  ],
  "name": "Autumn guide offer"
}');
$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': 'learn-create_campaign_api_v1_discounts_promotions_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "markets": [\n    {\n      "currency": "PLN",\n      "market_id": "poland",\n      "minor_units": 2\n    }\n  ],\n  "name": "Autumn guide offer"\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/discounts/promotions', 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))

Beispielantwort 201

JSON
{
  "data": {
    "deleted": false,
    "id": "example-campaign",
    "version": null
  },
  "meta": {
    "locale": "example",
    "market_code": "example",
    "market_id": "poland",
    "pagination": {
      "has_more": false,
      "limit": 1,
      "next_cursor": null
    },
    "request_id": "learn-example-request"
  }
}

Übersicht

Produkte und Kategorien werden gemeinsam berücksichtigt. Kategorien umfassen direkt zugeordnete Produkte.

Parameter

Anfrageheader

Idempotency-KeyZeichenfolgeErforderlich

Eindeutige Kennung eines logischen Schreibvorgangs.

minLength: 1maxLength: 128
Einschränkungen
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Beispiel: "learn-create_campaign_api_v1_discounts_promotions_post"

Anfrageinhalt

application/json · Erforderlich

CampaignCreate
audienceZeichenfolgeOptional

Kunden

Einschränkungen
enum
["all", "guest", "customer", "selected"]
Standardwert: "all"
benefit_typeZeichenfolgeOptional

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen
enum
["percentage", "fixed", "none"]
Standardwert: "percentage"
category_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Kategorien.

maxItems: 1000
Einschränkungen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeZeichenfolge nullOptional

Stabiler maschinenlesbarer Code.

Einschränkungen · Zeichenfolge 1
pattern
"^[A-Za-z0-9]{6,16}$"
Beispiel: "LEARN10"
combine_couponsBoolescher WertOptional

Mit anderen Codes kombinieren

Standardwert: false
combine_promotionsBoolescher WertOptional

Diesen Code für Produkte mit automatischen Aktionen zulassen

Standardwert: false
customer_idsArray <Zeichenfolge> Optional

Für diese Ressource gespeicherte Kundendaten.

maxItems: 1000
Einschränkungen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atZeichenfolge nullOptional

Aktiv bis

Zeichenfolge:format: "date-time"
free_shippingBoolescher WertOptional

Kostenloser Versand

Standardwert: false
marketsArray <MarketData-Input > Erforderlich

Im Shop-Kontext verfügbare Märkte.

minItems: 1maxItems: 1000
Beispiel: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityGanzzahlOptional

Mindestanzahl an Artikeln im Warenkorb

minimum: 1maximum: 2147483647
Standardwert: 1
nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160
Beispiel: "Autumn guide offer"
per_customer_limitGanzzahlOptional

Nutzungslimit pro Kunde

minimum: -1maximum: 2147483647
Standardwert: -1
percentageZeichenfolgeOptional

Prozentual

maxLength: 19
Einschränkungen
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Standardwert: "10"
product_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Produkte.

maxItems: 1000
Einschränkungen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeZeichenfolgeOptional

Produkte

Einschränkungen
enum
["all", "selected"]
Standardwert: "all"
show_accountBoolescher WertOptional

Im Kundenkonto

Standardwert: false
show_cartBoolescher WertOptional

Im Warenkorb

Standardwert: false
show_productBoolescher WertOptional

Auf Produktseiten

Standardwert: false
starts_atZeichenfolge nullOptional

Aktiv ab

Zeichenfolge:format: "date-time"
usage_limitGanzzahlOptional

Nutzungslimit

minimum: -1maximum: 2147483647
Standardwert: -1

Antworten

Antwort 201

dataMutationData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Felder · data
deletedBoolescher WertErforderlich

Gibt an, ob die Löschung durchgeführt wurde.

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

versionGanzzahl nullErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich

Metadaten der Antwort.

Felder · meta

ContextPageMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

ContextMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

PageMeta

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

RequestMeta

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100
Beispielantwort

HTTP-Status

201
Ressource erstellt Schema
400
Ungültige Anfrage
401
Authentifizierung erforderlich
403
Berechtigung verweigert
404
Ressource nicht gefunden
409
Versionskonflikt
422
Validierung fehlgeschlagen
429
Anfragelimit überschritten
Weitere HTTP-Statuscodes (7)
405
Methode nicht erlaubt
413
Anfrage zu groß
415
Nicht unterstützter Medientyp
500
Serverfehler
502
API-Gateway-Fehler
503
Dienst nicht verfügbar
504
Gateway-Zeitüberschreitung

Fehlerkatalog: ErrorResponse

Header

201

LocationZeichenfolgeOptional

Relativer URL der erstellten Ressource.

401

WWW-AuthenticateZeichenfolgeOptional

Vom Server verlangtes Authentifizierungsschema.

405

AllowZeichenfolgeOptional

Von dieser Ressource unterstützte HTTP-Methoden.

429, 503

Retry-AfterGanzzahlOptional

Mindestwartezeit vor einem erneuten Versuch in Sekunden.

minimum: 0