데이터 스키마: 옵션 상품과 옵션

데이터 스키마: 옵션 상품과 옵션. API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

데이터 스키마

목록 조회 · 상품 변형 — 옵션 상품과 옵션 — 응답

ApiResponse_list_ProductVariantData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

data배열 <ProductVariantData > 필수: 응답 예제 · ApiResponse_list_ProductVariantData__.

예제: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

목록 조회 · 옵션 — 옵션 상품과 옵션 — 응답

ApiResponse_list_VariantOptionData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

data배열 <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > 필수: 응답 예제 · ApiResponse_list_VariantOptionData__.

예제: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

목록 조회 · 옵션 값 — 옵션 상품과 옵션 — 응답

ApiResponse_list_VariantValueData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

data배열 <VariantValueData > 필수: 응답 예제 · ApiResponse_list_VariantValueData__.

예제: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

조회 · 상품 변형 — 옵션 상품과 옵션 — 응답

ApiResponse_ProductVariantData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

dataProductVariantData 필수: 응답 예제 · ProductVariantData.

예제: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

추가 필드: 아니요

조회 · 옵션 — 옵션 상품과 옵션 — 응답

ApiResponse_VariantOptionData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData 필수: 응답 예제 · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

예제: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

추가 필드: 아니요

조회 · 옵션 값 — 옵션 상품과 옵션 — 응답

ApiResponse_VariantValueData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

dataVariantValueData 필수: 응답 예제 · VariantValueData.

예제: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수: 응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

추가 필드: 아니요

조회 · 옵션 — 옵션 상품과 옵션 — 응답

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

created_at문자열필수

생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

id문자열필수

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

예제: "example"

name문자열 null필수

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

예제: "Example"

number문자열필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"

position정수필수

정렬된 컬렉션에서의 위치입니다.

예제: 1

selection_type문자열필수

허용되는 속성 값 선택 방식입니다.

제약 조건

enum: ["button", "dropdown"]

예제: "button"

updated_at문자열필수

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

format: "date-time"

예제: "2026-01-01T12:00:00Z"

value_presentation_type문자열필수

사전 값을 표시하는 방식입니다.

제약 조건

enum: ["text", "color", "image"]

예제: "text"

version정수필수

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

예제: 1

추가 필드: 아니요

조회 · 상품 변형 — 옵션 상품과 옵션 — 응답

ProductVariantData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

active불리언필수: 리소스가 활성 상태인지 나타냅니다.

예제: true
created_at문자열필수: 생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
id문자열필수: 리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (ProductVariantData).

예제: "example"
is_default불리언필수: 기본 선택인지 나타냅니다.

예제: true
media_ids배열 <문자열> 필수: 이미 존재하는 미디어 자산의 식별자입니다.

예제: ["example"]
position정수필수: 정렬된 컬렉션에서의 위치입니다.

예제: 1
pricingVariantPricingData 필수: 가격 설정과 동시성 제어 버전입니다.

예제: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_id문자열 null필수: 기본 미디어 자산 식별자입니다.

예제: "example"
product_id문자열필수: 상품 식별자입니다.

예제: "example"
sku문자열필수: 재고 관리 단위 코드입니다.

예제: "example"
updated_at문자열필수: 가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
values배열 <VariantChoiceData > 필수: 사전 값입니다.

예제: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
version정수필수: 동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

사전 값입니다

VariantChoiceData · 스키마 · 데이터 스키마: 옵션 상품과 옵션

option_id문자열필수: 옵션 식별자입니다.

예제: "example"
option_name문자열 null필수: 옵션 이름입니다.

예제: "example"
value문자열 null필수: 주변 스키마에서 설명하는 값입니다.

예제: "example"
value_id문자열필수: 사전 값 식별자입니다.

예제: "example"

추가 필드: 아니요

생성 · 상품 변형 — 옵션 상품과 옵션 — 요청 본문

VariantCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

active불리언선택 사항

리소스가 활성 상태인지 나타냅니다.

기본값: true

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

is_default불리언선택 사항

기본 선택인지 나타냅니다.

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

이미 존재하는 미디어 자산의 식별자입니다.

maxItems: 20

배열:minLength: 1maxLength: 63

pricingVariantPrice 선택 사항

가격 설정과 동시성 제어 버전입니다.

sku문자열선택 사항

재고 관리 단위 코드입니다.

minLength: 1maxLength: 100

제약 조건

pattern: "^\\S+$"

value_ids배열 <문자열> 필수

사전 값의 식별자입니다.

minItems: 1maxItems: 250

배열:minLength: 1maxLength: 63

예제: ["example"]

추가 필드: 아니요

생성 · 옵션 — 옵션 상품과 옵션 — 요청 본문

VariantOptionCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

name문자열필수

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

minLength: 1maxLength: 120

제약 조건

pattern: "^[^\\x00]*$"

예제: "Example"

selection_type문자열선택 사항

허용되는 속성 값 선택 방식입니다.

제약 조건

enum: ["button", "dropdown"]

기본값: "button"

value_presentation_type문자열선택 사항

사전 값을 표시하는 방식입니다.

제약 조건

enum: ["text", "color", "image"]

기본값: "text"

추가 필드: 아니요

수정 · 옵션 — 옵션 상품과 옵션 — 요청 본문

VariantOptionUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

name문자열 null선택 사항

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

문자열:minLength: 1maxLength: 120

제약 조건 · 문자열 1

pattern: "^[^\\x00]*$"

예제: "Example"

selection_type문자열선택 사항

허용되는 속성 값 선택 방식입니다.

제약 조건

enum: ["button", "dropdown"]

value_presentation_type문자열선택 사항

사전 값을 표시하는 방식입니다.

제약 조건

enum: ["text", "color", "image"]

추가 필드: 아니요

가격 설정과 동시성 제어 버전입니다

VariantPrice · 스키마 · 데이터 스키마: 옵션 상품과 옵션

amount문자열 null필수

JSON 문자열로 인코딩한 십진수 금액입니다. null 은 허용된 경우에만 사용합니다.

문자열:maxLength: 20

제약 조건 · 문자열 1

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

예제: "0.00"

currency문자열필수

금액의 통화 코드입니다.

제약 조건

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

예제: "PLN"

expected_price_list_version정수필수

이 쓰기에 필요한, 앞서 조회한 가격표 버전입니다.

minimum: 1maximum: 9223372036854775807

예제: 1

expected_product_version정수필수

이 쓰기에 필요한, 앞서 조회한 상품 버전입니다.

minimum: 0maximum: 9223372036854775807

예제: 1

expected_version정수필수

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

minimum: 0maximum: 9223372036854775807

예제: 0

kind문자열필수

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

제약 조건

enum: ["base_adjustment", "market_fixed"]

예제: "base_adjustment"

price_list_id문자열필수

가격표 식별자입니다.

minLength: 1maxLength: 63

예제: "example"

추가 필드: 아니요

가격 설정과 동시성 제어 버전입니다

VariantPricingData · 스키마 · 데이터 스키마: 옵션 상품과 옵션

base_adjustmentMoneyData 필수: 기본 가격에 대한 가격 조정입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData null필수: 선택한 시장의 가격입니다.

예제: null
pricePriceData null필수: 선택한 컨텍스트의 가격 정보입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_version정수필수: 동시성 제어를 위한 현재 상품 버전입니다.

예제: 1
version정수필수: 동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

수정 · 상품 변형 — 옵션 상품과 옵션 — 요청 본문

VariantUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

active불리언선택 사항

리소스가 활성 상태인지 나타냅니다.

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

is_default불리언선택 사항

기본 선택인지 나타냅니다.

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

이미 존재하는 미디어 자산의 식별자입니다.

maxItems: 20

배열:minLength: 1maxLength: 63

pricingVariantPrice 선택 사항

가격 설정과 동시성 제어 버전입니다.

예제:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

sku문자열선택 사항

재고 관리 단위 코드입니다.

minLength: 1maxLength: 100

제약 조건

pattern: "^\\S+$"

예제: "example"

추가 필드: 아니요

생성 · 옵션 값 — 옵션 상품과 옵션 — 요청 본문

VariantValueCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

color_hex문자열 null선택 사항

16진수 코드로 표현한 색상입니다.

제약 조건 · 문자열 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

value문자열필수

주변 스키마에서 설명하는 값입니다.

minLength: 1maxLength: 180

제약 조건

pattern: "^[^\\x00]*$"

예제: "Example"

추가 필드: 아니요

조회 · 옵션 값 — 옵션 상품과 옵션 — 응답

VariantValueData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

color_hex문자열 null필수: 16진수 코드로 표현한 색상입니다.

예제: "#008855"
created_at문자열필수: 생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
id문자열필수: 리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (VariantValueData).

예제: "example"
image_media_id문자열 null필수: 선택한 이미지 자산의 식별자입니다.

예제: null
number문자열필수: 사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
option_id문자열필수: 옵션 식별자입니다.

예제: "example"
position정수필수: 정렬된 컬렉션에서의 위치입니다.

예제: 1
sku_code문자열필수: 재고 관리 단위 코드입니다.

예제: "example"
updated_at문자열필수: 가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"
value문자열 null필수: 주변 스키마에서 설명하는 값입니다.

예제: "example"
version정수필수: 동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

수정 · 옵션 값 — 옵션 상품과 옵션 — 요청 본문

VariantValueUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

color_hex문자열 null선택 사항

16진수 코드로 표현한 색상입니다.

제약 조건 · 문자열 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

value문자열 null선택 사항

주변 스키마에서 설명하는 값입니다.

문자열:minLength: 1maxLength: 180

제약 조건 · 문자열 1

pattern: "^[^\\x00]*$"

예제: "Example"

추가 필드: 아니요