العروض الترويجية · عرض القائمة
العروض الترويجية · عرض القائمة. يجب أن يسمح كل رمز بالدمج. تُطبّق الخصومات بالتتابع.
GET/api/v1/discounts/promotions
- المصادقة
Bearer- متاح بدءًا من
- STANDARD
- الصلاحيات المطلوبة
discounts.promotions:read
أمثلة الكود
مثال على الطلب
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
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');
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', 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))
مثال على الاستجابة 200
{
"data": [],
"meta": {
"locale": "example",
"market_code": "example",
"market_id": "poland",
"pagination": {
"has_more": false,
"limit": 1,
"next_cursor": null
},
"request_id": "learn-example-request"
}
}
نظرة عامة
تُجمع المنتجات والفئات المحددة. تشمل الفئات المنتجات المرتبطة بها مباشرة.
المعاملات
معلمات الاستعلام
limitعدد صحيحاختياريالعدد الأقصى للسجلات في هذه الصفحة.
minimum:1maximum:100cursorسلسلة نصية nullاختياريقيمة متابعة معتمة أعادتها الصفحة السابقة.
سلسلة نصية:minLength:1maxLength:1024market_idسلسلة نصية nullاختياريمعرّف السوق الذي تعيده نقطة نهاية السياق.
القيود · سلسلة نصية 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
لا تقبل هذه العملية محتوى JSON.
الاستجابات
الاستجابة 200
النموذج الكامل: ApiResponse_list_CampaignData__
dataمصفوفة <CampaignData> مطلوبمحتوى الاستجابة الناجحة.
الحقول ·
dataaudienceسلسلة نصيةاختياريالعملاء
القيود
enum["all", "guest", "customer", "selected"]
benefit_typeسلسلة نصيةاختياريصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["percentage", "fixed", "none"]
category_idsمصفوفة <سلسلة نصية> اختياريمعرّفات الفئات المرتبطة.
maxItems:1000القيود · مصفوفة 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
codeسلسلة نصية nullاختياريرمز ثابت قابل للقراءة آليًا.
القيود · سلسلة نصية 1
pattern"^[A-Za-z0-9]{6,16}$"
combine_couponsقيمة منطقيةاختياريالدمج مع رموز أخرى
combine_promotionsقيمة منطقيةاختياريالسماح بهذا الرمز للمنتجات المشمولة بعروض تلقائية
created_atسلسلة نصيةمطلوبوقت الإنشاء.
format:"date-time"created_byCreatorDataمطلوبأنشأه
customer_idsمصفوفة <سلسلة نصية> اختياريمعلومات العميل المسجلة لهذا المورد.
maxItems:1000القيود · مصفوفة 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
enabledقيمة منطقيةمطلوبما إذا كان هذا الإعداد مفعّلًا.
ends_atسلسلة نصية nullاختيارينشط حتى
سلسلة نصية:format:"date-time"free_shippingقيمة منطقيةاختياريشحن مجاني
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
kindسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["coupon", "promotion"]
marketsمصفوفة <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData> مطلوبالأسواق المتاحة في سياق المتجر.
minItems:1maxItems:1000minimum_quantityعدد صحيحاختياريالحد الأدنى لعدد القطع في السلة
minimum:1maximum:2147483647nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
minLength:1maxLength:160per_customer_limitعدد صحيحاختياريالحد الأقصى للاستخدامات لكل عميل
minimum:-1maximum:2147483647percentageسلسلة نصيةاختيارينسبة مئوية
maxLength:19القيود
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
product_idsمصفوفة <سلسلة نصية> اختياريمعرّفات المنتجات المرتبطة.
maxItems:1000القيود · مصفوفة 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeسلسلة نصيةاختياريالمنتجات
القيود
enum["all", "selected"]
show_accountقيمة منطقيةاختياريفي حساب العميل
show_cartقيمة منطقيةاختياريفي السلة
show_productقيمة منطقيةاختياريعلى صفحات المنتجات
starts_atسلسلة نصية nullاختيارينشط من
سلسلة نصية:format:"date-time"updated_atسلسلة نصيةمطلوبوقت آخر تحديث.
format:"date-time"usage_limitعدد صحيحاختياريالحد الأقصى للاستخدامات
minimum:-1maximum:2147483647used_countعدد صحيحمطلوبعدد مرات الاستخدام
versionعدد صحيحمطلوبإصدار المورد المستخدم للتحكم في التعديلات المتزامنة.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
الحقول ·
metaالنموذج الكامل:
ContextPageMetalocaleسلسلة نصيةمطلوباللغة المحددة لهذا الطلب.
market_codeسلسلة نصيةمطلوبرمز السوق الذي تعيده نقطة نهاية السياق.
market_idسلسلة نصيةمطلوبمعرّف السوق الذي تعيده نقطة نهاية السياق.
paginationPaginationمطلوبالبيانات الوصفية للترقيم باستخدام المؤشر.
request_idسلسلة نصيةمطلوبمعرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.
minLength:1maxLength:100
localeسلسلة نصيةمطلوباللغة المحددة لهذا الطلب.
market_codeسلسلة نصيةمطلوبرمز السوق الذي تعيده نقطة نهاية السياق.
market_idسلسلة نصيةمطلوبمعرّف السوق الذي تعيده نقطة نهاية السياق.
request_idسلسلة نصيةمطلوبمعرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.
minLength:1maxLength:100
paginationPaginationمطلوبالبيانات الوصفية للترقيم باستخدام المؤشر.
request_idسلسلة نصيةمطلوبمعرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.
minLength:1maxLength:100
request_idسلسلة نصيةمطلوبمعرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.
minLength:1maxLength:100
حالة HTTP
200- استجابة ناجحة المخطط
400- طلب غير صالح
401- المصادقة مطلوبة
403- الإذن مرفوض
404- المورد غير موجود
409- تعارض الإصدارات
422- فشل التحقق من البيانات
429- تم تجاوز حد الطلبات
حالات HTTP الأخرى (7)
405- الطريقة غير مسموحة
413- الطلب كبير جدًا
415- تنسيق غير مدعوم
500- خطأ في الخادم
502- خطأ في بوابة API
503- الخدمة غير متاحة
504- انتهت مهلة الانتظار
دليل الأخطاء: ErrorResponse
الترويسات
401
WWW-Authenticateسلسلة نصيةاختيارينظام المصادقة الذي يطلبه الخادم.
405
Allowسلسلة نصيةاختياريطرق HTTP التي يدعمها هذا المورد.
429, 503
Retry-Afterعدد صحيحاختياريالحد الأدنى للانتظار قبل إعادة المحاولة، بالثواني.
minimum:0