Przejdź do treści
ShopentlyLearn

Promocje · Zmień

Promocje · Zmień. Wszystkie kody muszą zezwalać na łączenie. Rabaty naliczane są kolejno.

PATCH/api/v1/discounts/promotions/{identity}

Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
discounts.promotions:update

Przykłady kodu

Przykład żądania

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request PATCH \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: learn-update_campaign_api_v1_discounts_promotions__identity__patch' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 1,
  "markets": [
    {
      "currency": "PLN",
      "market_id": "poland",
      "minor_units": 2
    }
  ],
  "name": "Autumn guide offer"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/discounts/promotions/example-campaign

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-update_campaign_api_v1_discounts_promotions__identity__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/promotions/example-campaign');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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, '{
  "expected_version": 1,
  "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-update_campaign_api_v1_discounts_promotions__identity__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 1,\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(
        'PATCH', base_url + '/api/v1/discounts/promotions/example-campaign', 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))

Przykład odpowiedzi 200

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

Przegląd

Wybrane produkty i kategorie łączą się. Kategoria obejmuje produkty przypisane bezpośrednio do niej.

Parametry

Parametry ścieżki

identityTekstWymagane

Identyfikator używany w ścieżce tego zasobu.

Ograniczenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Przykład: "example-campaign"

Nagłówki żądania

Idempotency-KeyTekstWymagane

Unikalny identyfikator jednej logicznej operacji zapisu.

minLength: 1maxLength: 128
Ograniczenia
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Przykład: "learn-update_campaign_api_v1_discounts_promotions__identity__patch"

Treść żądania

application/json · Wymagane

CampaignUpdate
audienceTekstOpcjonalne

Klienci

Ograniczenia
enum
["all", "guest", "customer", "selected"]
Wartość domyślna: "all"
benefit_typeTekstOpcjonalne

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["percentage", "fixed", "none"]
Wartość domyślna: "percentage"
category_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych kategorii.

maxItems: 1000
Ograniczenia · Tablica 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeTekst nullOpcjonalne

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia · Tekst 1
pattern
"^[A-Za-z0-9]{6,16}$"
Przykład: "LEARN10"
combine_couponsWartość logicznaOpcjonalne

Łącz z innymi kodami

Wartość domyślna: false
combine_promotionsWartość logicznaOpcjonalne

Zezwól na użycie kodu na produktach objętych automatyczną promocją

Wartość domyślna: false
customer_idsTablica <Tekst> Opcjonalne

Dane klienta zapisane dla tego zasobu.

maxItems: 1000
Ograniczenia · Tablica 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atTekst nullOpcjonalne

Aktywny do

Tekst:format: "date-time"
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807
Przykład: 1
free_shippingWartość logicznaOpcjonalne

Darmowa dostawa

Wartość domyślna: false
marketsTablica <MarketData-Input > Wymagane

Rynki dostępne w kontekście sklepu.

minItems: 1maxItems: 1000
Przykład: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityLiczba całkowitaOpcjonalne

Minimalna liczba sztuk w koszyku

minimum: 1maximum: 2147483647
Wartość domyślna: 1
nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 160
Przykład: "Autumn guide offer"
per_customer_limitLiczba całkowitaOpcjonalne

Limit użyć na klienta

minimum: -1maximum: 2147483647
Wartość domyślna: -1
percentageTekstOpcjonalne

Procentowy

maxLength: 19
Ograniczenia
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Wartość domyślna: "10"
product_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych produktów.

maxItems: 1000
Ograniczenia · Tablica 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeTekstOpcjonalne

Produkty

Ograniczenia
enum
["all", "selected"]
Wartość domyślna: "all"
show_accountWartość logicznaOpcjonalne

Na koncie klienta

Wartość domyślna: false
show_cartWartość logicznaOpcjonalne

W koszyku

Wartość domyślna: false
show_productWartość logicznaOpcjonalne

Na stronach produktów

Wartość domyślna: false
starts_atTekst nullOpcjonalne

Aktywny od

Tekst:format: "date-time"
usage_limitLiczba całkowitaOpcjonalne

Limit użyć

minimum: -1maximum: 2147483647
Wartość domyślna: -1

Odpowiedzi

Odpowiedź 200

dataMutationData Wymagane

Dane poprawnej odpowiedzi.

Pola · data
deletedWartość logicznaWymagane

Czy zastosowano usunięcie.

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

versionLiczba całkowita nullWymagane

Wersja zasobu używana do kontroli współbieżności.

metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Pola · meta

ContextPageMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

200
Poprawna odpowiedź Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0