데이터 스키마: 재고

location_code문자열필수

창고 위치 코드입니다.

예제: "example"

location_id문자열필수

창고 위치 식별자입니다.

예제: "example"

location_name문자열필수

창고 위치 이름입니다.

예제: "example"

on_hand정수필수

실제 재고 수량입니다.

예제: 10

추가 필드: 아니요

dataCodeContentData 필수

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

예제: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

dataDigitalUploadData 필수

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

예제: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

dataImportData 필수

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

예제: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

data배열 <StockData > 필수

응답 예제 · ApiResponse_list_StockData__.

예제: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

dataPoolData 필수

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

예제: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

dataStockDetailData 필수

응답 예제 · StockDetailData.

예제: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

dataUnitsData 필수

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

예제: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

code문자열필수

디지털 코드의 정확한 내용입니다. 대소문자와 내부 공백을 유지하세요.

minLength: 1maxLength: 512

예제: "DEMO-ONE"

delivery_id문자열 | null선택 사항

입고 또는 주문 배정의 ID.

문자열:format: "uuid"

예제: null

kind문자열선택 사항

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

const: "code"

기본값: "code"예제: "code"

payload_id문자열필수

내용 ID. 공개 다운로드 URL이 아닙니다.

format: "uuid"

예제: "00000000-0000-4000-8000-000000000004"

unit_id문자열필수

개별 코드 또는 파일의 ID.

format: "uuid"

예제: "00000000-0000-4000-8000-000000000003"

추가 필드: 아니요

consumer_id문자열필수

연결된 가져오기 또는 단위의 ID.

format: "uuid"

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

consumer_kind문자열필수

업로드 연결 유형: digital_import / digital_unit.

제약 조건

enum

["digital_import", "digital_unit"]

예제: "digital_import"

filename문자열필수

파일

minLength: 1maxLength: 255

예제: "codes.txt"

purpose문자열필수

digital_import: TXT/CSV. digital_unit: 개별 판매 파일.

제약 조건

enum

["digital_unit", "digital_import"]

예제: "digital_import"

sha256문자열필수

SHA-256 (hex, 64)

제약 조건

pattern

"^[0-9a-f]{64}$"

예제: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytes정수필수

크기(바이트)

minimum: 1maximum: 262144000

예제: 18

추가 필드: 아니요

consumer_id문자열필수

연결된 가져오기 또는 단위의 ID.

format: "uuid"

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

consumer_kind문자열필수

업로드 연결 유형: digital_import / digital_unit.

제약 조건

enum

["digital_import", "digital_unit"]

예제: "digital_import"

expires_at문자열필수

이 업로드 또는 가져오기의 만료 시각입니다.

format: "date-time"

예제: "2026-11-03T13:00:00Z"

filename문자열필수

파일

예제: "codes.txt"

id문자열필수

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

format: "uuid"

예제: "00000000-0000-4000-8000-000000000002"

product_id문자열필수

상품 식별자입니다.

예제: "example"

purpose문자열필수

digital_import: TXT/CSV. digital_unit: 개별 판매 파일.

제약 조건

enum

["digital_unit", "digital_import"]

예제: "digital_import"

received_bytes정수필수

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

예제: 18

sha256문자열필수

SHA-256 (hex, 64)

예제: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytes정수필수

크기(바이트)

예제: 18

status문자열필수

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

예제: "ready"

추가 필드: 아니요

delivered_at문자열필수

배송 날짜와 시각입니다.

format: "date-time"

예제: "2026-11-03T12:00:00Z"

expected_delivery_version정수필수

입고 버전. 신규 입고는 0.

minimum: 0maximum: 0

예제: 0

expected_sales_limit_version정수 | null선택 사항

판매 한도 버전. publish_for_sale=true일 때 필수.

정수:minimum: 0maximum: 9223372036854775807

예제: 0

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 2

location_id문자열필수

창고 위치 식별자입니다.

제약 조건

pattern

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

예제: "location-digital"

publish_for_sale불리언선택 사항

true이면 유한한 판매 한도도 늘립니다. false는 변경하지 않습니다.

기본값: false예제: true

status문자열필수

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

제약 조건

enum

["planned", "received"]

예제: "received"

validation_digest문자열필수

검증 체크섬. 확정 시 변경하지 않고 보내세요.

제약 조건

pattern

"^[0-9a-f]{64}$"

예제: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_id문자열필수

창고 식별자입니다.

제약 조건

pattern

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

예제: "warehouse-main"

추가 필드: 아니요

count정수필수

묶음의 정확한 단위 수.

minimum: 1maximum: 1000

예제: 2

kind문자열필수

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

제약 조건

enum

["code", "file"]

예제: "code"

추가 필드: 아니요

delivery_id문자열 | null필수

입고 또는 주문 배정의 ID.

예제: null

delivery_status문자열 | null필수

입고 상태: planned / received. 확정 전에는 null.

예제: null

delivery_version정수 | null필수

창고 입고의 현재 버전.

예제: null

expected_count정수필수

예상 수량. 전체 묶음이 승인되어야 합니다.

예제: 2

expires_at문자열필수

이 업로드 또는 가져오기의 만료 시각입니다.

format: "date-time"

예제: "2026-11-03T13:00:00Z"

id문자열필수

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

format: "uuid"

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

kind문자열필수

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

제약 조건

enum

["code", "file"]

예제: "code"

product_id문자열필수

상품 식별자입니다.

예제: "example"

status문자열필수

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

예제: "validated"

validated_count정수필수

최근 성공한 검증에서 승인된 단위 수.

예제: 2

validation_digest문자열 | null필수

검증 체크섬. 확정 시 변경하지 않고 보내세요.

예제: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

version정수필수

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

예제: 2

추가 필드: 아니요

expected_delivery_version정수필수

입고 버전. 신규 입고는 0.

minimum: 1maximum: 9223372036854775807

예제: 1

expected_sales_limit_version정수 | null선택 사항

판매 한도 버전. publish_for_sale=true일 때 필수.

정수:minimum: 0maximum: 9223372036854775807

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 3

publish_for_sale불리언선택 사항

true이면 유한한 판매 한도도 늘립니다. false는 변경하지 않습니다.

기본값: false

추가 필드: 아니요

code_column문자열 | null선택 사항

코드가 있는 CSV 열. code를 사용하세요.

문자열:const: "code"

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

format문자열 | null선택 사항

코드 목록 형식: txt / csv. 파일은 upload_ids를 사용하세요.

제약 조건 · 문자열 1

enum

["txt", "csv"]

예제: "txt"

source_upload_id문자열 | null선택 사항

이 가져오기에 속하는 준비된 비공개 TXT/CSV 업로드.

문자열:format: "uuid"

예제: "00000000-0000-4000-8000-000000000002"

upload_ids배열 <문자열> | null선택 사항

이 가져오기에 속하는 1–100개의 준비된 비공개 파일 업로드.

배열:minItems: 1maxItems: 100

배열 / 배열:format: "uuid"

추가 필드: 아니요

expected_delivery_version정수필수

입고 버전. 신규 입고는 0.

minimum: 1maximum: 9223372036854775807

예제: 1

expected_order_version정수필수

배정 순서의 버전이며 고객 주문의 버전이 아닙니다.

minimum: 0maximum: 9223372036854775807

예제: 1

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 3

reason문자열필수

변경에 기록된 사유입니다.

minLength: 1maxLength: 500

예제: "Withdraw a revoked license"

추가 필드: 아니요

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

manual_reserved정수필수

수동으로 예약한 수량입니다.

minimum: 0maximum: 2147483647

예제: 1

reason문자열선택 사항

변경에 기록된 사유입니다.

maxLength: 500

기본값: ""

추가 필드: 아니요

email_mode문자열선택 사항

disabled: 이메일 없음. order_link: 주문 링크. code_text: 코드도 포함할 수 있음.

제약 조건

enum

["disabled", "order_link", "code_text"]

기본값: "disabled"예제: "order_link"

enabled불리언필수

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

예제: true

expected_version정수필수

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

minimum: 0maximum: 9223372036854775807

예제: 0

retention_days정수 | null선택 사항

null은 무기한, 1–3650은 최초 접근부터의 일수. 코드는 자동 삭제되지 않습니다.

정수:minimum: 1maximum: 3650

예제: null

추가 필드: 아니요

available정수필수

예약되거나 전달되지 않은 가용 단위 수입니다.

예제: 1

held정수필수

주문에 예약되었으나 아직 전달되지 않은 단위.

예제: 0

issued정수필수

결제된 구매에 이미 전달된 단위.

예제: 1

planned정수필수

확정되었지만 아직 수령하지 않은 입고의 단위.

예제: 0

retired정수필수

철회 후에도 이력에 남는 단위.

예제: 0

staged정수필수

미완료 가져오기의 단위. 아직 판매 재고가 아닙니다.

예제: 0

추가 필드: 아니요

configured불리언필수

재고 설정이 저장되었는지 여부.

예제: true

countsPoolCounts 필수

재고 상태별 단위 수.

예제: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_mode문자열필수

disabled: 이메일 없음. order_link: 주문 링크. code_text: 코드도 포함할 수 있음.

제약 조건

enum

["disabled", "order_link", "code_text"]

예제: "order_link"

enabled불리언필수

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

예제: true

order_version정수필수

재고 배정 순서의 버전.

예제: 2

product_id문자열필수

상품 식별자입니다.

예제: "example"

retention_days정수 | null필수

null은 무기한, 1–3650은 최초 접근부터의 일수. 코드는 자동 삭제되지 않습니다.

예제: null

version정수필수

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

예제: 1

추가 필드: 아니요

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

reason문자열선택 사항

변경에 기록된 사유입니다.

maxLength: 500

기본값: ""

sellable_limit정수필수

판매 한도이며 -1 은 무제한, 0 은 판매 불가입니다.

minimum: -1maximum: 2147483647

예제: 1

추가 필드: 아니요

expected_version정수필수

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

minimum: 0maximum: 9223372036854775807

예제: 0

locations배열 <LocationQuantity > 필수

창고 위치입니다.

minItems: 1maxItems: 100

예제: [{"location_id":"example","on_hand":1}]

reason문자열필수

변경에 기록된 사유입니다.

minLength: 1maxLength: 500

예제: "Example"

target_id문자열필수

작업의 영향을 받는 상품 또는 옵션 상품 식별자입니다.

제약 조건

pattern

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

예제: "example"

target_type문자열필수

작업 대상이 상품인지 옵션 상품인지 나타냅니다.

제약 조건

enum

["product", "variant"]

예제: "product"

warehouse_id문자열필수

창고 식별자입니다.

제약 조건

pattern

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

예제: "example"

추가 필드: 아니요

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

locations배열 <LocationQuantity > 필수

창고 위치입니다.

minItems: 1maxItems: 100

예제: [{"location_id":"example","on_hand":1}]

reason문자열필수

변경에 기록된 사유입니다.

minLength: 1maxLength: 500

예제: "Example"

추가 필드: 아니요

active불리언필수

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

예제: true

available정수 | null필수

판매 가능 수량이며 null 은 무제한을 뜻합니다.

예제: 5

id문자열필수

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

예제: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reserved정수필수

수동으로 예약한 수량입니다.

예제: 2

on_hand정수필수

실제 재고 수량입니다.

예제: 10

reserved정수필수

주문으로 예약한 수량입니다.

예제: 3

sellable_limit정수필수

판매 한도이며 -1 은 무제한, 0 은 판매 불가입니다.

예제: 10

target_id문자열필수

작업의 영향을 받는 상품 또는 옵션 상품 식별자입니다.

예제: "example"

target_type문자열필수

작업 대상이 상품인지 옵션 상품인지 나타냅니다.

제약 조건

enum

["product", "variant"]

예제: "product"

total_reserved정수필수

총 예약 수량입니다.

예제: 5

updated_at문자열필수

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

format: "date-time"

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

version정수필수

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

예제: 1

warehouse_id문자열필수

창고 식별자입니다.

예제: "example"

추가 필드: 아니요

active불리언필수

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

예제: true

allocations배열 <AllocationData > 필수

창고 위치에 할당된 수량입니다.

예제: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

available정수 | null필수

판매 가능 수량이며 null 은 무제한을 뜻합니다.

예제: 5

id문자열필수

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

예제: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reserved정수필수

수동으로 예약한 수량입니다.

예제: 2

on_hand정수필수

실제 재고 수량입니다.

예제: 10

reserved정수필수

주문으로 예약한 수량입니다.

예제: 3

sellable_limit정수필수

판매 한도이며 -1 은 무제한, 0 은 판매 불가입니다.

예제: 10

target_id문자열필수

작업의 영향을 받는 상품 또는 옵션 상품 식별자입니다.

예제: "example"

target_type문자열필수

작업 대상이 상품인지 옵션 상품인지 나타냅니다.

제약 조건

enum

["product", "variant"]

예제: "product"

total_reserved정수필수

총 예약 수량입니다.

예제: 5

updated_at문자열필수

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

format: "date-time"

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

version정수필수

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

예제: 1

warehouse_id문자열필수

창고 식별자입니다.

예제: "example"

추가 필드: 아니요

content_state문자열필수

내용 상태: present / deleting / deleted.

예제: "present"

delivery_id문자열 | null필수

입고 또는 주문 배정의 ID.

예제: "delivery-example"

filename문자열 | null필수

파일

예제: null

id문자열필수

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

format: "uuid"

예제: "00000000-0000-4000-8000-000000000003"

issued_at문자열 | null필수

최초 전달 시점. 이전에는 null.

문자열:format: "date-time"

예제: null

kind문자열필수

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

제약 조건

enum

["file", "code"]

예제: "code"

location_id문자열 | null필수

창고 위치 식별자입니다.

예제: "location-digital"

mime_type문자열 | null필수

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

예제: null

payload_id문자열필수

내용 ID. 공개 다운로드 URL이 아닙니다.

format: "uuid"

예제: "00000000-0000-4000-8000-000000000004"

product_id문자열필수

상품 식별자입니다.

예제: "example"

size_bytes정수 | null필수

크기(바이트)

예제: null

sort_order정수필수

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

예제: 1

state문자열필수

상태

예제: "available"

version정수필수

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

예제: 1

warehouse_id문자열 | null필수

창고 식별자입니다.

예제: "warehouse-main"

추가 필드: 아니요

expected_version정수필수

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

minimum: 1

예제: 1

reason문자열필수

변경에 기록된 사유입니다.

minLength: 1maxLength: 500

예제: "Withdraw a revoked license"

추가 필드: 아니요

expected_order_version정수필수

배정 순서의 버전이며 고객 주문의 버전이 아닙니다.

minimum: 1

예제: 1

unit_ids배열 <문자열> 필수

필터링하지 않은 페이지의 모든 단위를 원하는 순서로 나열한 목록.

minItems: 2maxItems: 100

배열:format: "uuid"

예제: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursor문자열 | null선택 사항

필터링하지 않은 페이지의 커서. 첫 페이지는 null.

문자열:maxLength: 1024

추가 필드: 아니요

code문자열 | null선택 사항

디지털 코드의 정확한 내용입니다. 대소문자와 내부 공백을 유지하세요.

문자열:minLength: 1maxLength: 512

예제: "SYNTHETIC-REPLACEMENT"

expected_version정수필수

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

minimum: 1

예제: 1

reason문자열필수

변경에 기록된 사유입니다.

minLength: 1maxLength: 500

예제: "Replace an invalid activation code"

upload_id문자열 | null선택 사항

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

문자열:format: "uuid"

추가 필드: 아니요

order_version정수필수

재고 배정 순서의 버전.

예제: 2

total정수필수

총금액입니다.

예제: 1

units배열 <UnitData > 필수

단위 메타데이터. 내용은 별도의 인증된 요청이 필요합니다.

예제: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

추가 필드: 예