콘텐츠로 건너뛰기
ShopentlyLearn

데이터 스키마: 상품

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

데이터 스키마

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
dataProductFileListData 필수

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

예제: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
dataReleaseListData 필수

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

예제: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

ApiResponse_UploadData_

ApiResponse_UploadData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
dataUploadData 필수

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

예제: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"request_id":"example"}

추가 필드: 아니요

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · 접근 규칙과 상품 버전을 조회하세요. 최초 게시 시점은 기준으로 유지됩니다.
dataAudienceData 필수

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

예제: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"request_id":"example-request"}

추가 필드: 아니요

목록 조회 — 상품 — 응답

ApiResponse_list_ProductSummaryData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
data배열 <ProductSummaryData > 필수

응답 예제 · ApiResponse_list_ProductSummaryData__.

예제: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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_ProductDetailData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
dataProductDetailData 필수

응답 예제 · ProductDetailData.

예제: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

AudienceChange

AudienceChange · 자격이 있는 구매를 선택하세요. 선택한 주문에는 결제되었으며 환불되지 않은 이 상품이 있어야 합니다.
audienceAudienceSelection 필수

공유 판매 파일의 명시적 접근 규칙.

예제: {"mode":"all_purchasers"}
expected_version정수필수

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

minimum: 1maximum: 9223372036854775807
예제: 1

추가 필드: 아니요

AudienceData

AudienceData · 접근 규칙과 상품 버전을 조회하세요. 최초 게시 시점은 기준으로 유지됩니다.
anchor_at문자열필수

최초 게시 시점. 규칙을 변경해도 바뀌지 않습니다.

format: "date-time"
예제: "2026-11-03T12:00:00Z"
effective_at문자열필수

이 접근 규칙의 게시 시점.

format: "date-time"
예제: "2026-11-03T12:00:00Z"
file_id문자열필수

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

예제: "00000000-0000-4000-8000-000000000007"
file_version_id문자열필수

변경할 수 없는 파일 버전의 ID.

예제: "00000000-0000-4000-8000-000000000010"
historical_access_preserved불리언선택 사항

규칙을 축소해도 이미 부여된 접근 권한은 유지됩니다.

기본값: true예제: true
id문자열필수

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

예제: "00000000-0000-4000-8000-000000000009"
lookback_days정수 null필수

최초 게시 전 1–3650일. recent_and_new에만 사용.

예제: null
mode문자열필수

공유 판매 파일의 명시적 접근 규칙. new_purchases / recent_and_new / selected / all_purchasers.

예제: "all_purchasers"
next_cursor문자열 null필수

다음 페이지의 이어 보기 값 또는 null 입니다.

예제: null
order_ids배열 <문자열> 필수

이 상품이 결제되었고 환불되지 않은 주문.

예제: []
product_version정수필수

동시성 제어를 위한 현재 상품 버전입니다.

예제: 3
revision정수필수

접근 규칙의 순차적 개정 번호.

예제: 1

추가 필드: 아니요

AudienceSelection

AudienceSelection · 자격이 있는 구매를 선택하세요. 선택한 주문에는 결제되었으며 환불되지 않은 이 상품이 있어야 합니다.
lookback_days정수 null선택 사항

최초 게시 전 1–3650일. recent_and_new에만 사용.

정수:minimum: 1maximum: 3650
mode문자열필수

공유 판매 파일의 명시적 접근 규칙. new_purchases / recent_and_new / selected / all_purchasers.

제약 조건
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
예제: "new_purchases"
order_ids배열 <문자열> 선택 사항

이 상품이 결제되었고 환불되지 않은 주문.

maxItems: 1000
제약 조건 · 배열 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
기본값: []

추가 필드: 아니요

선택한 컨텍스트의 판매 가능 정보입니다

AvailabilityData · 스키마 · 데이터 스키마: 상품
available_from문자열 null필수

판매 가능 기간의 시작입니다.

문자열:format: "date-time"
예제: null
available_until문자열 null필수

판매 가능 기간의 종료입니다.

문자열:format: "date-time"
예제: null
is_available불리언필수

현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true

추가 필드: 아니요

FileAssign

FileAssign · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
audienceAudienceSelection null선택 사항

공유 판매 파일의 명시적 접근 규칙.

예제: {"mode":"new_purchases"}
expected_version정수필수

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

minimum: 1maximum: 9223372036854775807
예제: 1
label문자열선택 사항

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

maxLength: 300
기본값: ""
upload_id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"

추가 필드: 아니요

FileCategory

FileCategory · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
문자열
제약 조건
enum
["internal", "customer_document", "digital"]

추가 필드: 예

선택한 컨텍스트의 가격 정보입니다

PriceData · 스키마 · 데이터 스키마: 상품
amount문자열필수

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

예제: "0.00"
currency문자열필수

금액의 통화 코드입니다.

제약 조건
pattern
"^[A-Z]{3}$"
예제: "PLN"
minor_units정수필수

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

minimum: 0maximum: 4
예제: 2
tax_included불리언필수

제출한 가격에 세금이 포함되는지 나타냅니다.

예제: true

추가 필드: 아니요

가격표 정보입니다

PriceListData · 스키마 · 데이터 스키마: 상품
currency문자열필수

금액의 통화 코드입니다.

id문자열필수

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

tax_included불리언필수

제출한 가격에 세금이 포함되는지 나타냅니다.

version정수필수

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

추가 필드: 아니요

생성 — 상품 — 요청 본문

ProductCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
brand_id문자열 null선택 사항

브랜드 식별자입니다.

문자열:minLength: 1maxLength: 63
condition문자열선택 사항

상품 상태입니다.

제약 조건
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
기본값: "new"
description문자열 null선택 사항

선택한 언어의 설명입니다.

문자열:maxLength: 100000
feature_value_ids배열 <문자열> 선택 사항

선택한 속성 값의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
identifiersProductIdentifiers null선택 사항

상품 식별 코드입니다.

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

선택한 시장의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
media_ids배열 <문자열> 선택 사항

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

maxItems: 30
배열:minLength: 1maxLength: 63
meta_description문자열 null선택 사항

선택한 언어의 검색 엔진 설명입니다.

문자열:maxLength: 160
meta_keywords배열 <문자열> null선택 사항

선택한 언어의 검색 엔진 키워드입니다.

배열:maxItems: 20
배열 / 배열:maxLength: 50
meta_title문자열 null선택 사항

선택한 언어의 검색 엔진 제목입니다.

문자열:maxLength: 70
name문자열필수

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

minLength: 1maxLength: 300
예제: "Example"
pricingProductPrice 선택 사항

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

primary_category_id문자열 null선택 사항

기본 카테고리 식별자입니다.

문자열:minLength: 1maxLength: 63
published불리언선택 사항

리소스가 공개되어 있는지 나타냅니다.

기본값: false
sku문자열필수

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

minLength: 1maxLength: 100
제약 조건
pattern
"^\\S+$"
예제: "example"
slug문자열 null선택 사항

선택한 언어의 URL 경로 조각입니다.

문자열:maxLength: 160
tax_category_id문자열 null선택 사항

세금 분류 식별자입니다.

문자열:minLength: 1maxLength: 63
variant_value_ids배열 <문자열> 선택 사항

선택한 옵션 값의 식별자입니다.

maxItems: 250
배열:minLength: 1maxLength: 63
variants_enabled불리언선택 사항

상품이 옵션 조합을 사용하는지 나타냅니다.

기본값: false

추가 필드: 아니요

조회 — 상품 — 응답

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

선택한 컨텍스트의 판매 가능 정보입니다.

예제: {"available_from":null,"available_until":null,"is_available":true}
brand_id문자열 null필수

브랜드 식별자입니다.

예제: null
condition문자열필수

상품 상태입니다.

제약 조건
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
예제: "new"
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
description문자열 null필수

선택한 언어의 설명입니다.

예제: "example"
features배열 <FeatureSelectionData > 필수

상품 속성입니다.

예제: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
id문자열필수

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

예제: "example"
identifiers객체추가 필드: 문자열필수

상품 식별 코드입니다.

예제: {}
media배열 <ProductMediaData > 필수

첨부된 미디어 정보입니다.

예제: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_description문자열 null필수

선택한 언어의 검색 엔진 설명입니다.

예제: "example"
meta_keywords배열 <문자열> null필수

선택한 언어의 검색 엔진 키워드입니다.

예제: ["example"]
meta_title문자열 null필수

선택한 언어의 검색 엔진 제목입니다.

예제: "example"
name문자열 null필수

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

예제: "Example"
number문자열필수

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

예제: "example"
pricePriceData null필수

선택한 컨텍스트의 가격 정보입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_version정수필수

동시성 제어를 위한 현재 가격 버전입니다.

예제: 1
primary_category_id문자열 null필수

기본 카테고리 식별자입니다.

예제: "example"
primary_media_id문자열 null필수

기본 미디어 자산 식별자입니다.

예제: "example"
published불리언필수

리소스가 공개되어 있는지 나타냅니다.

예제: false
sku문자열필수

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

예제: "example"
slug문자열 null필수

선택한 언어의 URL 경로 조각입니다.

예제: "example"
tax_category_id문자열필수

세금 분류 식별자입니다.

예제: "example"
updated_at문자열필수

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

format: "date-time"
예제: "2026-01-01T12:00:00Z"
variants_enabled불리언필수

상품이 옵션 조합을 사용하는지 나타냅니다.

예제: false
version정수필수

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

예제: 1

추가 필드: 아니요

ProductFileData

ProductFileData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
categoryFileCategory 필수

파일 분류: internal / customer_document / digital

예제: "digital"
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
current_version_id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
file_id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
filename문자열필수

파일

예제: "manual.pdf"
id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
label문자열필수

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

예제: "Manual"
mime_type문자열필수

미디어 콘텐츠 유형입니다.

예제: "application/pdf"
sha256문자열필수

SHA-256 (hex, 64)

예제: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes정수필수

크기(바이트)

예제: 46
state문자열필수

상태

예제: "active"
version_number정수필수

버전

예제: 1

추가 필드: 아니요

ProductFileListData

ProductFileListData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
files배열 <ProductFileData > 필수

상품 파일

예제: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_version정수필수

동시성 제어를 위한 현재 상품 버전입니다.

예제: 2

추가 필드: 아니요

상품 식별 코드입니다

ProductIdentifiers · 스키마 · 데이터 스키마: 상품
ean문자열 null선택 사항

상품의 EAN 식별자입니다.

문자열:minLength: 1maxLength: 100
isbn문자열 null선택 사항

ISBN 식별자입니다.

문자열:minLength: 1maxLength: 100
mpn문자열 null선택 사항

제조업체 부품 번호입니다.

문자열:minLength: 1maxLength: 100
upc문자열 null선택 사항

상품의 UPC 식별자입니다.

문자열:minLength: 1maxLength: 100

추가 필드: 아니요

첨부된 미디어 정보입니다

ProductMediaData · 스키마 · 데이터 스키마: 상품
alt_text문자열 null필수

이미지 대체 텍스트입니다.

예제: "example"
id문자열필수

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

예제: "example"
is_primary불리언필수

기본 항목인지 나타냅니다.

예제: true
kind문자열필수

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

제약 조건
enum
["image", "video", "model_3d"]
예제: "image"
mime_type문자열필수

미디어 콘텐츠 유형입니다.

예제: "image/jpeg"
position정수필수

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

예제: 1
url문자열 null필수

리소스 URL입니다.

예제: "https://example.invalid/product.jpg"

추가 필드: 아니요

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

ProductPrice · 스키마 · 데이터 스키마: 상품
amount문자열 null필수

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

문자열:maxLength: 19
제약 조건 · 문자열 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_version정수필수

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

minimum: 0maximum: 9223372036854775807
예제: 0
kind문자열필수

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

제약 조건
enum
["base", "market_fixed"]
예제: "base"
price_list_id문자열필수

가격표 식별자입니다.

minLength: 1maxLength: 63
예제: "example"
tax_included불리언필수

제출한 가격에 세금이 포함되는지 나타냅니다.

예제: true

추가 필드: 아니요

목록 조회 — 상품 — 응답

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

선택한 컨텍스트의 판매 가능 정보입니다.

예제: {"available_from":null,"available_until":null,"is_available":true}
brand_id문자열 null필수

브랜드 식별자입니다.

예제: null
condition문자열필수

상품 상태입니다.

제약 조건
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
예제: "new"
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
id문자열필수

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

예제: "example"
name문자열 null필수

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

예제: "Example"
number문자열필수

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

예제: "example"
pricePriceData null필수

선택한 컨텍스트의 가격 정보입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_version정수필수

동시성 제어를 위한 현재 가격 버전입니다.

예제: 1
primary_category_id문자열 null필수

기본 카테고리 식별자입니다.

예제: "example"
primary_media_id문자열 null필수

기본 미디어 자산 식별자입니다.

예제: "example"
published불리언필수

리소스가 공개되어 있는지 나타냅니다.

예제: false
sku문자열필수

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

예제: "example"
slug문자열 null필수

선택한 언어의 URL 경로 조각입니다.

예제: "example"
tax_category_id문자열필수

세금 분류 식별자입니다.

예제: "example"
updated_at문자열필수

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

format: "date-time"
예제: "2026-01-01T12:00:00Z"
variants_enabled불리언필수

상품이 옵션 조합을 사용하는지 나타냅니다.

예제: false
version정수필수

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

예제: 1

추가 필드: 아니요

수정 — 상품 — 요청 본문

ProductUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
brand_id문자열 null선택 사항

브랜드 식별자입니다.

문자열:minLength: 1maxLength: 63
condition문자열선택 사항

상품 상태입니다.

제약 조건
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
description문자열 null선택 사항

선택한 언어의 설명입니다.

문자열:maxLength: 100000
예제: null
expected_variant_price_versions객체추가 필드: 정수
minimum: 0maximum: 9223372036854775807
선택 사항

옵션 상품 식별자를 키로 하는, 앞서 조회한 가격 버전입니다.

maxProperties: 250
제약 조건
propertyNames
{"maxLength": 63, "minLength": 1}
expected_version정수필수

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

minimum: 1maximum: 9223372036854775807
예제: 1
feature_value_ids배열 <문자열> 선택 사항

선택한 속성 값의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
identifiersProductIdentifiers null선택 사항

상품 식별 코드입니다.

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

선택한 시장의 식별자입니다.

maxItems: 1000
배열:minLength: 1maxLength: 63
media_ids배열 <문자열> 선택 사항

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

maxItems: 30
배열:minLength: 1maxLength: 63
meta_description문자열 null선택 사항

선택한 언어의 검색 엔진 설명입니다.

문자열:maxLength: 160
meta_keywords배열 <문자열> null선택 사항

선택한 언어의 검색 엔진 키워드입니다.

배열:maxItems: 20
배열 / 배열:maxLength: 50
meta_title문자열 null선택 사항

선택한 언어의 검색 엔진 제목입니다.

문자열:maxLength: 70
name문자열 null선택 사항

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

문자열:maxLength: 300
pricingProductPrice 선택 사항

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

예제: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_id문자열 null선택 사항

기본 카테고리 식별자입니다.

문자열:minLength: 1maxLength: 63
published불리언선택 사항

리소스가 공개되어 있는지 나타냅니다.

sku문자열선택 사항

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

minLength: 1maxLength: 100
제약 조건
pattern
"^\\S+$"
예제: "example"
slug문자열 null선택 사항

선택한 언어의 URL 경로 조각입니다.

문자열:maxLength: 160
tax_category_id문자열 null선택 사항

세금 분류 식별자입니다.

문자열:minLength: 1maxLength: 63
variant_value_ids배열 <문자열> 선택 사항

선택한 옵션 값의 식별자입니다.

maxItems: 250
배열:minLength: 1maxLength: 63
variants_enabled불리언선택 사항

상품이 옵션 조합을 사용하는지 나타냅니다.

추가 필드: 아니요

ProductVersion

ProductVersion · 이 작업은 종료되었으며 데이터를 변경하지 않고 409를 반환합니다. 각 디지털 파일의 접근은 수신 대상 선택으로 따로 설정하세요.
expected_version정수필수

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

minimum: 1maximum: 9223372036854775807
예제: 1

추가 필드: 아니요

ReleaseData

ReleaseData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
changelog문자열필수

변경 내용

예제: "Manual update"
files배열 <ReleaseFileData > 필수

상품 파일

예제: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
manifest_sha256문자열 null필수

디지털 릴리스 · SHA-256

예제: "1111111111111111111111111111111111111111111111111111111111111111"
published_at문자열 null필수

릴리스 게시 · UTC

문자열:format: "date-time"
예제: null
release_sequence정수 null필수

디지털 릴리스 · 정렬된 컬렉션에서의 위치입니다.

예제: null
state문자열필수

상태

예제: "active"
version_label문자열필수

버전

예제: "1.0"
withdrawn_at문자열 null필수

판매 중단 · UTC

문자열:format: "date-time"
예제: null

추가 필드: 아니요

ReleaseDraft

ReleaseDraft · 이 작업은 종료되었으며 데이터를 변경하지 않고 409를 반환합니다. 각 디지털 파일의 접근은 수신 대상 선택으로 따로 설정하세요.
changelog문자열선택 사항

변경 내용

maxLength: 20000
기본값: ""
expected_version정수필수

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

minimum: 1maximum: 9223372036854775807
예제: 1
version_ids배열 <문자열> 필수

버전 · UUID[]

minItems: 1maxItems: 20
배열:format: "uuid"
예제: ["00000000-0000-4000-8000-000000000001"]
version_label문자열필수

버전

minLength: 1maxLength: 64
예제: "1.0"

추가 필드: 아니요

ReleaseFileData

ReleaseFileData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
file_id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
sort_order정수필수

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

예제: 0
version_id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"

추가 필드: 아니요

ReleaseListData

ReleaseListData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
current_release_id문자열 null필수

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

문자열:format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
product_version정수필수

동시성 제어를 위한 현재 상품 버전입니다.

예제: 2
releases배열 <ReleaseData > 필수

디지털 릴리스

예제: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_days정수 null필수

일수 (days; null)

예제: 365
update_mode문자열필수

구매 후 추가되는 파일에 대한 접근 권한: none / period / unlimited

예제: "period"
update_months정수 null필수

개월 수 (months; null)

예제: null

추가 필드: 아니요

UpdatePolicy

UpdatePolicy · 이 작업은 종료되었으며 데이터를 변경하지 않고 409를 반환합니다. 각 디지털 파일의 접근은 수신 대상 선택으로 따로 설정하세요.
days정수 null선택 사항

일수 (1–3650; mode=period; months=null)

정수:minimum: 1maximum: 3650
예제: 365
expected_version정수필수

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

minimum: 1maximum: 9223372036854775807
예제: 1
mode문자열필수

구매 후 추가되는 파일에 대한 접근 권한: none / period / unlimited

제약 조건
enum
["none", "period", "unlimited"]
예제: "period"
months정수 null선택 사항

개월 수 (1–120; mode=period; days=null)

정수:minimum: 1maximum: 120
예제: null

추가 필드: 아니요

UploadCreate

UploadCreate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
filename문자열필수

파일

minLength: 1maxLength: 255
예제: "manual.pdf"
product_id문자열 null선택 사항

상품 식별자입니다.

제약 조건 · 문자열 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
예제: "example"
sha256문자열필수

SHA-256 (hex, 64)

제약 조건
pattern
"^[0-9a-f]{64}$"
예제: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes정수필수

크기(바이트)

minimum: 1maximum: 262144000
예제: 46

추가 필드: 아니요

UploadData

UploadData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다. upload_id를 만든 뒤 multipart/form-data로 파일을 전송하고 상품에 연결합니다. 다운로드에는 Bearer 토큰과 category 권한이 필요하며, 응답에는 공개 주소나 비밀번호 없이 파일 바이트가 포함됩니다. mode=period에서는 days(1–3650) 또는 기존 months 중 하나만 지정합니다. 조건은 구매 시 저장되며 환불된 주문 항목만 접근 권한을 잃습니다.
categoryFileCategory 필수

파일 분류: internal / customer_document / digital

예제: "digital"
expires_at문자열필수

인증 정보가 만료되는 날짜와 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
filename문자열필수

파일

예제: "manual.pdf"
id문자열필수

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

format: "uuid"
예제: "00000000-0000-4000-8000-000000000001"
product_id문자열 null필수

상품 식별자입니다.

예제: "example"
received_bytes정수필수

업로드 중… · 크기(바이트)

예제: 46
sha256문자열필수

SHA-256 (hex, 64)

예제: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes정수필수

크기(바이트)

예제: 46
status문자열필수

이 작업에서 허용하는 상태입니다.

예제: "ready"

추가 필드: 아니요