콘텐츠로 건너뛰기
ShopentlyLearn

할인 · 생성

할인 · 생성. 모든 코드가 중복 적용을 허용해야 합니다. 할인은 순서대로 적용됩니다.

POST/api/v1/discounts/coupons

인증
Bearer
최소 요금제
STANDARD
필수 권한
discounts.coupons:create

코드 예제

요청 예제

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

응답 예제 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"
  }
}

개요

선택한 상품과 카테고리가 함께 포함됩니다. 카테고리에는 직접 지정된 상품이 포함됩니다.

매개변수

요청 헤더

Idempotency-Key문자열필수

하나의 논리적 쓰기 작업을 식별하는 고유 값입니다.

minLength: 1maxLength: 128
제약 조건
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
예제: "learn-create_campaign_api_v1_discounts_coupons_post"

요청 본문

application/json · 필수

CampaignCreate
audience문자열선택 사항

고객

제약 조건
enum
["all", "guest", "customer", "selected"]
기본값: "all"
benefit_type문자열선택 사항

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["percentage", "fixed", "none"]
기본값: "percentage"
category_ids배열 <문자열> 선택 사항

관련 카테고리 식별자입니다.

maxItems: 1000
제약 조건 · 배열 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
code문자열 null선택 사항

안정적인 기계 판독용 코드입니다.

제약 조건 · 문자열 1
pattern
"^[A-Za-z0-9]{6,16}$"
예제: "LEARN10"
combine_coupons불리언선택 사항

다른 코드와 함께 사용

기본값: false
combine_promotions불리언선택 사항

자동 프로모션 상품에 이 코드 사용 허용

기본값: false
customer_ids배열 <문자열> 선택 사항

이 리소스에 기록된 고객 정보입니다.

maxItems: 1000
제약 조건 · 배열 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_at문자열 null선택 사항

종료 일시

문자열:format: "date-time"
free_shipping불리언선택 사항

무료 배송

기본값: false
markets배열 <MarketData-Input > 필수

스토어 컨텍스트에서 사용할 수 있는 시장입니다.

minItems: 1maxItems: 1000
예제: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantity정수선택 사항

장바구니의 최소 상품 수량

minimum: 1maximum: 2147483647
기본값: 1
name문자열필수

해당 컨텍스트의 리소스 이름입니다.

minLength: 1maxLength: 160
예제: "Autumn guide offer"
per_customer_limit정수선택 사항

고객별 사용 횟수 제한

minimum: -1maximum: 2147483647
기본값: -1
percentage문자열선택 사항

정률

maxLength: 19
제약 조건
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
기본값: "10"
product_ids배열 <문자열> 선택 사항

관련 상품의 식별자입니다.

maxItems: 1000
제약 조건 · 배열 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scope문자열선택 사항

상품

제약 조건
enum
["all", "selected"]
기본값: "all"
show_account불리언선택 사항

고객 계정에

기본값: false
show_cart불리언선택 사항

장바구니에

기본값: false
show_product불리언선택 사항

상품 페이지에

기본값: false
starts_at문자열 null선택 사항

시작 일시

문자열:format: "date-time"
usage_limit정수선택 사항

사용 횟수 제한

minimum: -1maximum: 2147483647
기본값: -1

응답

응답 201

dataMutationData 필수

성공 응답의 데이터입니다.

필드 · data
deleted불리언필수

삭제가 적용되었는지 나타냅니다.

id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다.

version정수 null필수

동시성 제어에 사용하는 리소스 버전입니다.

metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

필드 · meta

ContextPageMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

ContextMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

PageMeta

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

RequestMeta

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100
응답 예제

HTTP 상태

201
리소스 생성됨 스키마
400
잘못된 요청
401
인증 필요
403
권한 없음
404
리소스를 찾을 수 없음
409
버전 충돌
422
유효성 검사 실패
429
요청 한도 초과
기타 HTTP 상태 (7)
405
허용되지 않은 메서드
413
요청이 너무 큼
415
지원하지 않는 형식
500
서버 오류
502
API 게이트웨이 오류
503
서비스 이용 불가
504
시간 초과

오류 목록: ErrorResponse

헤더

201

Location문자열선택 사항

생성된 리소스의 상대 URL입니다.

401

WWW-Authenticate문자열선택 사항

서버가 요구하는 인증 방식입니다.

405

Allow문자열선택 사항

이 리소스가 지원하는 HTTP 메서드입니다.

429, 503

Retry-After정수선택 사항

재시도 전에 기다려야 하는 최소 시간(초)입니다.

minimum: 0