Kampanjer · Hämta
Kampanjer · Hämta. Alla koder måste tillåta kombinationer. Rabatterna beräknas i ordning.
GET/api/v1/discounts/promotions/{identity}
- Autentisering
Bearer- Tillgänglig från
- STANDARD
- Behörigheter som krävs
discounts.promotions:read
Kodexempel
Exempel på begäran
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/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 = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/promotions/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/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))
Exempel på svar 200
{
"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"
}
}
Översikt
Valda produkter och kategorier kombineras. Kategorier omfattar direkt tilldelade produkter.
Parametrar
Sökvägsparametrar
identitySträngObligatorisktIdentifierare som används i resursens sökväg.
Begränsningar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Den här operationen tar inte emot JSON-innehåll.
Svar
Svar 200
Fullständig modell: ApiResponse_CampaignData_
dataCampaignDataObligatorisktInnehållet i ett lyckat svar.
Fält ·
dataFullständig modell:
CampaignDataaudienceSträngValfrittKunder
Begränsningar
enum["all", "guest", "customer", "selected"]
benefit_typeSträngValfrittVariant av datastrukturen, enligt dess tillåtna värden.
Begränsningar
enum["percentage", "fixed", "none"]
category_idsArray <Sträng> ValfrittIdentifierare för relaterade kategorier.
maxItems:1000Begränsningar · Array 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
codeSträng nullValfrittStabil maskinläsbar kod.
Begränsningar · Sträng 1
pattern"^[A-Za-z0-9]{6,16}$"
combine_couponsBooleskt värdeValfrittKombinera med andra koder
combine_promotionsBooleskt värdeValfrittTillåt denna kod på produkter med automatiska kampanjer
created_atSträngObligatorisktTidpunkt för skapande.
format:"date-time"created_byCreatorDataObligatorisktSkapad av
Fält ·
created_byFullständig modell:
CreatorDatakindSträngObligatorisktVariant av datastrukturen, enligt dess tillåtna värden.
Begränsningar
enum["admin", "api"]
labelSträngObligatorisktResursens namn i aktuell kontext.
referenceSträngObligatorisktIdentifierare för den refererade entiteten.
customer_idsArray <Sträng> ValfrittKunduppgifter registrerade för resursen.
maxItems:1000Begränsningar · Array 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
enabledBooleskt värdeObligatorisktAnger om inställningen är aktiverad.
ends_atSträng nullValfrittAktiv till
Sträng:format:"date-time"free_shippingBooleskt värdeValfrittFri frakt
idSträngObligatorisktResursens identifierare; bevara den som den returneras.
kindSträngObligatorisktVariant av datastrukturen, enligt dess tillåtna värden.
Begränsningar
enum["coupon", "promotion"]
marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData> ObligatorisktMarknader som är tillgängliga i butikens kontext.
minItems:1maxItems:1000minimum_quantityHeltalValfrittMinsta antal artiklar i varukorgen
minimum:1maximum:2147483647nameSträngObligatorisktResursens namn i aktuell kontext.
minLength:1maxLength:160per_customer_limitHeltalValfrittAnvändningsgräns per kund
minimum:-1maximum:2147483647percentageSträngValfrittProcent
maxLength:19Begränsningar
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
product_idsArray <Sträng> ValfrittIdentifierare för relaterade produkter.
maxItems:1000Begränsningar · Array 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeSträngValfrittProdukter
Begränsningar
enum["all", "selected"]
show_accountBooleskt värdeValfrittPå kundkontot
show_cartBooleskt värdeValfrittI varukorgen
show_productBooleskt värdeValfrittPå produktsidor
starts_atSträng nullValfrittAktiv från
Sträng:format:"date-time"updated_atSträngObligatorisktTidpunkt för senaste uppdatering.
format:"date-time"usage_limitHeltalValfrittAnvändningsgräns
minimum:-1maximum:2147483647used_countHeltalObligatorisktAntal användningar
versionHeltalObligatorisktResursversion för samtidighetskontroll.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatorisktMetadata för svaret.
Fält ·
metaFullständig modell:
ContextPageMetalocaleSträngObligatorisktSpråk valt för denna begäran.
market_codeSträngObligatorisktMarknadskod returnerad av kontextendpointen.
market_idSträngObligatorisktMarknadsidentifierare returnerad av kontextendpointen.
paginationPaginationObligatorisktMetadata för markörbaserad paginering.
request_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
Fullständig modell:
ContextMetalocaleSträngObligatorisktSpråk valt för denna begäran.
market_codeSträngObligatorisktMarknadskod returnerad av kontextendpointen.
market_idSträngObligatorisktMarknadsidentifierare returnerad av kontextendpointen.
request_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
paginationPaginationObligatorisktMetadata för markörbaserad paginering.
request_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
Fullständig modell:
RequestMetarequest_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
HTTP-status
200- Lyckat svar Schema
400- Ogiltig begäran
401- Autentisering krävs
403- Åtkomst nekad
404- Resursen hittades inte
409- Versionskonflikt
422- Valideringen misslyckades
429- Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405- Metoden tillåts inte
413- För stor begäran
415- Formatet stöds inte
500- Serverfel
502- Fel i API-gateway
503- Tjänsten är inte tillgänglig
504- Tidsgränsen överskreds
Felkatalog: ErrorResponse
HTTP-huvuden
401
WWW-AuthenticateSträngValfrittAutentiseringsschema som servern kräver.
405
AllowSträngValfrittHTTP-metoder som resursen stöder.
429, 503
Retry-AfterHeltalValfrittMinsta väntetid före ett nytt försök, i sekunder.
minimum:0