참고

코드값

정해진 값만 받는 필드(판매 상태 · 배송비 방식 · 회원 상태 · 할증 종류 …)의 값을 모두 모았습니다.

업데이트됨 10.26 — 상품 일괄 정보수정 항목이 늘고, 할인 / 적립금이 둘로 나뉘었습니다

무엇인가요

정해진 값만 받는 필드의 값을 모두 모았습니다. 각 쪽 필드 표의 코드값 바로가기가 이 쪽을 새 창으로 엽니다. 이름은 쇼핑몰 관리자 화면에 보이는 이름과 같습니다. 표에 없는 값을 보내면 400 입니다.

구분	코드	필드
상품	판매 상태	`status_type`
상품	상품 상태	`sale_type`
상품	과세 구분	`tax_type`
상품	전시 상태	`display_status`
상품	열람 · 주문 권한	`view_permission · order_permission · access_permission`
상품	할인 · 적립 단위	`discount.*.unit · reward.unit`
상품	대량구매 할인 기준	`discount.bulk.rules[].basis`
상품	대량구매 할인 방식	`discount.bulk.rules[].apply_to`
상품	적립금 기준	`reward.basis`
상품	옵션 행 방식	`options[].option_type`
상품	옵션 고르는 방식	`option_info.pick_types[]`
상품	옵션 목록 열	`option_info.manage_fields[]`
상품	옵션을 만든 방식	`option_info.generation (응답)`
상품	추가 입력옵션 형식	`custom_options[].input_type`
상품	추가 입력옵션 받는 때	`custom_scope`
상품	배송 방식	`delivery[].method`
상품	묶음배송	`bundle_shipping`
상품	상품정보제공고시 방식	`product_info_provided_notice.mode`
상품	주문 수량을 세는 방식	`order_limit.basis`
상품	최대 수량을 세는 기간	`order_limit.max_check`
상품	검색 노출 설정	`seo.mode`
상품	배지 만드는 방식	`design(상품 배지)`
상품	배지 도형	`shape(상품 배지)`
상품 카테고리	상품 목록 모양	`list_type`
상품 카테고리	상품 목록 차례	`list_sort · sort(쇼핑몰 조회)`
템플릿 관리	공통정보 작성 방식	`mode(공통정보)`
템플릿 관리	배송비 방식	`fee_type`
템플릿 관리	배송비 결제	`pay_type`
템플릿 관리	상품 설치	`install.type(직접배송)`
템플릿 관리	요일	`quick.days · pickup.holidays`
템플릿 관리	리뷰 프로필 항목	`profile_fields(맞춤형 리뷰)`
배송 할증지역	할증지역 구분	`type`
배송 할증지역	할증 종류	`kind`
배송 할증지역	할증 범위	`scope`
회원	회원 상태	`status`
회원	가입 경로	`provider`
회원	적립금 내역 갈래	`kind(회원 적립금)`
쿠폰	쿠폰 상태	`status(쿠폰)`
쿠폰	쿠폰 종류	`coupon_type`
쿠폰	할인 방식	`discount_type(쿠폰)`
쿠폰	적용 카테고리	`category_mode`
쿠폰	쿠폰번호 방식	`serial_mode`
쿠폰	발급된 장의 상태	`status(쿠폰 이용 내역)`
목록 정렬	쿠폰 이용 내역 정렬 키	`sort(쿠폰 이용 내역)`
쿠폰	사용 기한 방식	`period_type`
쇼핑몰 정보	판매자 유형	`seller_type`
상품	일괄 처리 종류	`action(상품 수정 복수)`
상품	일괄 수정 항목	`field(상품 수정 복수) → patch 에 넣는 칸`
목록 정렬	정렬 방향	`order`
목록 정렬	상품 목록 정렬 키	`sort(상품 목록)`
목록 정렬	회원 목록 정렬 키	`sort(회원 목록)`
목록 정렬	템플릿 목록 정렬 키	`sort(템플릿 목록)`

상품 · 판매 상태

필드 status_type

값	이름	설명
`SALE`	판매중	보낼 수 있음. 재고가 0 이면 품절로 바뀌고, 다시 생기면 판매중으로 돌아옴
`SUSPENSION`	판매중지	보낼 수 있음. 판매자가 고른 값이라 재고를 채워도 그대로
`OUTOFSTOCK`	품절	응답에만 — 판매중 상품의 재고가 0 일 때 시스템이 정함
`WAIT`	판매대기	응답에만 — 옛 값. 보낼 수 없음
`CLOSE`	판매종료	응답에만 — 옛 값. 보낼 수 없음

상품 · 상품 상태

필드 sale_type

값	이름	설명
`NEW`	새 상품
`OLD`	중고

상품 · 과세 구분

필드 tax_type

값	이름	설명
`TAX`	과세
`DUTYFREE`	면세
`SMALL`	영세

상품 · 전시 상태

필드 display_status

값	이름	설명
`DISPLAY`	전시
`STOP`	전시중지
`PERIOD`	전시기간	display_start_at ~ display_end_at 사이에만 전시

상품 · 열람 · 주문 권한

필드 view_permission · order_permission · access_permission

값	이름	설명
`GUEST`	비회원 이상	누구나
`MEMBER`	일반회원 이상	회원만. *_level 로 최소 등급을 정함

상품 · 할인 · 적립 단위

필드 discount.*.unit · reward.unit

값	이름	설명
`WON`	원
`PERCENT`	%	0.01 ~ 99.99, 소수 둘째 자리까지

상품 · 대량구매 할인 기준

필드 discount.bulk.rules[].basis

값	이름	설명
`ORDER_QUANTITY`	주문 수량
`ORDER_AMOUNT`	주문 금액
`SALE_PRICE`	판매가

상품 · 대량구매 할인 방식

필드 discount.bulk.rules[].apply_to

값	이름	설명
`TOTAL`	합계에서 뺌
`EACH`	개당 뺌

상품 · 적립금 기준

필드 reward.basis

값	이름	설명
`SALE_PRICE`	판매가
`DISCOUNTED`	할인 뒤 값

상품 · 옵션 행 방식

필드 options[].option_type

값	이름	설명
`COMBINATION`	선택형	옵션명(option_info.names) 조합마다 한 행. API 로 넣는 옵션은 이것입니다
`CUSTOM`	추가 입력옵션	API 에서는 options 가 아니라 custom_options 로 넣습니다

상품 · 옵션 고르는 방식

필드 option_info.pick_types[]

값	이름	설명
`SELECT`	셀렉트 박스
`RADIO`	라디오 버튼
`TEXT_BUTTON`	텍스트 버튼
`TEMPLATE_COLOR`	템플릿 색상	색상 템플릿의 색 칩. 옵션 하나에만
`TEMPLATE_SIZE`	템플릿 사이즈	사이즈 템플릿의 사이즈. 옵션 하나에만

상품 · 옵션 목록 열

필드 option_info.manage_fields[]

값	이름	설명
`number`	번호
`price`	옵션가
`costPrice`	원가
`stockQuantity`	재고수량
`managerCode`	관리코드
`image`	옵션 이미지
`usable`	노출여부

상품 · 옵션을 만든 방식

필드 option_info.generation (응답)

값	이름	설명
`DIRECT`	직접 입력
`TEMPLATE_COLOR_SIZE`	템플릿 선택 (색상/사이즈)
`TEMPLATE_COLOR`	템플릿 선택 (색상)
`TEMPLATE_SIZE`	템플릿 선택 (사이즈)

상품 · 추가 입력옵션 형식

필드 custom_options[].input_type

값	이름	설명
`TEXT`	텍스트폼
`SELECT`	셀렉트 박스	values 에서 고름
`FILE`	첨부파일

상품 · 추가 입력옵션 받는 때

필드 custom_scope

값	이름	설명
`ONCE`	주문 시 한번
`EACH`	옵션별 각각

상품 · 배송 방식

필드 delivery[].method

값	이름	설명
`PARCEL`	택배배송
`DIRECT`	직접배송
`QUICK`	퀵배송
`PICKUP`	방문수령
`NONE`	미배송	다른 방식과 함께 쓸 수 없고 템플릿이 없음

상품 · 묶음배송

필드 bundle_shipping

값	이름	설명
`POSSIBLE`	가능
`PARTIAL`	부분가능
`IMPOSSIBLE`	불가

상품 · 상품정보제공고시 방식

필드 product_info_provided_notice.mode

값	이름	설명
`FORM`	서식	서식 코드의 항목을 fields 에 채움
`IMAGE`	이미지	image 한 장

상품 · 주문 수량을 세는 방식

필드 order_limit.basis

값	이름	설명
`EACH`	옵션별 개별 수량
`TOTAL`	옵션별 합산 수량

상품 · 최대 수량을 세는 기간

필드 order_limit.max_check

값	이름	설명
`ORDER`	주문 건당
`DAY`	주문 당일
`DAYS_3`	지난 3일
`DAYS_7`	지난 7일
`DAYS_30`	지난 30일

상품 · 검색 노출 설정

필드 seo.mode

값	이름	설명
`AUTO`	자동	쇼핑몰 기본값을 씀
`MANUAL`	직접 입력	page_title · meta_description · target_keywords 를 씀

상품 · 배지 만드는 방식

필드 design(상품 배지)

값	이름	설명
`SIMPLE`	간편제작	name · shape · 색으로 그림
`IMAGE`	이미지 첨부	image 한 장

상품 · 배지 도형

필드 shape(상품 배지)

값	이름	설명
`TYPE1`	살짝 둥근 사각
`TYPE2`	알약
`TYPE3`	왼쪽 위 · 오른쪽 아래만 둥근 사각
`TYPE4`	말풍선(꼬리 아래 가운데)
`TYPE5`	알약 말풍선(꼬리 아래 왼쪽)
`TYPE6`	리본

상품 · 일괄 처리 종류

필드 action(상품 수정 복수)

값	이름	설명
`update`	정보수정	field 항목 하나를 patch 값으로 모두 덮어씀
`display`	전시변경	value true 전시(기간이 걸려 있으면 기간 전시) · false 전시중지
`sale`	판매변경	value true 판매중(재고 0 이면 품절) · false 판매중지
`delete`	삭제	되돌릴 수 없음

상품 · 일괄 수정 항목

필드 field(상품 수정 복수) → patch 에 넣는 칸

값	이름	설명
`image`	이미지	images — 목록 전체를 덮어씀. 파일은 상품마다 복사해 붙임
`video`	동영상	video_url
`product-category`	상품 카테고리	category_id · display_category_ids
`name`	상품명	name
`promotion-text`	간략소개	promotion_text
`product-stock`	재고수량	stock_quantity · stock_unlimited — 옵션이 있는 상품은 실패(OptionProduct)
`sale-price`	판매가	sale_price
`list-price`	정가 (할인 전 판매가)	list_price
`cost-price`	원가 (내부 관리용)	cost_price — 옵션이 있는 상품은 실패(OptionProduct)
`tax-type`	과세유형	tax_type
`discount`	할인 설정	discount
`reward`	적립금 설정	reward
`option-select`	주문옵션	option_info · options (+ stock_unlimited · color_ids · size_template_id · sizes) — 옵션 없는 상품에만 붙임, 이미 옵션이 있으면 실패(OptionProduct). 둘 다 비우면 옵션을 모두 지움(아래 주문옵션 참고)
`option-extra`	추가상품	extra_options
`option-custom`	주문 요청사항	custom_options · custom_scope
`delivery-PARCEL`	택배배송	delivery — 그 방식 한 줄만 바꿔 끼움(아래 배송 참고)
`delivery-DIRECT`	직접배송	delivery
`delivery-QUICK`	퀵배송	delivery
`delivery-PICKUP`	방문수령	delivery
`bundle-shipping`	묶음배송	bundle_shipping — 대량구매 할인을 켠 상품은 POSSIBLE 이 PARTIAL 로 저장됨
`detail`	상세설명	detail_content_body — 본문 전체를 덮어씀. 본문 그림은 상품마다 복사해 주소를 바꿈
`notice`	상품정보제공고시	product_info_provided_notice — 서식(FORM)만
`template-top`	상세설명 상단	top_template_ids
`template-bottom`	상세설명 하단	bottom_template_ids
`display-status`	전시상태	display_status · display_start_at · display_end_at
`display-order`	전시순서	display_order
`product-badge`	배지	badge_ids
`icon`	아이콘	icon_id
`color`	색상	color_ids — 옵션이 있는 상품은 실패(OptionProduct)
`size`	사이즈	size_template_id · sizes — 옵션이 있는 상품은 실패(OptionProduct)
`view-permission`	열람권한	view_permission · view_level
`sale-status`	판매상태	status_type · sale_start_at · sale_end_at
`benefit`	구매 제한	benefit_limit · adult_only
`order-limit`	주문수량 제한	order_limit
`restock-alert`	재입고 알림 제외	restock_alert_excluded
`clearance-code`	통관고유부호 수집	collect_clearance_code
`order-permission`	주문권한	order_permission · order_level
`brand`	브랜드	brand
`supplier`	상품 공급자	supplier
`custom-review`	맞춤형 리뷰	review_template_id
`management-code`	관리코드	management_code — 옵션이 있는 상품은 실패(OptionProduct)
`search-keywords`	검색 키워드	search_keywords
`seo`	검색엔진 최적화(SEO)	seo

상품 카테고리 · 상품 목록 모양

필드 list_type

값	이름	설명
`CARD`	카드형
`LIST`	리스트형
`GALLERY`	갤러리형	그림만 촘촘히

상품 카테고리 · 상품 목록 차례

필드 list_sort · sort(쇼핑몰 조회)

값	이름	설명
`DISPLAY`	기본 전시순
`CREATED`	최신 등록순
`PRICE_LOW`	낮은 가격순
`PRICE_HIGH`	높은 가격순
`DISCOUNT`	할인율순
`SALES`	판매량순
`REVIEW`	리뷰 많은순
`RATING`	평점 높은순

템플릿 관리 · 공통정보 작성 방식

필드 mode(공통정보)

값	이름	설명
`EDITOR`	본문 편집	editor_content 필수
`IMAGE`	이미지	image.file_id 필수

템플릿 관리 · 배송비 방식

필드 fee_type

값	이름	설명
`FREE`	무료
`CONDITIONAL_FREE`	조건부 무료	free_condition_amount 이상이면 무료
`PAID`	유료
`UNIT_QUANTITY_PAID`	수량별	unit_quantity 개마다 base_fee — 택배배송만
`RANGE_QUANTITY_PAID`	구간별	range_tiers — 택배배송만

템플릿 관리 · 배송비 결제

필드 pay_type

값	이름	설명
`PREPAID`	선결제
`COLLECT`	착불
`PREPAID_OR_COLLECT`	선결제 또는 착불	손님이 고름 — 택배배송만

템플릿 관리 · 상품 설치

필드 install.type(직접배송)

값	이름	설명
`FREE`	무료 설치
`PAID`	유료 설치
`SELF`	자가 설치 (단순 배송)

템플릿 관리 · 요일

필드 quick.days · pickup.holidays

값	이름	설명
`MON`	월
`TUE`	화
`WED`	수
`THU`	목
`FRI`	금
`SAT`	토
`SUN`	일
`HOLIDAY`	법정 공휴일

템플릿 관리 · 리뷰 프로필 항목

필드 profile_fields(맞춤형 리뷰)

값	이름	설명
`USUAL_SIZE`	평소 사이즈
`HEIGHT`	키
`WEIGHT`	몸무게
`FOOT_SIZE`	발 크기
`CHILD_HEIGHT`	아이 키
`CHILD_WEIGHT`	아이 몸무게
`CHILD_FOOT_SIZE`	아이 발 크기

배송 할증지역 · 할증지역 구분

필드 type

값	이름	설명
`INCLUDE`	추가	이 쇼핑몰이 더한 지역
`EXCLUDE`	제외	기본 할증지역에서 이 쇼핑몰만 뺀 지역

배송 할증지역 · 할증 종류

필드 kind

값	이름	설명
`JEJU`	제주	배송 템플릿의 extra_fee.jeju
`ISLAND`	도서산간	배송 템플릿의 extra_fee.island

배송 할증지역 · 할증 범위

필드 scope

값	이름	설명
(빈 글자)	도로	빈 글자 — road_code 의 도로(buld_mnnm 이 있으면 그 건물 번호만)
`LI`	리 전체
`EMD`	읍면동 전체

회원 · 회원 상태

필드 status

값	이름	설명
`ACTIVE`	정상
`SUSPENDED`	정지	그 회원의 로그인 · 회원 토큰이 막힘
`LEAVE`	탈퇴	목록에 나오지 않고 API 로 바꿀 수 없음

회원 · 가입 경로

필드 provider

값	이름	설명
`LOCAL`	일반회원	아이디 · 비밀번호로 가입
`그 밖의 값`	소셜 로그인	그 소셜 로그인 수단의 이름(대문자). login_id 가 null 일 수 있음

회원 · 적립금 내역 갈래

필드 kind(회원 적립금)

값	이름	설명
`MANUAL_EARN`	지급	보낼 수 있음 — 관리자 · 앱이 손으로 줌
`MANUAL_DEDUCT`	차감	보낼 수 있음 — 관리자 · 앱이 손으로 뺌
`ORDER_EARN`	주문적립	응답에만
`ORDER_USE`	주문사용	응답에만
`ORDER_CANCEL`	주문취소	응답에만 — 주문 취소로 되돌림
`EXPIRE`	소멸	응답에만 — 유효기간이 지남

쿠폰 · 쿠폰 상태

필드 status(쿠폰)

값	이름	설명
`active`	사용
`stop`	중지	등록 주소로 받을 수 없음. 이미 받은 장은 그대로

쿠폰 · 쿠폰 종류

필드 coupon_type

값	이름	설명
`PRODUCT`	상품 할인	상품 하나의 판매가에서 깎음
`ORDER`	주문 할인	주문한 상품 합계에서 깎음
`DELIVERY`	배송비 할인	배송비에서 깎음. 금액 할인만

쿠폰 · 할인 방식

필드 discount_type(쿠폰)

값	이름	설명
`AMOUNT`	금액 할인	discount_value 원
`PERCENT`	퍼센트 할인	discount_value 1~99 %, max_discount 필수

쿠폰 · 적용 카테고리

필드 category_mode

값	이름	설명
`OFF`	설정안함	모든 상품에 씀
`ON`	설정	category_ids 의 카테고리와 그 하위 전체의 상품에만 씀

쿠폰 · 쿠폰번호 방식

필드 serial_mode

값	이름	설명
`OFF`	설정안함	번호 없이 받음
`SAME`	동일번호 발급	모두가 serial 하나를 적어 받음
`UNIQUE`	다른번호 발급	번호를 여럿 만들어 한 번호를 한 사람만 — 카카오톡 채널 온라인 쿠폰

쿠폰 · 발급된 장의 상태

필드 status(쿠폰 이용 내역)

값	이름	설명
`HOLD`	보유	받았고 아직 쓰지 않음
`USED`	사용	주문에 씀
`EXPIRED`	만료	기한이 지난 보유. 읽는 시각으로 가름

쿠폰 · 사용 기한 방식

필드 period_type

값	이름	설명
`DAYS`	발급일 기준	받은 날부터 period_days 일
`FIXED`	기간 지정	start_at ~ end_at

목록 정렬 · 쿠폰 이용 내역 정렬 키

필드 sort(쿠폰 이용 내역)

값	이름	설명
`issued_at`	발급 시각	기본 — 내림차순이면 최근 발급순
`expire_at`	만료 시각
`used_at`	사용 시각	쓰지 않은 장은 비어 있어 내림차순이면 뒤로 감

목록 정렬 · 정렬 방향

필드 order

값	이름	설명
`desc`	내림차순	큰 값 · 최근 시각부터. 시각 · 금액 · 번호 키의 기본
`asc`	오름차순	작은 값 · 가나다순부터. 템플릿 name · sort_order 의 기본

목록 정렬 · 상품 목록 정렬 키

필드 sort(상품 목록)

값	이름	설명
`product_no`	상품 번호	기본 — 내림차순이면 최신 등록순
`name`	상품명
`sale_price`	판매가
`stock_quantity`	재고
`display_order`	전시순서
`created`	등록일시
`updated`	수정일시	바뀐 상품부터 가져갈 때
`discount_rate`	할인율
`sales_count`	판매량
`review_count`	리뷰 수
`review_score`	평점

목록 정렬 · 회원 목록 정렬 키

필드 sort(회원 목록)

값	이름	설명
`member_no`	회원 번호	기본 — 내림차순이면 최신 가입순
`name`	이름
`login_id`	아이디
`status`	회원 상태
`created`	가입일시
`login_at`	최근 로그인
`active_at`	최근 활동

목록 정렬 · 템플릿 목록 정렬 키

필드 sort(템플릿 목록)

값	이름	설명
`name`	템플릿명	order 를 빼면 오름차순
`created`	등록일시	기본(색상 제외) — 최신순
`updated`	수정일시
`sort_order`	노출순서	색상 목록에서만. 색상의 기본(노출순서 → 이름순)

쇼핑몰 정보 · 판매자 유형

필드 seller_type

값	이름	설명
`INDIVIDUAL`	개인사업자
`CORPORATE`	법인사업자
`SIMPLE`	간이사업자
`PERSONAL`	개인판매자	사업자등록번호 · 통신판매업 신고번호 · 업태 · 종목이 비워짐

무엇인가요#

상품 · 판매 상태#

상품 · 상품 상태#

상품 · 과세 구분#

상품 · 전시 상태#

상품 · 열람 · 주문 권한#

상품 · 할인 · 적립 단위#

상품 · 대량구매 할인 기준#

상품 · 대량구매 할인 방식#

상품 · 적립금 기준#

상품 · 옵션 행 방식#

상품 · 옵션 고르는 방식#

상품 · 옵션 목록 열#

상품 · 옵션을 만든 방식#

상품 · 추가 입력옵션 형식#

상품 · 추가 입력옵션 받는 때#

상품 · 배송 방식#

상품 · 묶음배송#

상품 · 상품정보제공고시 방식#

상품 · 주문 수량을 세는 방식#

상품 · 최대 수량을 세는 기간#

상품 · 검색 노출 설정#

상품 · 배지 만드는 방식#

상품 · 배지 도형#

상품 · 일괄 처리 종류#

상품 · 일괄 수정 항목#

상품 카테고리 · 상품 목록 모양#

상품 카테고리 · 상품 목록 차례#

템플릿 관리 · 공통정보 작성 방식#

템플릿 관리 · 배송비 방식#

템플릿 관리 · 배송비 결제#

템플릿 관리 · 상품 설치#

템플릿 관리 · 요일#

템플릿 관리 · 리뷰 프로필 항목#

배송 할증지역 · 할증지역 구분#

배송 할증지역 · 할증 종류#

배송 할증지역 · 할증 범위#

회원 · 회원 상태#

회원 · 가입 경로#

회원 · 적립금 내역 갈래#

쿠폰 · 쿠폰 상태#

쿠폰 · 쿠폰 종류#

쿠폰 · 할인 방식#

쿠폰 · 적용 카테고리#

쿠폰 · 쿠폰번호 방식#

쿠폰 · 발급된 장의 상태#

쿠폰 · 사용 기한 방식#

목록 정렬 · 쿠폰 이용 내역 정렬 키#

목록 정렬 · 정렬 방향#

목록 정렬 · 상품 목록 정렬 키#

목록 정렬 · 회원 목록 정렬 키#

목록 정렬 · 템플릿 목록 정렬 키#

쇼핑몰 정보 · 판매자 유형#