Ga naar de inhoud
ShopentlyLearn

Promoties · Aanmaken

Promoties · Aanmaken. Elke code moet combinaties toestaan. Kortingen worden na elkaar toegepast.

POST/api/v1/discounts/promotions

Authenticatie
Bearer
Beschikbaar vanaf
STANDARD
Vereiste rechten
discounts.promotions:create

Codevoorbeelden

Voorbeeldverzoek

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

Voorbeeldantwoord 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"
  }
}

Overzicht

Geselecteerde producten en categorieën worden samengevoegd. Categorieën omvatten rechtstreeks toegewezen producten.

Parameters

Verzoekheaders

Idempotency-KeyTekenreeksVerplicht

Unieke identificatie voor één logische schrijfbewerking.

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

Verzoekinhoud

application/json · Verplicht

CampaignCreate
audienceTekenreeksOptioneel

Klanten

Beperkingen
enum
["all", "guest", "customer", "selected"]
Standaard: "all"
benefit_typeTekenreeksOptioneel

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen
enum
["percentage", "fixed", "none"]
Standaard: "percentage"
category_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde categorieën.

maxItems: 1000
Beperkingen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeTekenreeks nullOptioneel

Stabiele, machineleesbare code.

Beperkingen · Tekenreeks 1
pattern
"^[A-Za-z0-9]{6,16}$"
Voorbeeld: "LEARN10"
combine_couponsBooleaanse waardeOptioneel

Combineren met andere codes

Standaard: false
combine_promotionsBooleaanse waardeOptioneel

Deze code toestaan voor producten met automatische promoties

Standaard: false
customer_idsArray <Tekenreeks> Optioneel

Klantgegevens die voor deze resource zijn vastgelegd.

maxItems: 1000
Beperkingen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atTekenreeks nullOptioneel

Actief tot

Tekenreeks:format: "date-time"
free_shippingBooleaanse waardeOptioneel

Gratis verzending

Standaard: false
marketsArray <MarketData-Input > Verplicht

Beschikbare markten binnen de winkelcontext.

minItems: 1maxItems: 1000
Voorbeeld: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityGeheel getalOptioneel

Minimumaantal artikelen in de winkelwagen

minimum: 1maximum: 2147483647
Standaard: 1
nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160
Voorbeeld: "Autumn guide offer"
per_customer_limitGeheel getalOptioneel

Gebruikslimiet per klant

minimum: -1maximum: 2147483647
Standaard: -1
percentageTekenreeksOptioneel

Percentage

maxLength: 19
Beperkingen
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Standaard: "10"
product_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde producten.

maxItems: 1000
Beperkingen · Array 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeTekenreeksOptioneel

Producten

Beperkingen
enum
["all", "selected"]
Standaard: "all"
show_accountBooleaanse waardeOptioneel

In het klantaccount

Standaard: false
show_cartBooleaanse waardeOptioneel

In de winkelwagen

Standaard: false
show_productBooleaanse waardeOptioneel

Op productpagina's

Standaard: false
starts_atTekenreeks nullOptioneel

Actief vanaf

Tekenreeks:format: "date-time"
usage_limitGeheel getalOptioneel

Gebruikslimiet

minimum: -1maximum: 2147483647
Standaard: -1

Antwoorden

Antwoord 201

dataMutationData Verplicht

Gegevens van een geslaagd antwoord.

Velden · data
deletedBooleaanse waardeVerplicht

Of de verwijdering is uitgevoerd.

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

versionGeheel getal nullVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

metaContextPageMeta ContextMeta PageMeta RequestMeta Verplicht

Metadata van het antwoord.

Velden · meta

ContextPageMeta

localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

market_codeTekenreeksVerplicht

Marktcode die het contextendpoint teruggeeft.

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

paginationPagination Verplicht

Metadata voor cursorpaginering.

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

ContextMeta

localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

market_codeTekenreeksVerplicht

Marktcode die het contextendpoint teruggeeft.

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

PageMeta

paginationPagination Verplicht

Metadata voor cursorpaginering.

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

RequestMeta

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeldantwoord

HTTP-status

201
Resource aangemaakt Schema
400
Ongeldig verzoek
401
Authenticatie vereist
403
Toegang geweigerd
404
Resource niet gevonden
409
Versieconflict
422
Validatie mislukt
429
Verzoeklimiet overschreden
Overige HTTP-statussen (7)
405
Methode niet toegestaan
413
Verzoek te groot
415
Niet-ondersteund formaat
500
Serverfout
502
API-gatewayfout
503
Service niet beschikbaar
504
Gatewaytime-out

Foutencatalogus: ErrorResponse

Headers

201

LocationTekenreeksOptioneel

Relatieve URL van de aangemaakte resource.

401

WWW-AuthenticateTekenreeksOptioneel

Authenticatieschema dat de server vereist.

405

AllowTekenreeksOptioneel

HTTP-methoden die deze resource ondersteunt.

429, 503

Retry-AfterGeheel getalOptioneel

Minimale wachttijd voordat u het opnieuw probeert, in seconden.

minimum: 0