Promoții · Listează

Promoții · Listează. Fiecare cod trebuie să permită combinarea. Reducerile se aplică în ordine.

GET`/api/v1/discounts/promotions`

Autentificare: Bearer
Disponibil începând cu: STANDARD
Permisiuni necesare: discounts.promotions:read

Exemplu de cerere

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

Exemplu de răspuns 200

JSON

{
  "data": [],
  "meta": {
    "locale": "example",
    "market_code": "example",
    "market_id": "poland",
    "pagination": {
      "has_more": false,
      "limit": 1,
      "next_cursor": null
    },
    "request_id": "learn-example-request"
  }
}

Prezentare generală

Produsele și categoriile selectate se reunesc. Categoriile includ produsele atribuite direct.

Scrieri sigure

Permisiuni și planuri

Parametri

Parametri de interogare

limitNumăr întregOpțional

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100

Valoare implicită: 50

cursorȘir de caractere nullOpțional

Valoare opacă de continuare returnată de pagina anterioară.

Șir de caractere:minLength: 1maxLength: 1024

market_idȘir de caractere nullOpțional

Identificatorul pieței returnat de endpointul de context.

Restricții · Șir de caractere 1

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

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

Model complet: ApiResponse_list_CampaignData__

dataTablou <CampaignData > Obligatoriu

Datele unui răspuns reușit.

Câmpuri · data

CampaignData

Model complet: CampaignData

audienceȘir de caractereOpțional

Clienți

Restricții

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

Valoare implicită: "all"

benefit_typeȘir de caractereOpțional

Varianta structurii de date, descrisă prin valorile permise.

Restricții

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

Valoare implicită: "percentage"

category_idsTablou <Șir de caractere> Opțional

Identificatorii categoriilor asociate.

maxItems: 1000

Restricții · Tablou 1

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

codeȘir de caractere nullOpțional

Cod stabil, destinat prelucrării automate.

Restricții · Șir de caractere 1

pattern: "^[A-Za-z0-9]{6,16}$"

combine_couponsValoare booleanăOpțional

Combină cu alte coduri

Valoare implicită: false

combine_promotionsValoare booleanăOpțional

Permite acest cod pentru produsele cu promoții automate

Valoare implicită: false

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

created_byCreatorData Obligatoriu

Creat de

customer_idsTablou <Șir de caractere> Opțional

Datele clientului înregistrate pentru această resursă.

maxItems: 1000

Restricții · Tablou 1

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

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

ends_atȘir de caractere nullOpțional

Activ până la

Șir de caractere:format: "date-time"

free_shippingValoare booleanăOpțional

Livrare gratuită

Valoare implicită: false

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum: ["coupon", "promotion"]

marketsTablou <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatoriu

Piețele disponibile în contextul magazinului.

minItems: 1maxItems: 1000

minimum_quantityNumăr întregOpțional

Numărul minim de articole din coș

minimum: 1maximum: 2147483647

Valoare implicită: 1

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 160

per_customer_limitNumăr întregOpțional

Limită de utilizări per client

minimum: -1maximum: 2147483647

Valoare implicită: -1

percentageȘir de caractereOpțional

Procent

maxLength: 19

Restricții

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

Valoare implicită: "10"

product_idsTablou <Șir de caractere> Opțional

Identificatorii produselor asociate.

maxItems: 1000

Restricții · Tablou 1

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

product_scopeȘir de caractereOpțional

Produse

Restricții

enum: ["all", "selected"]

Valoare implicită: "all"

show_accountValoare booleanăOpțional

În contul clientului

Valoare implicită: false

show_cartValoare booleanăOpțional

În coș

Valoare implicită: false

show_productValoare booleanăOpțional

Pe paginile produselor

Valoare implicită: false

starts_atȘir de caractere nullOpțional

Activ de la

Șir de caractere:format: "date-time"

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

usage_limitNumăr întregOpțional

Limită de utilizări

minimum: -1maximum: 2147483647

Valoare implicită: -1

used_countNumăr întregObligatoriu

Utilizări efectuate

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Câmpuri · meta

ContextPageMeta

Model complet: ContextPageMeta

localeȘir de caractereObligatoriu: Limba selectată pentru această cerere.
market_codeȘir de caractereObligatoriu: Codul pieței returnat de endpointul de context.
market_idȘir de caractereObligatoriu: Identificatorul pieței returnat de endpointul de context.
paginationPagination Obligatoriu: Metadatele paginării prin cursor.
request_idȘir de caractereObligatoriu: Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength: 1maxLength: 100

ContextMeta

Model complet: ContextMeta

localeȘir de caractereObligatoriu: Limba selectată pentru această cerere.
market_codeȘir de caractereObligatoriu: Codul pieței returnat de endpointul de context.
market_idȘir de caractereObligatoriu: Identificatorul pieței returnat de endpointul de context.
request_idȘir de caractereObligatoriu: Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength: 1maxLength: 100

PageMeta

Model complet: PageMeta

paginationPagination Obligatoriu: Metadatele paginării prin cursor.
request_idȘir de caractereObligatoriu: Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength: 1maxLength: 100

RequestMeta

Model complet: RequestMeta

request_idȘir de caractereObligatoriu: Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength: 1maxLength: 100

Exemplu de răspuns

Stare HTTP

200: Răspuns reușit Schemă
400: Cerere nevalidă
401: Autentificare necesară
403: Acces refuzat
404: Resursa nu a fost găsită
409: Conflict de versiune
422: Validare eșuată
429: Limită de cereri depășită

Alte stări HTTP (7)

405: Metodă nepermisă
413: Cerere prea mare
415: Format neacceptat
500: Eroare de server
502: Eroare de gateway API
503: Serviciu indisponibil
504: Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional: Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional: Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional: Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0

Catalog de erori · Află mai multe

GET/api/v1/discounts/promotions

Exemple de cod

Exemplu de cerere

cURL

PHP

Python

Exemplu de răspuns 200

Prezentare generală

Parametri

Parametri de interogare

Răspunsuri

Răspuns 200

Stare HTTP

GET`/api/v1/discounts/promotions`