Vai al contenuto
ShopentlyLearn

Promozioni · Aggiorna

Promozioni · Aggiorna. Ogni codice deve consentire la combinazione. Gli sconti si applicano in ordine.

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

Autenticazione
Bearer
Disponibile dal piano
STANDARD
Permessi necessari
discounts.promotions:update

Esempi di codice

Esempio di richiesta

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

Esempio di risposta 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"
  }
}

Panoramica

Si includono i prodotti e le categorie selezionati. Le categorie comprendono i prodotti assegnati direttamente.

Parametri

Parametri del percorso

identityStringaObbligatorio

Identificativo usato nel percorso di questa risorsa.

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

Intestazioni della richiesta

Idempotency-KeyStringaObbligatorio

Identificativo univoco di una singola operazione logica di scrittura.

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

Corpo della richiesta

application/json · Obbligatorio

CampaignUpdate
audienceStringaFacoltativo

Clienti

Vincoli
enum
["all", "guest", "customer", "selected"]
Valore predefinito: "all"
benefit_typeStringaFacoltativo

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["percentage", "fixed", "none"]
Valore predefinito: "percentage"
category_idsArray <Stringa> Facoltativo

Identificativi delle categorie collegate.

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

Codice stabile interpretabile dal software.

Vincoli · Stringa 1
pattern
"^[A-Za-z0-9]{6,16}$"
Esempio: "LEARN10"
combine_couponsBooleanoFacoltativo

Combina con altri codici

Valore predefinito: false
combine_promotionsBooleanoFacoltativo

Consenti questo codice sui prodotti con promozioni automatiche

Valore predefinito: false
customer_idsArray <Stringa> Facoltativo

Dati del cliente registrati per questa risorsa.

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

Attivo fino al

Stringa:format: "date-time"
expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807
Esempio: 1
free_shippingBooleanoFacoltativo

Spedizione gratuita

Valore predefinito: false
marketsArray <MarketData-Input > Obbligatorio

Mercati disponibili nel contesto del negozio.

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

Numero minimo di articoli nel carrello

minimum: 1maximum: 2147483647
Valore predefinito: 1
nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160
Esempio: "Autumn guide offer"
per_customer_limitInteroFacoltativo

Limite di utilizzi per cliente

minimum: -1maximum: 2147483647
Valore predefinito: -1
percentageStringaFacoltativo

Percentuale

maxLength: 19
Vincoli
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Valore predefinito: "10"
product_idsArray <Stringa> Facoltativo

Identificativi dei prodotti collegati.

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

Prodotti

Vincoli
enum
["all", "selected"]
Valore predefinito: "all"
show_accountBooleanoFacoltativo

Nell'account cliente

Valore predefinito: false
show_cartBooleanoFacoltativo

Nel carrello

Valore predefinito: false
show_productBooleanoFacoltativo

Nelle pagine prodotto

Valore predefinito: false
starts_atStringa nullFacoltativo

Attivo dal

Stringa:format: "date-time"
usage_limitInteroFacoltativo

Limite di utilizzi

minimum: -1maximum: 2147483647
Valore predefinito: -1

Risposte

Risposta 200

dataMutationData Obbligatorio

Contenuto di una risposta riuscita.

Campi · data
deletedBooleanoObbligatorio

Indica se l’eliminazione è stata applicata.

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

versionIntero nullObbligatorio

Versione della risorsa per il controllo della concorrenza.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Campi · meta

ContextPageMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

ContextMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio di risposta

Stato HTTP

200
Risposta riuscita Schema
400
Richiesta non valida
401
Autenticazione richiesta
403
Permesso negato
404
Risorsa non trovata
409
Conflitto di versione
422
Validazione non riuscita
429
Limite di richieste superato
Altri stati HTTP (7)
405
Metodo non consentito
413
Richiesta troppo grande
415
Formato non supportato
500
Errore del server
502
Errore del gateway API
503
Servizio non disponibile
504
Tempo di attesa scaduto

Catalogo degli errori: ErrorResponse

Header

401

WWW-AuthenticateStringaFacoltativo

Schema di autenticazione richiesto dal server.

405

AllowStringaFacoltativo

Metodi HTTP supportati da questa risorsa.

429, 503

Retry-AfterInteroFacoltativo

Attesa minima prima di riprovare, in secondi.

minimum: 0