Pređi na sadržaj
ShopentlyLearn

Popusti · Ažuriraj

Popusti · Ažuriraj. Svaki kod mora dozvoljavati kombinovanje. Popusti se primenjuju redom.

PATCH/api/v1/discounts/coupons/{identity}

Autentifikacija
Bearer
Dostupno od
STANDARD
Potrebna ovlašćenja
discounts.coupons:update

Primeri koda

Primer zahteva

cURL

: "${SHOPENTLY_SHOP_URL:?}"

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

Primer odgovora 200

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

Izabrani proizvodi i kategorije se objedinjuju. Kategorije obuhvataju direktno dodeljene proizvode.

Parametri

Parametri putanje

identityNiz znakovaObavezno

Identifikator korišćen u putanji ovog resursa.

Ograničenja
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example-campaign"

Zaglavlja zahteva

Idempotency-KeyNiz znakovaObavezno

Jedinstveni identifikator jedne logičke operacije upisa.

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

Telo zahteva

application/json · Obavezno

CampaignUpdate
audienceNiz znakovaOpciono

Kupci

Ograničenja
enum
["all", "guest", "customer", "selected"]
Podrazumevano: "all"
benefit_typeNiz znakovaOpciono

Varijanta strukture podataka opisana dozvoljenim vrednostima.

Ograničenja
enum
["percentage", "fixed", "none"]
Podrazumevano: "percentage"
category_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih kategorija.

maxItems: 1000
Ograničenja · Niz vrednosti 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeNiz znakova nullOpciono

Stabilan mašinski čitljiv kod.

Ograničenja · Niz znakova 1
pattern
"^[A-Za-z0-9]{6,16}$"
Primer: "LEARN10"
combine_couponsLogička vrednostOpciono

Kombinuj sa drugim kodovima

Podrazumevano: false
combine_promotionsLogička vrednostOpciono

Dozvoli ovaj kod za proizvode sa automatskim promocijama

Podrazumevano: false
customer_idsNiz vrednosti <Niz znakova> Opciono

Podaci kupca zabeleženi za ovaj resurs.

maxItems: 1000
Ograničenja · Niz vrednosti 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atNiz znakova nullOpciono

Aktivno do

Niz znakova:format: "date-time"
expected_versionCeli brojObavezno

Verzija pročitana pre upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 9223372036854775807
Primer: 1
free_shippingLogička vrednostOpciono

Besplatna dostava

Podrazumevano: false
marketsNiz vrednosti <MarketData-Input > Obavezno

Tržišta dostupna u kontekstu prodavnice.

minItems: 1maxItems: 1000
Primer: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityCeli brojOpciono

Minimalni broj artikala u korpi

minimum: 1maximum: 2147483647
Podrazumevano: 1
nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160
Primer: "Autumn guide offer"
per_customer_limitCeli brojOpciono

Ograničenje korišćenja po kupcu

minimum: -1maximum: 2147483647
Podrazumevano: -1
percentageNiz znakovaOpciono

Procenat

maxLength: 19
Ograničenja
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Podrazumevano: "10"
product_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih proizvoda.

maxItems: 1000
Ograničenja · Niz vrednosti 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeNiz znakovaOpciono

Proizvodi

Ograničenja
enum
["all", "selected"]
Podrazumevano: "all"
show_accountLogička vrednostOpciono

Na nalogu kupca

Podrazumevano: false
show_cartLogička vrednostOpciono

U korpi

Podrazumevano: false
show_productLogička vrednostOpciono

Na stranicama proizvoda

Podrazumevano: false
starts_atNiz znakova nullOpciono

Aktivno od

Niz znakova:format: "date-time"
usage_limitCeli brojOpciono

Ograničenje korišćenja

minimum: -1maximum: 2147483647
Podrazumevano: -1

Odgovori

Odgovor 200

dataMutationData Obavezno

Podaci uspešnog odgovora.

Polja · data
deletedLogička vrednostObavezno

Da li je brisanje primenjeno.

idNiz znakovaObavezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

versionCeli broj nullObavezno

Verzija resursa za kontrolu istovremenih upisa.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno

Metapodaci odgovora.

Polja · meta

ContextPageMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

ContextMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

RequestMeta

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer odgovora

HTTP status

200
Uspešan odgovor Šema
400
Nevažeći zahtev
401
Potrebna je autentifikacija
403
Pristup odbijen
404
Resurs nije pronađen
409
Sukob verzija
422
Provera nije uspela
429
Prekoračeno ograničenje zahteva
Ostali HTTP statusi (7)
405
Metoda nije dozvoljena
413
Zahtev je prevelik
415
Nepodržan format
500
Greška servera
502
Greška API mrežnog prolaza
503
Usluga nije dostupna
504
Istek vremena

Katalog grešaka: ErrorResponse

Zaglavlja

401

WWW-AuthenticateNiz znakovaOpciono

Šema autentifikacije koju zahteva server.

405

AllowNiz znakovaOpciono

HTTP metode koje ovaj resurs podržava.

429, 503

Retry-AfterCeli brojOpciono

Najkraće čekanje pre ponavljanja, u sekundama.

minimum: 0