Sconti · Recupera

Sconti · Recupera. Ogni codice deve consentire la combinazione. Gli sconti si applicano in ordine.

GET`/api/v1/discounts/coupons/{identity}`

Autenticazione: Bearer
Disponibile dal piano: STANDARD
Permessi necessari: discounts.coupons:read

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 GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/discounts/coupons/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 = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/coupons/example-campaign');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    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);
    },
]);
$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 = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
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(
        'GET', base_url + '/api/v1/discounts/coupons/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": {
    "created_at": "2026-10-07T10:00:00Z",
    "created_by": {
      "kind": "admin",
      "label": "Editorial integration",
      "reference": "learn-api-key"
    },
    "enabled": false,
    "id": "example-campaign",
    "kind": "coupon",
    "markets": [
      {
        "currency": "PLN",
        "market_id": "poland",
        "minor_units": 0
      }
    ],
    "name": "Autumn guide offer",
    "updated_at": "2026-10-07T10:00:00Z",
    "used_count": 0,
    "version": 1
  },
  "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.

Scritture sicure

Permessi e piani

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"

Questa operazione non accetta un corpo JSON.

Risposte

Risposta 200

Modello completo: ApiResponse_CampaignData_

dataCampaignData Obbligatorio

Contenuto di una risposta riuscita.

Campi · data

Modello completo: CampaignData

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

combine_couponsBooleanoFacoltativo

Combina con altri codici

Valore predefinito: false

combine_promotionsBooleanoFacoltativo

Consenti questo codice sui prodotti con promozioni automatiche

Valore predefinito: false

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

created_byCreatorData Obbligatorio

Creato da

Campi · created_by

Modello completo: CreatorData

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["admin", "api"]

labelStringaObbligatorio

Nome della risorsa nel contesto pertinente.

referenceStringaObbligatorio

Identificativo dell’entità referenziata.

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

enabledBooleanoObbligatorio

Indica se questa impostazione è abilitata.

ends_atStringa nullFacoltativo

Attivo fino al

Stringa:format: "date-time"

free_shippingBooleanoFacoltativo

Spedizione gratuita

Valore predefinito: false

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["coupon", "promotion"]

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obbligatorio

Mercati disponibili nel contesto del negozio.

minItems: 1maxItems: 1000

Campi · markets

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData

Modello completo: shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData

minimum_quantityInteroFacoltativo

Numero minimo di articoli nel carrello

minimum: 1maximum: 2147483647

Valore predefinito: 1

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

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"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

usage_limitInteroFacoltativo

Limite di utilizzi

minimum: -1maximum: 2147483647

Valore predefinito: -1

used_countInteroObbligatorio

Utilizzi effettuati

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Campi · meta

ContextPageMeta

Modello completo: 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

Modello completo: 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

Modello completo: 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

Modello completo: 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

Catalogo degli errori · Scopri di più

GET/api/v1/discounts/coupons/{identity}

Esempi di codice

Esempio di richiesta

cURL

PHP

Python

Esempio di risposta 200

Panoramica

Parametri

Parametri del percorso

Risposte

Risposta 200

Stato HTTP

GET`/api/v1/discounts/coupons/{identity}`