Přejít na obsah
ShopentlyLearn

Slevy · Vypsat

Slevy · Vypsat. Každý kód musí povolit kombinování. Slevy se počítají postupně.

GET/api/v1/discounts/coupons

Ověřování
Bearer
Dostupné od tarifu
STANDARD
Požadovaná oprávnění
discounts.coupons:read

Příklady kódu

Příklad požadavku

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

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');
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', 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))

Příklad odpovědi 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"
  }
}

Přehled

Vybrané produkty a kategorie se spojují. Kategorie zahrnují přímo přiřazené produkty.

Parametry

Parametry dotazu

limitCelé čísloVolitelné

Maximální počet záznamů na této stránce.

minimum: 1maximum: 100
Výchozí hodnota: 50
cursorŘetězec nullVolitelné

Neprůhledná hodnota pro pokračování vrácená předchozí stránkou.

Řetězec:minLength: 1maxLength: 1024
market_idŘetězec nullVolitelné

Identifikátor trhu vrácený koncovým bodem kontextu.

Omezení · Řetězec 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"

Tato operace nepřijímá tělo JSON.

Odpovědi

Odpověď 200

dataPole <CampaignData > Povinné

Obsah úspěšné odpovědi.

Pole · data

CampaignData

audienceŘetězecVolitelné

Zákazníci

Omezení
enum
["all", "guest", "customer", "selected"]

Výchozí hodnota: "all"

benefit_typeŘetězecVolitelné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["percentage", "fixed", "none"]

Výchozí hodnota: "percentage"

category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 1000
Omezení · Pole 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeŘetězec nullVolitelné

Stabilní strojově čitelný kód.

Omezení · Řetězec 1
pattern
"^[A-Za-z0-9]{6,16}$"
combine_couponsLogická hodnotaVolitelné

Kombinovat s dalšími kódy

Výchozí hodnota: false

combine_promotionsLogická hodnotaVolitelné

Povolit tento kód u produktů s automatickými akcemi

Výchozí hodnota: false

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
created_byCreatorData Povinné

Vytvořil

customer_idsPole <Řetězec> Volitelné

Údaje zákazníka zaznamenané u tohoto zdroje.

maxItems: 1000
Omezení · Pole 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

ends_atŘetězec nullVolitelné

Aktivní do

Řetězec:format: "date-time"
free_shippingLogická hodnotaVolitelné

Doprava zdarma

Výchozí hodnota: false

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["coupon", "promotion"]
marketsPole <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Povinné

Trhy dostupné v kontextu obchodu.

minItems: 1maxItems: 1000
minimum_quantityCelé čísloVolitelné

Minimální počet kusů v košíku

minimum: 1maximum: 2147483647

Výchozí hodnota: 1

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160
per_customer_limitCelé čísloVolitelné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

percentageŘetězecVolitelné

Procentní

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

Výchozí hodnota: "10"

product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 1000
Omezení · Pole 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeŘetězecVolitelné

Produkty

Omezení
enum
["all", "selected"]

Výchozí hodnota: "all"

show_accountLogická hodnotaVolitelné

V zákaznickém účtu

Výchozí hodnota: false

show_cartLogická hodnotaVolitelné

V košíku

Výchozí hodnota: false

show_productLogická hodnotaVolitelné

Na stránkách produktů

Výchozí hodnota: false

starts_atŘetězec nullVolitelné

Aktivní od

Řetězec:format: "date-time"
updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
usage_limitCelé čísloVolitelné

Limit použití

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

used_countCelé čísloPovinné

Počet použití

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Pole · meta

ContextPageMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

ContextMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0