Preskoči na vsebino
ShopentlyLearn

Popusti · Ustvari

Popusti · Ustvari. Vsaka koda mora dovoljevati združevanje. Popusti se obračunajo zaporedno.

POST/api/v1/discounts/coupons

Preverjanje pristnosti
Bearer
Na voljo od paketa
STANDARD
Zahtevana dovoljenja
discounts.coupons:create

Primeri kode

Primer zahteve

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

Primer odgovora 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"
  }
}

Pregled

Izbrani izdelki in kategorije se združijo. Kategorije vključujejo neposredno dodeljene izdelke.

Parametri

Glave zahteve

Idempotency-KeyNizObvezno

Enolični identifikator ene logične operacije zapisa.

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

Telo zahteve

application/json · Obvezno

CampaignCreate
audienceNizIzbirno

Kupci

Omejitve
enum
["all", "guest", "customer", "selected"]
Privzeto: "all"
benefit_typeNizIzbirno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["percentage", "fixed", "none"]
Privzeto: "percentage"
category_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih kategorij.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeNiz nullIzbirno

Stabilna strojno berljiva koda.

Omejitve · Niz 1
pattern
"^[A-Za-z0-9]{6,16}$"
Primer: "LEARN10"
combine_couponsLogična vrednostIzbirno

Združi z drugimi kodami

Privzeto: false
combine_promotionsLogična vrednostIzbirno

Dovoli to kodo za izdelke s samodejnimi akcijami

Privzeto: false
customer_idsPolje elementov <Niz> Izbirno

Podatki stranke, zabeleženi za ta vir.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atNiz nullIzbirno

Aktivno do

Niz:format: "date-time"
free_shippingLogična vrednostIzbirno

Brezplačna dostava

Privzeto: false
marketsPolje elementov <MarketData-Input > Obvezno

Trgi, razpoložljivi v kontekstu trgovine.

minItems: 1maxItems: 1000
Primer: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityCelo številoIzbirno

Najmanjše število kosov v košarici

minimum: 1maximum: 2147483647
Privzeto: 1
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160
Primer: "Autumn guide offer"
per_customer_limitCelo številoIzbirno

Omejitev uporab na kupca

minimum: -1maximum: 2147483647
Privzeto: -1
percentageNizIzbirno

Odstotek

maxLength: 19
Omejitve
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Privzeto: "10"
product_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih izdelkov.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeNizIzbirno

Izdelki

Omejitve
enum
["all", "selected"]
Privzeto: "all"
show_accountLogična vrednostIzbirno

V računu kupca

Privzeto: false
show_cartLogična vrednostIzbirno

V košarici

Privzeto: false
show_productLogična vrednostIzbirno

Na straneh izdelkov

Privzeto: false
starts_atNiz nullIzbirno

Aktivno od

Niz:format: "date-time"
usage_limitCelo številoIzbirno

Omejitev uporab

minimum: -1maximum: 2147483647
Privzeto: -1

Odgovori

Odgovor 201

dataMutationData Obvezno

Vsebina uspešnega odgovora.

Polja · data
deletedLogična vrednostObvezno

Ali je bilo brisanje izvedeno.

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

versionCelo število nullObvezno

Različica vira za nadzor sočasnosti.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodatki odgovora.

Polja · meta

ContextPageMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

ContextMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100
Primer odgovora

Status HTTP

201
Vir ustvarjen Shema
400
Neveljavna zahteva
401
Potrebna je avtentikacija
403
Dostop zavrnjen
404
Vir ni najden
409
Spor različic
422
Preverjanje ni uspelo
429
Presežena omejitev zahtev
Druga stanja HTTP (7)
405
Metoda ni dovoljena
413
Zahteva je prevelika
415
Nepodprta oblika
500
Napaka strežnika
502
Napaka prehoda API
503
Storitev ni na voljo
504
Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

201

LocationNizIzbirno

Relativni URL ustvarjenega vira.

401

WWW-AuthenticateNizIzbirno

Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno

Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno

Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0