데이터 스키마: 재고

location_code문자열필수

창고 위치 코드입니다.

예제: "example"

location_id문자열필수

창고 위치 식별자입니다.

예제: "example"

location_name문자열필수

창고 위치 이름입니다.

예제: "example"

on_hand정수필수

실제 재고 수량입니다.

예제: 10

추가 필드: 아니요

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

추가 필드: 아니요

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

추가 필드: 아니요

expected_version정수필수

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

minimum: 1maximum: 9223372036854775807

예제: 1

manual_reserved정수필수

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

minimum: 0maximum: 2147483647

예제: 1

reason문자열선택 사항

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

maxLength: 500

기본값: ""

추가 필드: 아니요

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"

추가 필드: 아니요