Gå til innhold
ShopentlyLearn

Kampanjer · Oppdater

Kampanjer · Oppdater. Alle koder må tillate kombinasjoner. Rabattene beregnes i rekkefølge.

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

Autentisering
Bearer
Tilgjengelig fra
STANDARD
Nødvendige tilganger
discounts.promotions:update

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

Eksempel på svar 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"
  }
}

Oversikt

Valgte produkter og kategorier kombineres. Kategorier omfatter direkte tilordnede produkter.

Parametere

Stiparametere

identityStrengObligatorisk

Identifikator brukt i denne ressursstien.

Begrensninger
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example-campaign"

Forespørselshoder

Idempotency-KeyStrengObligatorisk

Unik identifikator for én logisk skriveoperasjon.

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

Forespørselsinnhold

application/json · Obligatorisk

CampaignUpdate
audienceStrengValgfritt

Kunder

Begrensninger
enum
["all", "guest", "customer", "selected"]
Standard: "all"
benefit_typeStrengValgfritt

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["percentage", "fixed", "none"]
Standard: "percentage"
category_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede kategorier.

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

Stabil maskinlesbar kode.

Begrensninger · Streng 1
pattern
"^[A-Za-z0-9]{6,16}$"
Eksempel: "LEARN10"
combine_couponsBoolsk verdiValgfritt

Kombiner med andre koder

Standard: false
combine_promotionsBoolsk verdiValgfritt

Tillat denne koden på produkter med automatiske kampanjer

Standard: false
customer_idsArray <Streng> Valgfritt

Kundeinformasjon registrert for denne ressursen.

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

Aktiv til

Streng:format: "date-time"
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
free_shippingBoolsk verdiValgfritt

Gratis frakt

Standard: false
marketsArray <MarketData-Input > Obligatorisk

Markeder tilgjengelige i butikkens kontekst.

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

Minste antall varer i handlekurven

minimum: 1maximum: 2147483647
Standard: 1
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160
Eksempel: "Autumn guide offer"
per_customer_limitHeltallValgfritt

Bruksgrense per kunde

minimum: -1maximum: 2147483647
Standard: -1
percentageStrengValgfritt

Prosent

maxLength: 19
Begrensninger
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Standard: "10"
product_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede produkter.

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

Produkter

Begrensninger
enum
["all", "selected"]
Standard: "all"
show_accountBoolsk verdiValgfritt

På kundekontoen

Standard: false
show_cartBoolsk verdiValgfritt

I handlekurven

Standard: false
show_productBoolsk verdiValgfritt

På produktsider

Standard: false
starts_atStreng nullValgfritt

Aktiv fra

Streng:format: "date-time"
usage_limitHeltallValgfritt

Bruksgrense

minimum: -1maximum: 2147483647
Standard: -1

Svar

Svar 200

dataMutationData Obligatorisk

Innholdet i et vellykket svar.

Felter · data
deletedBoolsk verdiObligatorisk

Om slettingen ble utført.

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

versionHeltall nullObligatorisk

Ressursversjon brukt til samtidighetskontroll.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

ContextMeta

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

RequestMeta

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar 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

401

WWW-AuthenticateStrengValgfritt

Autentiseringsmetode serveren krever.

405

AllowStrengValgfritt

HTTP-metoder denne ressursen støtter.

429, 503

Retry-AfterHeltallValgfritt

Minste ventetid før neste forsøk, i sekunder.

minimum: 0