Προσφορές · Ανάκτηση

Προσφορές · Ανάκτηση. Κάθε κωδικός πρέπει να επιτρέπει συνδυασμούς. Οι εκπτώσεις εφαρμόζονται διαδοχικά.

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

Έλεγχος ταυτότητας: 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/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))

Παράδειγμα απόκρισης 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"
  }
}

Επισκόπηση

Τα επιλεγμένα προϊόντα και οι κατηγορίες συνδυάζονται. Οι κατηγορίες περιλαμβάνουν τα προϊόντα που ανήκουν άμεσα σε αυτές.

Ασφαλείς εγγραφές

Δικαιώματα και προγράμματα

Παράμετροι

Παράμετροι διαδρομής

identityΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό που χρησιμοποιείται στη διαδρομή αυτού του πόρου.

Περιορισμοί

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

Παράδειγμα: "example-campaign"

Αυτή η λειτουργία δεν δέχεται περιεχόμενο JSON.

Αποκρίσεις

Απόκριση 200

Πλήρες μοντέλο: ApiResponse_CampaignData_

dataCampaignData Υποχρεωτικό

Δεδομένα επιτυχούς απόκρισης.

Πεδία · data

Πλήρες μοντέλο: CampaignData

audienceΣυμβολοσειράΠροαιρετικό

Πελάτες

Περιορισμοί

enum: ["all", "guest", "customer", "selected"]

Προεπιλογή: "all"

benefit_typeΣυμβολοσειράΠροαιρετικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum: ["percentage", "fixed", "none"]

Προεπιλογή: "percentage"

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Λογική τιμήΠροαιρετικό

Συνδυασμός με άλλους κωδικούς

Προεπιλογή: false

combine_promotionsΛογική τιμήΠροαιρετικό

Να επιτρέπεται αυτός ο κωδικός σε προϊόντα με αυτόματες προσφορές

Προεπιλογή: false

created_atΣυμβολοσειράΥποχρεωτικό

Χρόνος δημιουργίας.

format: "date-time"

created_byCreatorData Υποχρεωτικό

Δημιουργήθηκε από

Πεδία · created_by

Πλήρες μοντέλο: CreatorData

kindΣυμβολοσειράΥποχρεωτικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum: ["admin", "api"]

labelΣυμβολοσειράΥποχρεωτικό

Όνομα πόρου στο σχετικό πλαίσιο.

referenceΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό της αναφερόμενης οντότητας.

customer_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.

maxItems: 1000

Περιορισμοί · Πίνακας 1

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

enabledΛογική τιμήΥποχρεωτικό

Δείχνει αν η ρύθμιση είναι ενεργοποιημένη.

ends_atΣυμβολοσειρά nullΠροαιρετικό

Ενεργό έως

Συμβολοσειρά:format: "date-time"

free_shippingΛογική τιμήΠροαιρετικό

Δωρεάν αποστολή

Προεπιλογή: false

idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.

kindΣυμβολοσειράΥποχρεωτικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum: ["coupon", "promotion"]

marketsΠίνακας <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Υποχρεωτικό

Αγορές διαθέσιμες στο πλαίσιο του καταστήματος.

minItems: 1maxItems: 1000

Πεδία · markets

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData

Πλήρες μοντέλο: shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData

minimum_quantityΑκέραιοςΠροαιρετικό

Ελάχιστος αριθμός τεμαχίων στο καλάθι

minimum: 1maximum: 2147483647

Προεπιλογή: 1

nameΣυμβολοσειράΥποχρεωτικό

Όνομα πόρου στο σχετικό πλαίσιο.

minLength: 1maxLength: 160

per_customer_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων ανά πελάτη

minimum: -1maximum: 2147483647

Προεπιλογή: -1

percentageΣυμβολοσειράΠροαιρετικό

Ποσοστό

maxLength: 19

Περιορισμοί

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Προεπιλογή: "10"

product_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών προϊόντων.

maxItems: 1000

Περιορισμοί · Πίνακας 1

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

product_scopeΣυμβολοσειράΠροαιρετικό

Προϊόντα

Περιορισμοί

enum: ["all", "selected"]

Προεπιλογή: "all"

show_accountΛογική τιμήΠροαιρετικό

Στον λογαριασμό πελάτη

Προεπιλογή: false

show_cartΛογική τιμήΠροαιρετικό

Στο καλάθι

Προεπιλογή: false

show_productΛογική τιμήΠροαιρετικό

Στις σελίδες προϊόντων

Προεπιλογή: false

starts_atΣυμβολοσειρά nullΠροαιρετικό

Ενεργό από

Συμβολοσειρά:format: "date-time"

updated_atΣυμβολοσειράΥποχρεωτικό

Χρόνος τελευταίας ενημέρωσης.

format: "date-time"

usage_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων

minimum: -1maximum: 2147483647

Προεπιλογή: -1

used_countΑκέραιοςΥποχρεωτικό

Αριθμός χρήσεων

versionΑκέραιοςΥποχρεωτικό

Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.

metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

Μεταδεδομένα απόκρισης.

Πεδία · meta

ContextPageMeta

Πλήρες μοντέλο: ContextPageMeta

localeΣυμβολοσειράΥποχρεωτικό: Γλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_codeΣυμβολοσειράΥποχρεωτικό: Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
market_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
paginationPagination Υποχρεωτικό: Μεταδεδομένα σελιδοποίησης με cursor.
request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

ContextMeta

Πλήρες μοντέλο: ContextMeta

localeΣυμβολοσειράΥποχρεωτικό: Γλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_codeΣυμβολοσειράΥποχρεωτικό: Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
market_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

PageMeta

Πλήρες μοντέλο: PageMeta

paginationPagination Υποχρεωτικό: Μεταδεδομένα σελιδοποίησης με cursor.
request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

RequestMeta

Πλήρες μοντέλο: RequestMeta

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

Κατάλογος σφαλμάτων · Μάθετε περισσότερα

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

Παραδείγματα κώδικα

Παράδειγμα αιτήματος

cURL

PHP

Python

Παράδειγμα απόκρισης 200

Επισκόπηση

Παράμετροι

Παράμετροι διαδρομής

Αποκρίσεις

Απόκριση 200

Κατάσταση HTTP

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