쇼핑몰 설정

인증된 프로젝트의 쇼핑몰 설정 한 건을 조회하고 수정합니다. 경로에 ID 가 없습니다 — 키에 연결된 쇼핑몰의 설정을 다룹니다.

운영자용 API 라서 두 엔드포인트 모두 supervisor scope 로 검사합니다. 구매자 화면에 필요한 쇼핑몰 정보만 읽을 때는 상점을 씁니다.

설정 필드

조회 응답과 수정 요청은 같은 이름을 씁니다. 수정 가능 여부가 X 인 필드는 조회만 됩니다.

분류 필드 수정
기본 정보 name, description, status(1 운영, 0 중지), invoice_title, hosting_service O
사업자 정보 seller_name, seller_name_en, biz_email, biz_tel, biz_fax, registration_no, corp_reg_no, mail_order_sales_number, owner_name, zip, addr_1, addr_2, privacy_name, privacy_email O
결제 위젯 normal_widget_key, subscription_widget_key, payment_timeout(분) O
브랜딩 use_logo, logo, use_favicon, favicon, use_open_graph, og_image, use_signature, signature, use_mobile_bottom_nav O
고객센터 use_operation_time, customer_service_center_operation_time(요일별 객체), rest_start_hour, rest_start_minute, rest_end_hour, rest_end_minute, rest_day O
게시판·상담 use_notice, use_qna, use_faq, use_chat_support, chat_support_type, chat_support_key O (chat_support_key 는 아래 참고)
주문 use_non_member_order, orderer_collect_phone, orderer_collect_tel, orderer_collect_email, order_prefix, purchase_confirm_days O
주문 취소 use_order_cancel, use_oder_cancel_approval, order_cancel_reasons, order_cancel_reason_required_type, order_cancel_request_message, order_cancel_done_message O
배송 준비 전환 shipping_ready_transition_type, shipping_ready_delay_minutes O
연령 확인 use_age_accept_19, use_age_accept_14, use_age_accept_parent_name, use_age_accept_parent_birth, use_age_accept_parent_email O
회원가입 방식 use_general_membership, general_membership_duplication, general_membership_id_type, use_membership_duplication_email, use_membership_duplication_phone, use_certification, certification_type, use_social_membership, social_membership_type O
가입 수집 항목 use_membership_collect_phone, _tel, _email, _address, _bank, _birth, _gender, _interest, _customs, _nickname, _recommend_id, _business, _register(모두 use_membership_collect_ 로 시작), membership_collect_interest_number, recommend_id_point_to, recommend_id_point_from, membership_only_business O
회원 정보 노출 use_member_info_phone, _tel, _email, _address, _bank, _birth, _gender, _customs, _nickname, _register(모두 use_member_info_ 로 시작) O
법인 회원 use_corporate_department, sub_group_type, use_corporate_signup_approval, corporate_email_domains, use_corporate_auto_approve, use_corporate_invite_only O
적립금 use_point, use_point_transaction, point_display_name, point_min_balance, point_not_condition, point_condition, use_point_max_rate, point_max_rate, use_point_max_amount, point_max_amount, point_rate, point_calc_type1, point_calc_type2, use_point_advance_discount, point_advance_discount_rate, use_point_expire, point_expire_type, point_issue_event_type, point_issue_delay_days O
상품·리뷰·문의 use_open_market, use_product_approval, use_product_review, use_product_review_point, product_review_point, product_review_photo_point, use_product_review_answer, use_product_review_auto_answer, product_review_auto_answer_minute, product_review_auto_answer_text, use_product_qna, product_qna_member_auth, use_product_qna_answer_option O
휴면·탈퇴 use_dormant, dormant_year, dormant_restore, use_withdrawal, use_withdrawal_guide_message, use_withdrawal_guide_message_after, withdrawal_guide_message_after, use_withdrawal_auto, withdrawal_auto_year O
정기구독 use_subscription_aggregate_transaction, subscription_month_day, subscription_week_day O
구매 한도 use_limit, limit_month_purchase, limit_week_purchase, use_limit_payment, use_limit_message O
약관 terms_of_service, terms_of_privacy_policy, terms_of_privacy_collect, terms_of_privacy_third O
화면 product_sort_type, mall_theme_type, catalog_display_type, catalog_headline, catalog_bg_color, catalog_view_type_pc, catalog_view_type_mobile, catalog_product_sort_type, product_detail_accent_color, product_detail_radius_type, product_detail_font_scale_type O
장바구니·찜 use_cart, cart_storage_period, cart_max_limit, cart_add_action, cart_direct_purchase, cart_option_change, cart_discount_display, use_wishlist, wishlist_max_limit, cart_wishlist_display O
조회 전용 use_search_engine_indexing, use_sitemap, sitemap_targets, use_product_feed, product_feed_fields, robots_mode, robots_body, use_guest_login, social_login_key, withdrawal_guide_message, use_rejoin_restriction, rejoin_restriction_days, use_bank_transfer, bank_transfer_bank_name, bank_transfer_account_no, bank_transfer_account_holder, bank_transfer_deadline_days, bank_transfer_guide, use_home_best_section, use_home_new_section, use_related_products, use_recent_products, product_detail_theme_type X

응답에서 다음 값은 문자열로 나갑니다.

필드 값
catalog_display_type none(0), original(1), besnard(2), minimal(3)
catalog_view_type_pc, catalog_view_type_mobile list(1), grid(2), image(3), gallery(4)
catalog_product_sort_type position(0), created_at_desc(4), price(5), price_desc(6), sold_desc(10)

수정 요청에는 괄호 안의 숫자를 보냅니다.

GET /v1/mall-setting

쇼핑몰 설정 전체를 조회합니다.

인증

  • Authorization: Basic base64(clientKey:secretKey) 필수 — 인증
  • 필요한 scope: supervisor:mall_setting_detail
  • 회원 JWT(Bootpay-User-JWT): 필요 없음

요청

파라미터가 없습니다.

응답

200 OK — 래핑 없이 설정 필드를 바로 담은 객체입니다.

{
  "mall_setting_id": "66a0e1b2c3d4e5f600000010",
  "name": "부트커피",
  "status": 1,
  "normal_widget_key": "default-widget",
  "subscription_widget_key": "default-subscribe-widget",
  "registration_no": "1234567890",
  "use_cart": true,
  "cart_max_limit": 50,
  "catalog_display_type": "original",
  "catalog_product_sort_type": "position",
  "use_chat_support": true,
  "chat_support_key": { "plugin_key": "***MASKED***" },
  "social_login_key": { "kakao": "***MASKED***" },
  "created_at": "2026-01-10T10:00:00+09:00"
}json
필드 타입 설명
mall_setting_id string 쇼핑몰 설정 ID
created_at string 생성 시각
chat_support_key object 값을 ***MASKED*** 로 가립니다. 저장돼 있는지만 알 수 있습니다
social_login_key object 값을 ***MASKED*** 로 가립니다
그 밖 위 설정 필드​​의 모든 필드

오류

HTTP error_code 언제
404 MS_NOT_FOUND 이 프로젝트에 쇼핑몰 설정이 없음

공통 오류(인증·scope·방화벽)는 오류를 봅니다.

변경 이력

  • 2026-09-23 문서 최초 작성

PUT /v1/mall-setting

쇼핑몰 설정을 수정합니다. PATCH 도 같습니다.

인증

  • Authorization: Basic base64(clientKey:secretKey) 필수 — 인증
  • 필요한 scope: supervisor:mall_setting_update
  • 회원 JWT(Bootpay-User-JWT): 필요 없음

요청

본문은 래핑 없이 필드를 바로 보냅니다({"mall_setting": {...}} 형태가 아님).

{
  "name": "부트커피",
  "use_notice": true,
  "cart_max_limit": 30
}json
위치 이름 타입 필수 기본값 설명
body (설정 필드) 위 설정 필드 중 수정 O 인 필드
  • 보낸 필드만 바뀝니다. 보내지 않았거나 null 인 필드는 그대로이고, false·0·"" 는 그 값으로 저장됩니다.
  • 수정 X 인 필드는 보내도 무시합니다.
  • registration_no 는 10자리 사업자등록번호여야 합니다(하이픈 허용, 검증 숫자 확인).
  • customer_service_center_operation_time, chat_support_key 는 객체로 보냅니다.
  • chat_support_key 는 현재 이 API 로 바꿀 수 없습니다. 보내면 403 MS_PERMISSION_DENIED 이고 다른 필드도 저장되지 않습니다. 관리자 화면에서 바꾸세요.

응답

200 OK — 수정 후 설정 전체. 형태는 GET /v1/mall-setting 과 같습니다.

오류

HTTP error_code 언제
403 MS_PERMISSION_DENIED chat_support_key 를 보냄
404 MS_NOT_FOUND 이 프로젝트에 쇼핑몰 설정이 없음
442 MS_BUSINESS_NUMBER_INVALID registration_no 가 올바른 사업자등록번호가 아님
442 MS_INVALID 설정 값 검증 실패. message 에 이유가 담깁니다

변경 이력

  • 2026-09-23 문서 최초 작성

함께 보기