콘텐츠로 건너뛰기
ShopentlyLearn

데이터 스키마: 입고

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

데이터 스키마

조회 — 입고 — 응답

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

응답 예제 · DeliveryDetailData.

예제: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

목록 조회 — 입고 — 응답

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

응답 예제 · ApiResponse_list_DeliveryData__.

예제: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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"}

추가 필드: 아니요

생성 — 입고 — 요청 본문

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

배송 날짜와 시각입니다.

format: "date-time"
예제: "2026-01-01T00:00:00Z"
increases_stock불리언선택 사항

입고 수령 시 재고가 증가하는지 나타냅니다.

기본값: true
location_id문자열필수

창고 위치 식별자입니다.

제약 조건
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
예제: "example"
notes문자열선택 사항

추가 메모입니다.

maxLength: 2000
기본값: ""
quantity정수필수

단위 수량입니다.

minimum: 1maximum: 2147483647
예제: 1
reason문자열선택 사항

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

maxLength: 500
기본값: ""
status문자열필수

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

제약 조건
enum
["planned", "received"]
예제: "planned"
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"

추가 필드: 아니요

목록 조회 — 입고 — 응답

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

생성 시각입니다.

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

삭제 시각이 있는 경우 해당 값입니다.

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

배송 날짜와 시각입니다.

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

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

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

입고 수령 시 재고가 증가하는지 나타냅니다.

예제: true
location_id문자열필수

창고 위치 식별자입니다.

예제: "example"
quantity정수필수

단위 수량입니다.

예제: 1
received_at문자열 null필수

입고를 수령한 날짜와 시각입니다.

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

저장된 레코드 상태입니다.

제약 조건
enum
["active", "deleted"]
예제: "active"
status문자열필수

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

제약 조건
enum
["planned", "received"]
예제: "planned"
stock_applied_at문자열 null필수

입고의 재고 변경이 적용된 날짜와 시각입니다.

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

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

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

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

제약 조건
enum
["product", "variant"]
예제: "product"
updated_at문자열 null필수

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

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

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

예제: 1
warehouse_id문자열필수

창고 식별자입니다.

예제: "example"

추가 필드: 아니요

조회 — 입고 — 응답

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

생성 시각입니다.

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

삭제 시각이 있는 경우 해당 값입니다.

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

배송 날짜와 시각입니다.

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

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

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

입고 수령 시 재고가 증가하는지 나타냅니다.

예제: true
location_id문자열필수

창고 위치 식별자입니다.

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

추가 메모입니다.

예제: "example"
quantity정수필수

단위 수량입니다.

예제: 1
received_at문자열 null필수

입고를 수령한 날짜와 시각입니다.

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

저장된 레코드 상태입니다.

제약 조건
enum
["active", "deleted"]
예제: "active"
status문자열필수

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

제약 조건
enum
["planned", "received"]
예제: "planned"
stock_applied_at문자열 null필수

입고의 재고 변경이 적용된 날짜와 시각입니다.

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

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

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

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

제약 조건
enum
["product", "variant"]
예제: "product"
updated_at문자열 null필수

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

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

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

예제: 1
warehouse_id문자열필수

창고 식별자입니다.

예제: "example"

추가 필드: 아니요