Mine sisu juurde
ShopentlyLearn

Allahindlused · Loo

Allahindlused · Loo. Kõik koodid peavad lubama kombineerimist. Soodustused arvutatakse järjest.

POST/api/v1/discounts/coupons

Autentimine
Bearer
Saadaval alates
STANDARD
Nõutavad õigused
discounts.coupons:create

Koodinäited

Päringu näide

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: learn-create_campaign_api_v1_discounts_coupons_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "code": "LEARN10",
  "markets": [
    {
      "currency": "PLN",
      "market_id": "poland",
      "minor_units": 2
    }
  ],
  "name": "Autumn guide offer"
}' \
  --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 = ['Idempotency-Key: learn-create_campaign_api_v1_discounts_coupons_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/coupons');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    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);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
  "code": "LEARN10",
  "markets": [
    {
      "currency": "PLN",
      "market_id": "poland",
      "minor_units": 2
    }
  ],
  "name": "Autumn guide offer"
}');
$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 = {'Idempotency-Key': 'learn-create_campaign_api_v1_discounts_coupons_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "code": "LEARN10",\n  "markets": [\n    {\n      "currency": "PLN",\n      "market_id": "poland",\n      "minor_units": 2\n    }\n  ],\n  "name": "Autumn guide offer"\n}'
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(
        'POST', 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))

Vastuse näide 201

JSON
{
  "data": {
    "deleted": false,
    "id": "example-campaign",
    "version": null
  },
  "meta": {
    "locale": "example",
    "market_code": "example",
    "market_id": "poland",
    "pagination": {
      "has_more": false,
      "limit": 1,
      "next_cursor": null
    },
    "request_id": "learn-example-request"
  }
}

Ülevaade

Valitud tooted ja kategooriad ühendatakse. Kategooriad hõlmavad otse määratud tooteid.

Parameetrid

Päringu päised

Idempotency-KeyStringKohustuslik

Ühe loogilise muutmistoimingu kordumatu identifikaator.

minLength: 1maxLength: 128
Piirangud
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Näide: "learn-create_campaign_api_v1_discounts_coupons_post"

Päringu sisu

application/json · Kohustuslik

CampaignCreate
audienceStringValikuline

Kliendid

Piirangud
enum
["all", "guest", "customer", "selected"]
Vaikeväärtus: "all"
benefit_typeStringValikuline

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["percentage", "fixed", "none"]
Vaikeväärtus: "percentage"
category_idsMassiiv <String> Valikuline

Seotud kategooriate identifikaatorid.

maxItems: 1000
Piirangud · Massiiv 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeString nullValikuline

Püsiv masinloetav kood.

Piirangud · String 1
pattern
"^[A-Za-z0-9]{6,16}$"
Näide: "LEARN10"
combine_couponsTõeväärtusValikuline

Kombineeri teiste koodidega

Vaikeväärtus: false
combine_promotionsTõeväärtusValikuline

Luba seda koodi automaatsete kampaaniatega toodetele

Vaikeväärtus: false
customer_idsMassiiv <String> Valikuline

Selle ressursi juurde salvestatud klienditeave.

maxItems: 1000
Piirangud · Massiiv 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atString nullValikuline

Aktiivne kuni

String:format: "date-time"
free_shippingTõeväärtusValikuline

Tasuta tarne

Vaikeväärtus: false
marketsMassiiv <MarketData-Input > Kohustuslik

Poe kontekstis saadaolevad turud.

minItems: 1maxItems: 1000
Näide: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityTäisarvValikuline

Minimaalne toodete arv ostukorvis

minimum: 1maximum: 2147483647
Vaikeväärtus: 1
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160
Näide: "Autumn guide offer"
per_customer_limitTäisarvValikuline

Kasutuskordade piirang kliendi kohta

minimum: -1maximum: 2147483647
Vaikeväärtus: -1
percentageStringValikuline

Protsent

maxLength: 19
Piirangud
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Vaikeväärtus: "10"
product_idsMassiiv <String> Valikuline

Seotud toodete identifikaatorid.

maxItems: 1000
Piirangud · Massiiv 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeStringValikuline

Tooted

Piirangud
enum
["all", "selected"]
Vaikeväärtus: "all"
show_accountTõeväärtusValikuline

Kliendikontol

Vaikeväärtus: false
show_cartTõeväärtusValikuline

Ostukorvis

Vaikeväärtus: false
show_productTõeväärtusValikuline

Tootelehtedel

Vaikeväärtus: false
starts_atString nullValikuline

Aktiivne alates

String:format: "date-time"
usage_limitTäisarvValikuline

Kasutuskordade piirang

minimum: -1maximum: 2147483647
Vaikeväärtus: -1

Vastused

Vastus 201

dataMutationData Kohustuslik

Eduka vastuse andmed.

Väljad · data
deletedTõeväärtusKohustuslik

Kas kustutamine rakendati.

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

versionTäisarv nullKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

Väljad · meta

ContextPageMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

ContextMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

PageMeta

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

RequestMeta

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Vastuse näide

HTTP-olek

201
Ressurss loodud Skeem
400
Vigane päring
401
Autentimine on nõutav
403
Juurdepääs keelatud
404
Ressurssi ei leitud
409
Versioonikonflikt
422
Valideerimine nurjus
429
Päringupiirang ületatud
Muud HTTP olekud (7)
405
Meetod pole lubatud
413
Päring on liiga suur
415
Vormingut ei toetata
500
Serveri viga
502
API lüüsi viga
503
Teenus pole saadaval
504
Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

201

LocationStringValikuline

Loodud ressursi suhteline URL.

401

WWW-AuthenticateStringValikuline

Serveri nõutav autentimisskeem.

405

AllowStringValikuline

Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline

Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0