데이터 스키마 · 할인

dataCampaignData 필수

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

예제: {"created_at":"2026-10-07T10:00:00Z","created_by":{"kind":"admin","label":"Editorial integration","reference":"learn-api-key"},"enabled":false,"id":"example-campaign","kind":"coupon","markets":[{"currency":"PLN","market_id":"poland","minor_units":0}],"name":"Autumn guide offer","updated_at":"2026-10-07T10:00:00Z","used_count":0,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

예제: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

추가 필드: 아니요

data배열 <CampaignData > 필수

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

예제: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

예제: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

추가 필드: 아니요

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

추가 필드: 아니요

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}$"

combine_coupons불리언선택 사항

다른 코드와 함께 사용

기본값: false

combine_promotions불리언선택 사항

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

기본값: false

created_at문자열필수

생성 시각입니다.

format: "date-time"

예제: "2026-10-07T10:00:00Z"

created_byCreatorData 필수

생성자

예제: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_ids배열 <문자열> 선택 사항

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

maxItems: 1000

제약 조건 · 배열 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

enabled불리언필수

이 설정이 활성화되어 있는지 나타냅니다.

예제: false

ends_at문자열 | null선택 사항

종료 일시

문자열:format: "date-time"

free_shipping불리언선택 사항

무료 배송

기본값: false

id문자열필수

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

예제: "example-campaign"

kind문자열필수

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

제약 조건

enum

["coupon", "promotion"]

예제: "coupon"

markets배열 <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > 필수

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

minItems: 1maxItems: 1000

예제: [{"currency":"PLN","market_id":"poland","minor_units":0}]

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"

updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-10-07T10:00:00Z"

usage_limit정수선택 사항

사용 횟수 제한

minimum: -1maximum: 2147483647

기본값: -1

used_count정수필수

사용 횟수

예제: 0

version정수필수

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

예제: 1

추가 필드: 아니요

enabled불리언필수

이 설정이 활성화되어 있는지 나타냅니다.

예제: false

expected_version정수필수

쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 1maximum: 9223372036854775807

예제: 1

추가 필드: 아니요

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"

expected_version정수필수

쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 1maximum: 9223372036854775807

예제: 1

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

추가 필드: 아니요

kind문자열필수

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

제약 조건

enum

["admin", "api"]

예제: "admin"

label문자열필수

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

예제: "Editorial integration"

reference문자열필수

참조하는 엔터티의 식별자입니다.

예제: "learn-api-key"

추가 필드: 아니요

currency문자열필수

금액의 통화 코드입니다.

제약 조건

pattern

"^[A-Z]{3}$"

예제: "PLN"

fixed_amount문자열선택 사항

할인 금액

maxLength: 19

제약 조건

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

기본값: "0"

market_id문자열필수

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

제약 조건

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

예제: "poland"

maximum_price문자열 | null선택 사항

최대 상품 가격

문자열:maxLength: 19

제약 조건 · 문자열 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_price문자열 | null선택 사항

최소 상품 가격

문자열:maxLength: 19

제약 조건 · 문자열 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_subtotal문자열선택 사항

최소 장바구니 금액

maxLength: 19

제약 조건

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

기본값: "0"

minor_units정수필수

통화에서 사용하는 소수 자릿수입니다.

minimum: 0maximum: 4

예제: 2

추가 필드: 아니요

currency문자열필수

금액의 통화 코드입니다.

제약 조건

pattern

"^[A-Z]{3}$"

예제: "PLN"

fixed_amount문자열선택 사항

할인 금액

maxLength: 19

제약 조건

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

기본값: "0"

market_id문자열필수

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

제약 조건

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

예제: "poland"

maximum_price문자열 | null선택 사항

최대 상품 가격

문자열:maxLength: 19

제약 조건 · 문자열 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_price문자열 | null선택 사항

최소 상품 가격

문자열:maxLength: 19

제약 조건 · 문자열 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_subtotal문자열선택 사항

최소 장바구니 금액

maxLength: 19

제약 조건

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

기본값: "0"

minor_units정수필수

통화에서 사용하는 소수 자릿수입니다.

minimum: 0maximum: 4

예제: 0

추가 필드: 아니요