콘텐츠로 건너뛰기
ShopentlyLearn

데이터 스키마: 창고와 위치

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

데이터 스키마

목록 조회 · 위치 — 창고와 위치 — 응답

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

응답 예제 · ApiResponse_list_LocationData__.

예제: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"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"}

추가 필드: 아니요

목록 조회 — 창고와 위치 — 응답

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

응답 예제 · ApiResponse_list_WarehouseData__.

예제: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

조회 — 창고와 위치 — 응답

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

응답 예제 · WarehouseData.

예제: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

목록 조회 · 위치 — 창고와 위치 — 응답

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

안정적인 기계 판독용 코드입니다.

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

생성 시각입니다.

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

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

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

카테고리에 하위 카테고리가 없는지 나타냅니다.

예제: true
location_type문자열필수

창고 위치 유형입니다.

제약 조건
enum
["zone", "rack", "shelf", "bin"]
예제: "zone"
name문자열필수

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

예제: "Example"
parent_id문자열 null필수

상위 카테고리 식별자입니다.

예제: null
updated_at문자열필수

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

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

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

예제: 1
warehouse_id문자열필수

창고 식별자입니다.

예제: "example"

추가 필드: 아니요

창고 위치입니다

LocationQuantity · 스키마 · 데이터 스키마: 창고와 위치
location_id문자열필수

창고 위치 식별자입니다.

제약 조건
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
예제: "example"
on_hand정수필수

실제 재고 수량입니다.

minimum: 0maximum: 2147483647
예제: 1

추가 필드: 아니요

조회 — 창고와 위치 — 응답

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

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

예제: true
address_line문자열 null필수

주소 행입니다.

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

도시 또는 지역입니다.

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

안정적인 기계 판독용 코드입니다.

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

국가 코드입니다.

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

생성 시각입니다.

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

고객에게 표시되는 상태인지 나타냅니다.

예제: false
id문자열필수

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

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

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

예제: "Example"
postal_code문자열 null필수

우편번호입니다.

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

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

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

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

예제: 1

추가 필드: 아니요